2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.appletgui;
23 import jalview.analysis.NJTree;
24 import jalview.api.AlignViewportI;
25 import jalview.api.FeatureRenderer;
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;
44 public class AlignViewport extends AlignmentViewport implements
45 SelectionSource, VamsasSource, CommandListener
47 boolean cursorMode = false;
49 Font font = new Font("SansSerif", Font.PLAIN, 10);
51 boolean validCharWidth = true;
53 NJTree currentTree = null;
55 public jalview.bin.JalviewLite applet;
59 private AnnotationColumnChooser annotationColumnSelectionState;
61 private FeatureRenderer featureRenderer;
63 public void finalize()
71 public AlignViewport(AlignmentI al, JalviewLite applet)
74 calculator = new jalview.workers.AlignCalcManager();
78 this.setPadGaps(true);
80 this.endRes = al.getWidth() - 1;
82 this.endSeq = al.getHeight() - 1;
85 // get the width and height scaling factors if they were specified
86 String param = applet.getParameter("widthScale");
91 widthScale = new Float(param).floatValue();
95 if (widthScale <= 1.0)
98 .println("Invalid alignment character width scaling factor ("
99 + widthScale + "). Ignoring.");
102 if (JalviewLite.debug)
105 .println("Alignment character width scaling factor is now "
109 param = applet.getParameter("heightScale");
114 heightScale = new Float(param).floatValue();
115 } catch (Exception e)
118 if (heightScale <= 1.0)
121 .println("Invalid alignment character height scaling factor ("
122 + heightScale + "). Ignoring.");
125 if (JalviewLite.debug)
128 .println("Alignment character height scaling factor is now "
135 MAC = new jalview.util.Platform().isAMac();
139 setShowJVSuffix(applet.getDefaultParameter("showFullId",
142 setShowAnnotation(applet.getDefaultParameter("showAnnotation",
143 isShowAnnotation()));
145 showConservation = applet.getDefaultParameter("showConservation",
148 showQuality = applet.getDefaultParameter("showQuality", showQuality);
150 showConsensus = applet.getDefaultParameter("showConsensus",
153 setShowUnconserved(applet.getDefaultParameter("showUnconserved",
154 getShowUnconserved()));
156 setScaleProteinAsCdna(applet.getDefaultParameter(
157 "scaleProteinAsCdna", isScaleProteinAsCdna()));
159 String param = applet.getParameter("upperCase");
162 if (param.equalsIgnoreCase("bold"))
164 setUpperCasebold(true);
167 sortByTree = applet.getDefaultParameter("sortByTree", sortByTree);
169 setFollowHighlight(applet.getDefaultParameter("automaticScrolling",
170 isFollowHighlight()));
171 followSelection = isFollowHighlight();
173 showSequenceLogo = applet.getDefaultParameter("showSequenceLogo",
176 normaliseSequenceLogo = applet.getDefaultParameter(
177 "normaliseSequenceLogo", applet.getDefaultParameter(
178 "normaliseLogo", normaliseSequenceLogo));
180 showGroupConsensus = applet.getDefaultParameter("showGroupConsensus",
183 showGroupConservation = applet.getDefaultParameter(
184 "showGroupConservation", showGroupConservation);
186 showConsensusHistogram = applet.getDefaultParameter(
187 "showConsensusHistogram", showConsensusHistogram);
193 String colour = applet.getParameter("defaultColour");
197 colour = applet.getParameter("userDefinedColour");
200 colour = "User Defined";
206 globalColourScheme = ColourSchemeProperty.getColour(alignment,
208 if (globalColourScheme != null)
210 globalColourScheme.setConsensus(hconsensus);
214 if (applet.getParameter("userDefinedColour") != null)
216 ((UserColourScheme) globalColourScheme).parseAppletParameter(applet
217 .getParameter("userDefinedColour"));
220 initAutoAnnotation();
225 * get the consensus sequence as displayed under the PID consensus annotation
228 * @return consensus sequence as a new sequence object
230 public SequenceI getConsensusSeq()
232 if (consensus == null)
234 updateConsensus(null);
236 if (consensus == null)
240 StringBuilder seqs = new StringBuilder(consensus.annotations.length);
241 for (int i = 0; i < consensus.annotations.length; i++)
243 if (consensus.annotations[i] != null)
245 if (consensus.annotations[i].description.charAt(0) == '[')
247 seqs.append(consensus.annotations[i].description.charAt(1));
251 seqs.append(consensus.annotations[i].displayCharacter);
255 SequenceI sq = new Sequence("Consensus", seqs.toString());
256 sq.setDescription("Percentage Identity Consensus "
257 + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
261 java.awt.Frame nullFrame;
263 protected FeatureSettings featureSettings = null;
265 private float heightScale = 1, widthScale = 1;
267 public void setFont(Font f)
270 if (nullFrame == null)
272 nullFrame = new java.awt.Frame();
273 nullFrame.addNotify();
276 java.awt.FontMetrics fm = nullFrame.getGraphics().getFontMetrics(font);
277 setCharHeight((int) (heightScale * fm.getHeight()));
278 setCharWidth((int) (widthScale * fm.charWidth('M')));
280 if (isUpperCasebold())
282 Font f2 = new Font(f.getName(), Font.BOLD, f.getSize());
283 fm = nullFrame.getGraphics().getFontMetrics(f2);
284 setCharWidth((int) (widthScale * (fm.stringWidth("MMMMMMMMMMM") / 10)));
288 public Font getFont()
294 public void resetSeqLimits(int height)
296 setEndSeq(height / getCharHeight());
299 public void setCurrentTree(NJTree tree)
304 public NJTree getCurrentTree()
310 boolean centreColumnLabels;
312 public boolean getCentreColumnLabels()
314 return centreColumnLabels;
317 public boolean followSelection = true;
320 * @return true if view selection should always follow the selections
321 * broadcast by other selection sources
323 public boolean getFollowSelection()
325 return followSelection;
328 public void sendSelection()
330 getStructureSelectionManager().sendSelection(
331 new SequenceGroup(getSelectionGroup()),
332 new ColumnSelection(getColumnSelection()), this);
336 * Returns an instance of the StructureSelectionManager scoped to this applet
342 public StructureSelectionManager getStructureSelectionManager()
344 return jalview.structure.StructureSelectionManager
345 .getStructureSelectionManager(applet);
349 * synthesize a column selection if none exists so it covers the given
350 * selection group. if wholewidth is false, no column selection is made if the
351 * selection group covers the whole alignment width.
356 public void expandColSelection(SequenceGroup sg, boolean wholewidth)
360 && (sgs = sg.getStartRes()) >= 0
361 && sg.getStartRes() <= (sge = sg.getEndRes())
362 && (colSel == null || colSel.getSelected() == null || colSel
363 .getSelected().size() == 0))
365 if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
372 colSel = new ColumnSelection();
374 for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
376 colSel.addElement(cspos);
381 public boolean isNormaliseSequenceLogo()
383 return normaliseSequenceLogo;
386 public void setNormaliseSequenceLogo(boolean state)
388 normaliseSequenceLogo = state;
393 * @return true if alignment characters should be displayed
395 public boolean isValidCharWidth()
397 return validCharWidth;
400 public AnnotationColumnChooser getAnnotationColumnSelectionState()
402 return annotationColumnSelectionState;
405 public void setAnnotationColumnSelectionState(
406 AnnotationColumnChooser annotationColumnSelectionState)
408 this.annotationColumnSelectionState = annotationColumnSelectionState;
412 public void mirrorCommand(CommandI command, boolean undo,
413 StructureSelectionManager ssm, VamsasSource source)
415 // TODO refactor so this can be pulled up to superclass or controller
417 * Do nothing unless we are a 'complement' of the source. May replace this
418 * with direct calls not via SSM.
420 if (source instanceof AlignViewportI
421 && ((AlignViewportI) source).getCodingComplement() == this)
430 CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
432 if (mappedCommand != null)
434 mappedCommand.doCommand(null);
435 firePropertyChange("alignment", null, getAlignment().getSequences());
437 // ap.scalePanelHolder.repaint();
443 public VamsasSource getVamsasSource()
449 * If this viewport has a (Protein/cDNA) complement, then scroll the
450 * complementary alignment to match this one.
452 public void scrollComplementaryAlignment(AlignmentPanel complementPanel)
454 if (complementPanel == null)
460 * Populate a SearchResults object with the mapped location to scroll to. If
461 * there is no complement, or it is not following highlights, or no mapping
462 * is found, the result will be empty.
464 SearchResults sr = new SearchResults();
465 int seqOffset = findComplementScrollTarget(sr);
468 complementPanel.setFollowingComplementScroll(true);
469 complementPanel.scrollToCentre(sr, seqOffset);
474 public FeatureRenderer getFeatureRenderer()
476 return featureRenderer;
480 public void setFeatureRenderer(FeatureRenderer featureRenderer)
482 this.featureRenderer = featureRenderer;