src/jalview/appletgui/AlignViewport.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.appletgui;
  22
  23 import jalview.analysis.NJTree;
  24 import jalview.api.AlignViewportI;
  25 import jalview.api.FeatureSettingsModelI;
  26 import jalview.bin.JalviewLite;
  27 import jalview.commands.CommandI;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.ColumnSelection;
  30 import jalview.datamodel.SearchResults;
  31 import jalview.datamodel.Sequence;
  32 import jalview.datamodel.SequenceGroup;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.schemes.ColourSchemeProperty;
  35 import jalview.schemes.UserColourScheme;
  36 import jalview.structure.CommandListener;
  37 import jalview.structure.SelectionSource;
  38 import jalview.structure.StructureSelectionManager;
  39 import jalview.structure.VamsasSource;
  40 import jalview.viewmodel.AlignmentViewport;
  41
  42 import java.awt.Font;
  43
  44 public class AlignViewport extends AlignmentViewport implements
  45         SelectionSource, VamsasSource, CommandListener
  46 {
  47   boolean cursorMode = false;
  48
  49   Font font = new Font("SansSerif", Font.PLAIN, 10);
  50
  51   boolean validCharWidth = true;
  52
  53   NJTree currentTree = null;
  54
  55   public jalview.bin.JalviewLite applet;
  56
  57   boolean MAC = false;
  58
  59   private AnnotationColumnChooser annotationColumnSelectionState;
  60
  61   @Override
  62   public void finalize()
  63   {
  64     applet = null;
  65     quality = null;
  66     alignment = null;
  67     colSel = null;
  68   }
  69
  70   public AlignViewport(AlignmentI al, JalviewLite applet)
  71   {
  72     super();
  73     calculator = new jalview.workers.AlignCalcManager();
  74     this.applet = applet;
  75     alignment = al;
  76     // we always pad gaps
  77     this.setPadGaps(true);
  78     this.startRes = 0;
  79     this.endRes = al.getWidth() - 1;
  80     this.startSeq = 0;
  81     this.endSeq = al.getHeight() - 1;
  82     if (applet != null)
  83     {
  84       // get the width and height scaling factors if they were specified
  85       String param = applet.getParameter("widthScale");
  86       if (param != null)
  87       {
  88         try
  89         {
  90           widthScale = new Float(param).floatValue();
  91         } catch (Exception e)
  92         {
  93         }
  94         if (widthScale <= 1.0)
  95         {
  96           System.err
  97                   .println("Invalid alignment character width scaling factor ("
  98                           + widthScale + "). Ignoring.");
  99           widthScale = 1;
 100         }
 101         if (JalviewLite.debug)
 102         {
 103           System.err
 104                   .println("Alignment character width scaling factor is now "
 105                           + widthScale);
 106         }
 107       }
 108       param = applet.getParameter("heightScale");
 109       if (param != null)
 110       {
 111         try
 112         {
 113           heightScale = new Float(param).floatValue();
 114         } catch (Exception e)
 115         {
 116         }
 117         if (heightScale <= 1.0)
 118         {
 119           System.err
 120                   .println("Invalid alignment character height scaling factor ("
 121                           + heightScale + "). Ignoring.");
 122           heightScale = 1;
 123         }
 124         if (JalviewLite.debug)
 125         {
 126           System.err
 127                   .println("Alignment character height scaling factor is now "
 128                           + heightScale);
 129         }
 130       }
 131     }
 132     setFont(font);
 133
 134     MAC = new jalview.util.Platform().isAMac();
 135
 136     if (applet != null)
 137     {
 138       setShowJVSuffix(applet.getDefaultParameter("showFullId",
 139               getShowJVSuffix()));
 140
 141       setShowAnnotation(applet.getDefaultParameter("showAnnotation",
 142               isShowAnnotation()));
 143
 144       showConservation = applet.getDefaultParameter("showConservation",
 145               showConservation);
 146
 147       showQuality = applet.getDefaultParameter("showQuality", showQuality);
 148
 149       showConsensus = applet.getDefaultParameter("showConsensus",
 150               showConsensus);
 151
 152       setShowUnconserved(applet.getDefaultParameter("showUnconserved",
 153               getShowUnconserved()));
 154
 155       setScaleProteinAsCdna(applet.getDefaultParameter(
 156               "scaleProteinAsCdna", isScaleProteinAsCdna()));
 157
 158       String param = applet.getParameter("upperCase");
 159       if (param != null)
 160       {
 161         if (param.equalsIgnoreCase("bold"))
 162         {
 163           setUpperCasebold(true);
 164         }
 165       }
 166       sortByTree = applet.getDefaultParameter("sortByTree", sortByTree);
 167
 168       setFollowHighlight(applet.getDefaultParameter("automaticScrolling",
 169               isFollowHighlight()));
 170       followSelection = isFollowHighlight();
 171
 172       showSequenceLogo = applet.getDefaultParameter("showSequenceLogo",
 173               showSequenceLogo);
 174
 175       normaliseSequenceLogo = applet.getDefaultParameter(
 176               "normaliseSequenceLogo", applet.getDefaultParameter(
 177                       "normaliseLogo", normaliseSequenceLogo));
 178
 179       showGroupConsensus = applet.getDefaultParameter("showGroupConsensus",
 180               showGroupConsensus);
 181
 182       showGroupConservation = applet.getDefaultParameter(
 183               "showGroupConservation", showGroupConservation);
 184
 185       showConsensusHistogram = applet.getDefaultParameter(
 186               "showConsensusHistogram", showConsensusHistogram);
 187
 188     }
 189
 190     if (applet != null)
 191     {
 192       String colour = al.isNucleotide() ? applet
 193               .getParameter("defaultColourNuc") : applet
 194               .getParameter("defaultColourProt");
 195       if (colour == null)
 196       {
 197         colour = applet.getParameter("defaultColour");
 198       }
 199       if (colour == null)
 200       {
 201         colour = applet.getParameter("userDefinedColour");
 202         if (colour != null)
 203         {
 204           colour = "User Defined";
 205         }
 206       }
 207
 208       if (colour != null)
 209       {
 210         globalColourScheme = ColourSchemeProperty.getColour(alignment,
 211                 colour);
 212         if (globalColourScheme != null)
 213         {
 214           globalColourScheme.setConsensus(hconsensus);
 215         }
 216       }
 217
 218       if (applet.getParameter("userDefinedColour") != null)
 219       {
 220         ((UserColourScheme) globalColourScheme).parseAppletParameter(applet
 221                 .getParameter("userDefinedColour"));
 222       }
 223     }
 224     initAutoAnnotation();
 225
 226   }
 227
 228   /**
 229    * get the consensus sequence as displayed under the PID consensus annotation
 230    * row.
 231    *
 232    * @return consensus sequence as a new sequence object
 233    */
 234   public SequenceI getConsensusSeq()
 235   {
 236     if (consensus == null)
 237     {
 238       updateConsensus(null);
 239     }
 240     if (consensus == null)
 241     {
 242       return null;
 243     }
 244     StringBuilder seqs = new StringBuilder(consensus.annotations.length);
 245     for (int i = 0; i < consensus.annotations.length; i++)
 246     {
 247       if (consensus.annotations[i] != null)
 248       {
 249         if (consensus.annotations[i].description.charAt(0) == '[')
 250         {
 251           seqs.append(consensus.annotations[i].description.charAt(1));
 252         }
 253         else
 254         {
 255           seqs.append(consensus.annotations[i].displayCharacter);
 256         }
 257       }
 258     }
 259     SequenceI sq = new Sequence("Consensus", seqs.toString());
 260     sq.setDescription("Percentage Identity Consensus "
 261             + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
 262     return sq;
 263   }
 264
 265   java.awt.Frame nullFrame;
 266
 267   protected FeatureSettings featureSettings = null;
 268
 269   private float heightScale = 1, widthScale = 1;
 270
 271   public void setFont(Font f)
 272   {
 273     font = f;
 274     if (nullFrame == null)
 275     {
 276       nullFrame = new java.awt.Frame();
 277       nullFrame.addNotify();
 278     }
 279
 280     java.awt.FontMetrics fm = nullFrame.getGraphics().getFontMetrics(font);
 281     setCharHeight((int) (heightScale * fm.getHeight()));
 282     setCharWidth((int) (widthScale * fm.charWidth('M')));
 283
 284     if (isUpperCasebold())
 285     {
 286       Font f2 = new Font(f.getName(), Font.BOLD, f.getSize());
 287       fm = nullFrame.getGraphics().getFontMetrics(f2);
 288       setCharWidth((int) (widthScale * (fm.stringWidth("MMMMMMMMMMM") / 10)));
 289     }
 290   }
 291
 292   public Font getFont()
 293   {
 294     return font;
 295   }
 296
 297   public void resetSeqLimits(int height)
 298   {
 299     setEndSeq(height / getCharHeight());
 300   }
 301
 302   public void setCurrentTree(NJTree tree)
 303   {
 304     currentTree = tree;
 305   }
 306
 307   public NJTree getCurrentTree()
 308   {
 309     return currentTree;
 310   }
 311
 312   boolean centreColumnLabels;
 313
 314   public boolean getCentreColumnLabels()
 315   {
 316     return centreColumnLabels;
 317   }
 318
 319   public boolean followSelection = true;
 320
 321   /**
 322    * @return true if view selection should always follow the selections
 323    *         broadcast by other selection sources
 324    */
 325   public boolean getFollowSelection()
 326   {
 327     return followSelection;
 328   }
 329
 330   @Override
 331   public void sendSelection()
 332   {
 333     getStructureSelectionManager().sendSelection(
 334             new SequenceGroup(getSelectionGroup()),
 335             new ColumnSelection(getColumnSelection()), this);
 336   }
 337
 338   /**
 339    * Returns an instance of the StructureSelectionManager scoped to this applet
 340    * instance.
 341    *
 342    * @return
 343    */
 344   @Override
 345   public StructureSelectionManager getStructureSelectionManager()
 346   {
 347     return jalview.structure.StructureSelectionManager
 348             .getStructureSelectionManager(applet);
 349   }
 350
 351   @Override
 352   public boolean isNormaliseSequenceLogo()
 353   {
 354     return normaliseSequenceLogo;
 355   }
 356
 357   public void setNormaliseSequenceLogo(boolean state)
 358   {
 359     normaliseSequenceLogo = state;
 360   }
 361
 362   /**
 363    *
 364    * @return true if alignment characters should be displayed
 365    */
 366   @Override
 367   public boolean isValidCharWidth()
 368   {
 369     return validCharWidth;
 370   }
 371
 372   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 373   {
 374     return annotationColumnSelectionState;
 375   }
 376
 377   public void setAnnotationColumnSelectionState(
 378           AnnotationColumnChooser annotationColumnSelectionState)
 379   {
 380     this.annotationColumnSelectionState = annotationColumnSelectionState;
 381   }
 382
 383   @Override
 384   public void mirrorCommand(CommandI command, boolean undo,
 385           StructureSelectionManager ssm, VamsasSource source)
 386   {
 387     // TODO refactor so this can be pulled up to superclass or controller
 388     /*
 389      * Do nothing unless we are a 'complement' of the source. May replace this
 390      * with direct calls not via SSM.
 391      */
 392     if (source instanceof AlignViewportI
 393             && ((AlignViewportI) source).getCodingComplement() == this)
 394     {
 395       // ok to continue;
 396     }
 397     else
 398     {
 399       return;
 400     }
 401
 402     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 403             getGapCharacter());
 404     if (mappedCommand != null)
 405     {
 406       mappedCommand.doCommand(null);
 407       firePropertyChange("alignment", null, getAlignment().getSequences());
 408
 409       // ap.scalePanelHolder.repaint();
 410       // ap.repaint();
 411     }
 412   }
 413
 414   @Override
 415   public VamsasSource getVamsasSource()
 416   {
 417     return this;
 418   }
 419
 420   /**
 421    * If this viewport has a (Protein/cDNA) complement, then scroll the
 422    * complementary alignment to match this one.
 423    */
 424   public void scrollComplementaryAlignment(AlignmentPanel complementPanel)
 425   {
 426     if (complementPanel == null)
 427     {
 428       return;
 429     }
 430
 431     /*
 432      * Populate a SearchResults object with the mapped location to scroll to. If
 433      * there is no complement, or it is not following highlights, or no mapping
 434      * is found, the result will be empty.
 435      */
 436     SearchResults sr = new SearchResults();
 437     int seqOffset = findComplementScrollTarget(sr);
 438     if (!sr.isEmpty())
 439     {
 440       complementPanel.setFollowingComplementScroll(true);
 441       complementPanel.scrollToCentre(sr, seqOffset);
 442     }
 443   }
 444
 445   /**
 446    * Applies the supplied feature settings descriptor to currently known
 447    * features. This supports an 'initial configuration' of feature colouring
 448    * based on a preset or user favourite. This may then be modified in the usual
 449    * way using the Feature Settings dialogue.
 450    *
 451    * @param featureSettings
 452    */
 453   @Override
 454   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
 455   {
 456     // TODO implement for applet
 457   }
 458
 459 }