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