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