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.TreeModel;
  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.HiddenColumns;
  31 import jalview.datamodel.SearchResults;
  32 import jalview.datamodel.SearchResultsI;
  33 import jalview.datamodel.Sequence;
  34 import jalview.datamodel.SequenceGroup;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.renderer.ResidueShader;
  37 import jalview.schemes.ColourSchemeProperty;
  38 import jalview.schemes.UserColourScheme;
  39 import jalview.structure.SelectionSource;
  40 import jalview.structure.StructureSelectionManager;
  41 import jalview.structure.VamsasSource;
  42 import jalview.viewmodel.AlignmentViewport;
  43
  44 import java.awt.Font;
  45 import java.awt.FontMetrics;
  46
  47 public class AlignViewport extends AlignmentViewport implements
  48         SelectionSource
  49 {
  50   boolean cursorMode = false;
  51
  52   Font font = new Font("SansSerif", Font.PLAIN, 10);
  53
  54   boolean validCharWidth = true;
  55
  56   TreeModel currentTree = null;
  57
  58   public jalview.bin.JalviewLite applet;
  59
  60   boolean MAC = false;
  61
  62   private AnnotationColumnChooser annotationColumnSelectionState;
  63
  64   @Override
  65   public void finalize()
  66   {
  67     applet = null;
  68     quality = null;
  69     alignment = null;
  70     colSel = null;
  71   }
  72
  73   public AlignViewport(AlignmentI al, JalviewLite applet)
  74   {
  75     super(al);
  76     calculator = new jalview.workers.AlignCalcManager();
  77     this.applet = applet;
  78
  79     // we always pad gaps
  80     this.setPadGaps(true);
  81
  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, true);
 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       showOccupancy = applet.getDefaultParameter("showOccupancy",
 153               showOccupancy);
 154
 155       setShowUnconserved(applet.getDefaultParameter("showUnconserved",
 156               getShowUnconserved()));
 157
 158       setScaleProteinAsCdna(applet.getDefaultParameter(
 159               "scaleProteinAsCdna", isScaleProteinAsCdna()));
 160
 161       String param = applet.getParameter("upperCase");
 162       if (param != null)
 163       {
 164         if (param.equalsIgnoreCase("bold"))
 165         {
 166           setUpperCasebold(true);
 167         }
 168       }
 169       sortByTree = applet.getDefaultParameter("sortByTree", sortByTree);
 170
 171       setFollowHighlight(applet.getDefaultParameter("automaticScrolling",
 172               isFollowHighlight()));
 173       followSelection = isFollowHighlight();
 174
 175       showSequenceLogo = applet.getDefaultParameter("showSequenceLogo",
 176               showSequenceLogo);
 177
 178       normaliseSequenceLogo = applet.getDefaultParameter(
 179               "normaliseSequenceLogo", applet.getDefaultParameter(
 180                       "normaliseLogo", normaliseSequenceLogo));
 181
 182       showGroupConsensus = applet.getDefaultParameter("showGroupConsensus",
 183               showGroupConsensus);
 184
 185       showGroupConservation = applet.getDefaultParameter(
 186               "showGroupConservation", showGroupConservation);
 187
 188       showConsensusHistogram = applet.getDefaultParameter(
 189               "showConsensusHistogram", showConsensusHistogram);
 190
 191     }
 192
 193     if (applet != null)
 194     {
 195       String colour = al.isNucleotide() ? applet
 196               .getParameter("defaultColourNuc") : applet
 197               .getParameter("defaultColourProt");
 198       if (colour == null)
 199       {
 200         colour = applet.getParameter("defaultColour");
 201       }
 202       if (colour == null)
 203       {
 204         colour = applet.getParameter("userDefinedColour");
 205         if (colour != null)
 206         {
 207           colour = "User Defined";
 208         }
 209       }
 210
 211       if (colour != null)
 212       {
 213         residueShading = new ResidueShader(
 214                 ColourSchemeProperty.getColourScheme(alignment, colour));
 215         if (residueShading != null)
 216         {
 217           residueShading.setConsensus(hconsensus);
 218         }
 219       }
 220
 221       if (applet.getParameter("userDefinedColour") != null)
 222       {
 223         residueShading = new ResidueShader(
 224                 new UserColourScheme(
 225                         applet.getParameter("userDefinedColour")));
 226       }
 227     }
 228     initAutoAnnotation();
 229
 230   }
 231
 232   /**
 233    * get the consensus sequence as displayed under the PID consensus annotation
 234    * row.
 235    *
 236    * @return consensus sequence as a new sequence object
 237    */
 238   public SequenceI getConsensusSeq()
 239   {
 240     if (consensus == null)
 241     {
 242       updateConsensus(null);
 243     }
 244     if (consensus == null)
 245     {
 246       return null;
 247     }
 248     StringBuilder seqs = new StringBuilder(consensus.annotations.length);
 249     for (int i = 0; i < consensus.annotations.length; i++)
 250     {
 251       if (consensus.annotations[i] != null)
 252       {
 253         if (consensus.annotations[i].description.charAt(0) == '[')
 254         {
 255           seqs.append(consensus.annotations[i].description.charAt(1));
 256         }
 257         else
 258         {
 259           seqs.append(consensus.annotations[i].displayCharacter);
 260         }
 261       }
 262     }
 263     SequenceI sq = new Sequence("Consensus", seqs.toString());
 264     sq.setDescription("Percentage Identity Consensus "
 265             + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
 266     return sq;
 267   }
 268
 269   java.awt.Frame nullFrame;
 270
 271   protected FeatureSettings featureSettings = null;
 272
 273   private float heightScale = 1, widthScale = 1;
 274
 275   /**
 276    * {@inheritDoc}
 277    */
 278   @Override
 279   public void setFont(Font f, boolean setGrid)
 280   {
 281     font = f;
 282     if (nullFrame == null)
 283     {
 284       nullFrame = new java.awt.Frame();
 285       nullFrame.addNotify();
 286     }
 287
 288     if (setGrid)
 289     {
 290       FontMetrics fm = nullFrame.getGraphics().getFontMetrics(font);
 291       setCharHeight((int) (heightScale * fm.getHeight()));
 292       setCharWidth((int) (widthScale * fm.charWidth('M')));
 293     }
 294
 295     if (isUpperCasebold())
 296     {
 297       Font f2 = new Font(f.getName(), Font.BOLD, f.getSize());
 298       FontMetrics fm = nullFrame.getGraphics().getFontMetrics(f2);
 299       setCharWidth((int) (widthScale * (fm.stringWidth("MMMMMMMMMMM") / 10)));
 300     }
 301   }
 302
 303   public Font getFont()
 304   {
 305     return font;
 306   }
 307
 308   public void resetSeqLimits(int height)
 309   {
 310     ranges.setEndSeq(height / getCharHeight());
 311   }
 312
 313   public void setCurrentTree(TreeModel tree)
 314   {
 315     currentTree = tree;
 316   }
 317
 318   public TreeModel getCurrentTree()
 319   {
 320     return currentTree;
 321   }
 322
 323   boolean centreColumnLabels;
 324
 325   public boolean getCentreColumnLabels()
 326   {
 327     return centreColumnLabels;
 328   }
 329
 330   public boolean followSelection = true;
 331
 332   /**
 333    * @return true if view selection should always follow the selections
 334    *         broadcast by other selection sources
 335    */
 336   public boolean getFollowSelection()
 337   {
 338     return followSelection;
 339   }
 340
 341   @Override
 342   public void sendSelection()
 343   {
 344     getStructureSelectionManager().sendSelection(
 345             new SequenceGroup(getSelectionGroup()),
 346             new ColumnSelection(getColumnSelection()),
 347             new HiddenColumns(getAlignment().getHiddenColumns()), this);
 348   }
 349
 350   /**
 351    * Returns an instance of the StructureSelectionManager scoped to this applet
 352    * instance.
 353    *
 354    * @return
 355    */
 356   @Override
 357   public StructureSelectionManager getStructureSelectionManager()
 358   {
 359     return jalview.structure.StructureSelectionManager
 360             .getStructureSelectionManager(applet);
 361   }
 362
 363   @Override
 364   public boolean isNormaliseSequenceLogo()
 365   {
 366     return normaliseSequenceLogo;
 367   }
 368
 369   public void setNormaliseSequenceLogo(boolean state)
 370   {
 371     normaliseSequenceLogo = state;
 372   }
 373
 374   /**
 375    *
 376    * @return true if alignment characters should be displayed
 377    */
 378   @Override
 379   public boolean isValidCharWidth()
 380   {
 381     return validCharWidth;
 382   }
 383
 384   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 385   {
 386     return annotationColumnSelectionState;
 387   }
 388
 389   public void setAnnotationColumnSelectionState(
 390           AnnotationColumnChooser annotationColumnSelectionState)
 391   {
 392     this.annotationColumnSelectionState = annotationColumnSelectionState;
 393   }
 394
 395   @Override
 396   public void mirrorCommand(CommandI command, boolean undo,
 397           StructureSelectionManager ssm, VamsasSource source)
 398   {
 399     // TODO refactor so this can be pulled up to superclass or controller
 400     /*
 401      * Do nothing unless we are a 'complement' of the source. May replace this
 402      * with direct calls not via SSM.
 403      */
 404     if (source instanceof AlignViewportI
 405             && ((AlignViewportI) source).getCodingComplement() == this)
 406     {
 407       // ok to continue;
 408     }
 409     else
 410     {
 411       return;
 412     }
 413
 414     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 415             getGapCharacter());
 416     if (mappedCommand != null)
 417     {
 418       mappedCommand.doCommand(null);
 419       firePropertyChange("alignment", null, getAlignment().getSequences());
 420
 421       // ap.scalePanelHolder.repaint();
 422       // ap.repaint();
 423     }
 424   }
 425
 426   @Override
 427   public VamsasSource getVamsasSource()
 428   {
 429     return this;
 430   }
 431
 432   /**
 433    * If this viewport has a (Protein/cDNA) complement, then scroll the
 434    * complementary alignment to match this one.
 435    */
 436   public void scrollComplementaryAlignment(AlignmentPanel complementPanel)
 437   {
 438     if (complementPanel == null)
 439     {
 440       return;
 441     }
 442
 443     /*
 444      * Populate a SearchResults object with the mapped location to scroll to. If
 445      * there is no complement, or it is not following highlights, or no mapping
 446      * is found, the result will be empty.
 447      */
 448     SearchResultsI sr = new SearchResults();
 449     int seqOffset = findComplementScrollTarget(sr);
 450     if (!sr.isEmpty())
 451     {
 452       complementPanel.setToScrollComplementPanel(false);
 453       complementPanel.scrollToCentre(sr, seqOffset);
 454       complementPanel.setToScrollComplementPanel(true);
 455     }
 456   }
 457
 458   /**
 459    * Applies the supplied feature settings descriptor to currently known
 460    * features. This supports an 'initial configuration' of feature colouring
 461    * based on a preset or user favourite. This may then be modified in the usual
 462    * way using the Feature Settings dialogue.
 463    *
 464    * @param featureSettings
 465    */
 466   @Override
 467   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
 468   {
 469     // TODO implement for applet
 470   }
 471
 472 }