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.SearchResultsI;
  32 import jalview.datamodel.Sequence;
  33 import jalview.datamodel.SequenceGroup;
  34 import jalview.datamodel.SequenceI;
  35 import jalview.renderer.ResidueShader;
  36 import jalview.schemes.ColourSchemeProperty;
  37 import jalview.schemes.UserColourScheme;
  38 import jalview.structure.SelectionSource;
  39 import jalview.structure.StructureSelectionManager;
  40 import jalview.structure.VamsasSource;
  41 import jalview.viewmodel.AlignmentViewport;
  42 import jalview.viewmodel.ViewportRanges;
  43
  44 import java.awt.Font;
  45
  46 public class AlignViewport extends AlignmentViewport implements
  47         SelectionSource
  48 {
  49   boolean cursorMode = false;
  50
  51   Font font = new Font("SansSerif", Font.PLAIN, 10);
  52
  53   boolean validCharWidth = true;
  54
  55   NJTree currentTree = null;
  56
  57   public jalview.bin.JalviewLite applet;
  58
  59   boolean MAC = false;
  60
  61   private AnnotationColumnChooser annotationColumnSelectionState;
  62
  63   @Override
  64   public void finalize()
  65   {
  66     applet = null;
  67     quality = null;
  68     alignment = null;
  69     colSel = null;
  70   }
  71
  72   public AlignViewport(AlignmentI al, JalviewLite applet)
  73   {
  74     super();
  75     calculator = new jalview.workers.AlignCalcManager();
  76     this.applet = applet;
  77     alignment = al;
  78     ranges = new ViewportRanges(this.alignment);
  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);
 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   public void setFont(Font f)
 276   {
 277     font = f;
 278     if (nullFrame == null)
 279     {
 280       nullFrame = new java.awt.Frame();
 281       nullFrame.addNotify();
 282     }
 283
 284     java.awt.FontMetrics fm = nullFrame.getGraphics().getFontMetrics(font);
 285     setCharHeight((int) (heightScale * fm.getHeight()));
 286     setCharWidth((int) (widthScale * fm.charWidth('M')));
 287
 288     if (isUpperCasebold())
 289     {
 290       Font f2 = new Font(f.getName(), Font.BOLD, f.getSize());
 291       fm = nullFrame.getGraphics().getFontMetrics(f2);
 292       setCharWidth((int) (widthScale * (fm.stringWidth("MMMMMMMMMMM") / 10)));
 293     }
 294   }
 295
 296   public Font getFont()
 297   {
 298     return font;
 299   }
 300
 301   public void resetSeqLimits(int height)
 302   {
 303     ranges.setEndSeq(height / getCharHeight());
 304   }
 305
 306   public void setCurrentTree(NJTree tree)
 307   {
 308     currentTree = tree;
 309   }
 310
 311   public NJTree getCurrentTree()
 312   {
 313     return currentTree;
 314   }
 315
 316   boolean centreColumnLabels;
 317
 318   public boolean getCentreColumnLabels()
 319   {
 320     return centreColumnLabels;
 321   }
 322
 323   public boolean followSelection = true;
 324
 325   /**
 326    * @return true if view selection should always follow the selections
 327    *         broadcast by other selection sources
 328    */
 329   public boolean getFollowSelection()
 330   {
 331     return followSelection;
 332   }
 333
 334   @Override
 335   public void sendSelection()
 336   {
 337     getStructureSelectionManager().sendSelection(
 338             new SequenceGroup(getSelectionGroup()),
 339             new ColumnSelection(getColumnSelection()), this);
 340   }
 341
 342   /**
 343    * Returns an instance of the StructureSelectionManager scoped to this applet
 344    * instance.
 345    *
 346    * @return
 347    */
 348   @Override
 349   public StructureSelectionManager getStructureSelectionManager()
 350   {
 351     return jalview.structure.StructureSelectionManager
 352             .getStructureSelectionManager(applet);
 353   }
 354
 355   @Override
 356   public boolean isNormaliseSequenceLogo()
 357   {
 358     return normaliseSequenceLogo;
 359   }
 360
 361   public void setNormaliseSequenceLogo(boolean state)
 362   {
 363     normaliseSequenceLogo = state;
 364   }
 365
 366   /**
 367    *
 368    * @return true if alignment characters should be displayed
 369    */
 370   @Override
 371   public boolean isValidCharWidth()
 372   {
 373     return validCharWidth;
 374   }
 375
 376   public AnnotationColumnChooser getAnnotationColumnSelectionState()
 377   {
 378     return annotationColumnSelectionState;
 379   }
 380
 381   public void setAnnotationColumnSelectionState(
 382           AnnotationColumnChooser annotationColumnSelectionState)
 383   {
 384     this.annotationColumnSelectionState = annotationColumnSelectionState;
 385   }
 386
 387   @Override
 388   public void mirrorCommand(CommandI command, boolean undo,
 389           StructureSelectionManager ssm, VamsasSource source)
 390   {
 391     // TODO refactor so this can be pulled up to superclass or controller
 392     /*
 393      * Do nothing unless we are a 'complement' of the source. May replace this
 394      * with direct calls not via SSM.
 395      */
 396     if (source instanceof AlignViewportI
 397             && ((AlignViewportI) source).getCodingComplement() == this)
 398     {
 399       // ok to continue;
 400     }
 401     else
 402     {
 403       return;
 404     }
 405
 406     CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
 407             getGapCharacter());
 408     if (mappedCommand != null)
 409     {
 410       mappedCommand.doCommand(null);
 411       firePropertyChange("alignment", null, getAlignment().getSequences());
 412
 413       // ap.scalePanelHolder.repaint();
 414       // ap.repaint();
 415     }
 416   }
 417
 418   @Override
 419   public VamsasSource getVamsasSource()
 420   {
 421     return this;
 422   }
 423
 424   /**
 425    * If this viewport has a (Protein/cDNA) complement, then scroll the
 426    * complementary alignment to match this one.
 427    */
 428   public void scrollComplementaryAlignment(AlignmentPanel complementPanel)
 429   {
 430     if (complementPanel == null)
 431     {
 432       return;
 433     }
 434
 435     /*
 436      * Populate a SearchResults object with the mapped location to scroll to. If
 437      * there is no complement, or it is not following highlights, or no mapping
 438      * is found, the result will be empty.
 439      */
 440     SearchResultsI sr = new SearchResults();
 441     int seqOffset = findComplementScrollTarget(sr);
 442     if (!sr.isEmpty())
 443     {
 444       complementPanel.setFollowingComplementScroll(true);
 445       complementPanel.scrollToCentre(sr, seqOffset);
 446     }
 447   }
 448
 449   /**
 450    * Applies the supplied feature settings descriptor to currently known
 451    * features. This supports an 'initial configuration' of feature colouring
 452    * based on a preset or user favourite. This may then be modified in the usual
 453    * way using the Feature Settings dialogue.
 454    *
 455    * @param featureSettings
 456    */
 457   @Override
 458   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
 459   {
 460     // TODO implement for applet
 461   }
 462
 463 }