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.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;
46 import java.awt.FontMetrics;
48 public class AlignViewport extends AlignmentViewport implements
51 boolean cursorMode = false;
53 Font font = new Font("SansSerif", Font.PLAIN, 10);
55 boolean validCharWidth = true;
57 TreeModel currentTree = null;
59 public jalview.bin.JalviewLite applet;
63 private AnnotationColumnChooser annotationColumnSelectionState;
66 public void finalize()
74 public AlignViewport(AlignmentI al, JalviewLite applet)
77 calculator = new jalview.workers.AlignCalcManager();
81 this.setPadGaps(true);
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 showOccupancy = applet.getDefaultParameter("showOccupancy",
156 setShowUnconserved(applet.getDefaultParameter("showUnconserved",
157 getShowUnconserved()));
159 setScaleProteinAsCdna(applet.getDefaultParameter(
160 "scaleProteinAsCdna", isScaleProteinAsCdna()));
162 String param = applet.getParameter("upperCase");
165 if (param.equalsIgnoreCase("bold"))
167 setUpperCasebold(true);
170 sortByTree = applet.getDefaultParameter("sortByTree", sortByTree);
172 setFollowHighlight(applet.getDefaultParameter("automaticScrolling",
173 isFollowHighlight()));
174 followSelection = isFollowHighlight();
176 showSequenceLogo = applet.getDefaultParameter("showSequenceLogo",
179 normaliseSequenceLogo = applet.getDefaultParameter(
180 "normaliseSequenceLogo", applet.getDefaultParameter(
181 "normaliseLogo", normaliseSequenceLogo));
183 showGroupConsensus = applet.getDefaultParameter("showGroupConsensus",
186 showGroupConservation = applet.getDefaultParameter(
187 "showGroupConservation", showGroupConservation);
189 showConsensusHistogram = applet.getDefaultParameter(
190 "showConsensusHistogram", showConsensusHistogram);
196 String colour = al.isNucleotide() ? applet
197 .getParameter("defaultColourNuc") : applet
198 .getParameter("defaultColourProt");
201 colour = applet.getParameter("defaultColour");
205 colour = applet.getParameter("userDefinedColour");
208 colour = "User Defined";
214 residueShading = new ResidueShader(
215 ColourSchemeProperty.getColourScheme(alignment, colour));
216 if (residueShading != null)
218 residueShading.setConsensus(hconsensus);
222 if (applet.getParameter("userDefinedColour") != null)
224 residueShading = new ResidueShader(
225 new UserColourScheme(
226 applet.getParameter("userDefinedColour")));
229 initAutoAnnotation();
234 * get the consensus sequence as displayed under the PID consensus annotation
237 * @return consensus sequence as a new sequence object
239 public SequenceI getConsensusSeq()
241 if (consensus == null)
243 updateConsensus(null);
245 if (consensus == null)
249 StringBuilder seqs = new StringBuilder(consensus.annotations.length);
250 for (int i = 0; i < consensus.annotations.length; i++)
252 Annotation annotation = consensus.annotations[i];
253 if (annotation != null)
255 String description = annotation.description;
256 if (description != null && description.startsWith("["))
258 // consensus is a tie - just pick the first one
259 seqs.append(annotation.description.charAt(1));
263 seqs.append(annotation.displayCharacter);
267 SequenceI sq = new Sequence("Consensus", seqs.toString());
268 sq.setDescription("Percentage Identity Consensus "
269 + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
273 java.awt.Frame nullFrame;
275 protected FeatureSettings featureSettings = null;
277 private float heightScale = 1, widthScale = 1;
283 public void setFont(Font f, boolean setGrid)
286 if (nullFrame == null)
288 nullFrame = new java.awt.Frame();
289 nullFrame.addNotify();
294 FontMetrics fm = nullFrame.getGraphics().getFontMetrics(font);
295 setCharHeight((int) (heightScale * fm.getHeight()));
296 setCharWidth((int) (widthScale * fm.charWidth('M')));
299 if (isUpperCasebold())
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)));
307 public Font getFont()
312 public void resetSeqLimits(int height)
314 ranges.setEndSeq(height / getCharHeight());
317 public void setCurrentTree(TreeModel tree)
322 public TreeModel getCurrentTree()
327 boolean centreColumnLabels;
329 public boolean getCentreColumnLabels()
331 return centreColumnLabels;
334 public boolean followSelection = true;
337 * @return true if view selection should always follow the selections
338 * broadcast by other selection sources
340 public boolean getFollowSelection()
342 return followSelection;
346 public void sendSelection()
348 getStructureSelectionManager().sendSelection(
349 new SequenceGroup(getSelectionGroup()),
350 new ColumnSelection(getColumnSelection()),
351 new HiddenColumns(getAlignment().getHiddenColumns()), this);
355 * Returns an instance of the StructureSelectionManager scoped to this applet
361 public StructureSelectionManager getStructureSelectionManager()
363 return jalview.structure.StructureSelectionManager
364 .getStructureSelectionManager(applet);
368 public boolean isNormaliseSequenceLogo()
370 return normaliseSequenceLogo;
373 public void setNormaliseSequenceLogo(boolean state)
375 normaliseSequenceLogo = state;
380 * @return true if alignment characters should be displayed
383 public boolean isValidCharWidth()
385 return validCharWidth;
388 public AnnotationColumnChooser getAnnotationColumnSelectionState()
390 return annotationColumnSelectionState;
393 public void setAnnotationColumnSelectionState(
394 AnnotationColumnChooser annotationColumnSelectionState)
396 this.annotationColumnSelectionState = annotationColumnSelectionState;
400 public void mirrorCommand(CommandI command, boolean undo,
401 StructureSelectionManager ssm, VamsasSource source)
403 // TODO refactor so this can be pulled up to superclass or controller
405 * Do nothing unless we are a 'complement' of the source. May replace this
406 * with direct calls not via SSM.
408 if (source instanceof AlignViewportI
409 && ((AlignViewportI) source).getCodingComplement() == this)
418 CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
420 if (mappedCommand != null)
422 mappedCommand.doCommand(null);
423 firePropertyChange("alignment", null, getAlignment().getSequences());
425 // ap.scalePanelHolder.repaint();
431 public VamsasSource getVamsasSource()
437 * If this viewport has a (Protein/cDNA) complement, then scroll the
438 * complementary alignment to match this one.
440 public void scrollComplementaryAlignment(AlignmentPanel complementPanel)
442 if (complementPanel == null)
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.
452 SearchResultsI sr = new SearchResults();
453 int seqOffset = findComplementScrollTarget(sr);
456 complementPanel.setToScrollComplementPanel(false);
457 complementPanel.scrollToCentre(sr, seqOffset);
458 complementPanel.setToScrollComplementPanel(true);
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.
468 * @param featureSettings
471 public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
473 // TODO implement for applet