2 * Jalview - A Sequence Alignment Editor and Viewer
\r
3 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
\r
5 * This program is free software; you can redistribute it and/or
\r
6 * modify it under the terms of the GNU General Public License
\r
7 * as published by the Free Software Foundation; either version 2
\r
8 * of the License, or (at your option) any later version.
\r
10 * This program is distributed in the hope that it will be useful,
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 * GNU General Public License for more details.
\r
15 * You should have received a copy of the GNU General Public License
\r
16 * along with this program; if not, write to the Free Software
\r
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
\r
19 package jalview.gui;
\r
21 import jalview.analysis.*;
\r
23 import jalview.bin.*;
\r
25 import jalview.datamodel.*;
\r
27 import jalview.schemes.*;
\r
38 * @version $Revision$
\r
40 public class AlignViewport
\r
46 boolean showFullId = false;
\r
47 boolean showText = true;
\r
48 boolean showColourText = false;
\r
49 boolean showBoxes = true;
\r
50 boolean wrapAlignment = false;
\r
51 boolean renderGaps = true;
\r
52 boolean showSequenceFeatures = false;
\r
53 boolean showAnnotation = true;
\r
54 boolean showConservation = true;
\r
55 boolean showQuality = true;
\r
56 boolean showIdentity = true;
\r
57 boolean colourAppliesToAllGroups = true;
\r
58 ColourSchemeI globalColourScheme = null;
\r
59 boolean conservationColourSelected = false;
\r
60 boolean abovePIDThreshold = false;
\r
61 SequenceGroup selectionGroup;
\r
66 Font font = new Font("SansSerif", Font.PLAIN, 10);
\r
67 AlignmentI alignment;
\r
68 ColumnSelection colSel = new ColumnSelection();
\r
71 NJTree currentTree = null;
\r
72 boolean scaleAboveWrapped = false;
\r
73 boolean scaleLeftWrapped = true;
\r
74 boolean scaleRightWrapped = true;
\r
76 /** DOCUMENT ME!! */
\r
77 public Vector vconsensus;
\r
78 AlignmentAnnotation consensus;
\r
79 AlignmentAnnotation conservation;
\r
80 AlignmentAnnotation quality;
\r
82 /** DOCUMENT ME!! */
\r
83 public int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
\r
85 // JBPNote Prolly only need this in the applet version.
\r
86 private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(this);
\r
88 boolean ignoreGapsInConsensusCalculation = false;
\r
91 * Creates a new AlignViewport object.
\r
93 * @param al DOCUMENT ME!
\r
95 public AlignViewport(AlignmentI al)
\r
99 this.endRes = al.getWidth() - 1;
\r
101 this.endSeq = al.getHeight() - 1;
\r
103 updateFromPreferences();
\r
109 public void updateFromPreferences()
\r
111 showFullId = Cache.getDefault("SHOW_FULL_ID", true);
\r
112 showAnnotation = Cache.getDefault("SHOW_ANNOTATIONS", true);
\r
113 showConservation = Cache.getDefault("SHOW_CONSERVATION", true);
\r
115 showQuality = Cache.getDefault("SHOW_QUALITY", true);
\r
116 showIdentity = Cache.getDefault("SHOW_IDENTITY", true);
\r
118 String fontName = Cache.getDefault("FONT_NAME", "SansSerif");
\r
119 String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + "") ;
\r
120 String fontSize = Cache.getDefault("FONT_SIZE", "10");
\r
124 if (fontStyle.equals("bold"))
\r
128 else if (fontStyle.equals("italic"))
\r
133 setFont(new Font(fontName, style, Integer.parseInt(fontSize)));
\r
136 alignment.setGapCharacter( Cache.getDefault("GAP_SYMBOL", "-").charAt(0) );
\r
139 // We must set conservation and consensus before setting colour,
\r
140 // as Blosum and Clustal require this to be done
\r
141 updateConservation();
\r
144 if (jalview.bin.Cache.getProperty("DEFAULT_COLOUR") != null)
\r
146 globalColourScheme = ColourSchemeProperty.getColour(alignment,
\r
147 jalview.bin.Cache.getProperty("DEFAULT_COLOUR"));
\r
149 if (globalColourScheme instanceof UserColourScheme)
\r
151 globalColourScheme = UserDefinedColours.loadDefaultColours();
\r
152 ((UserColourScheme)globalColourScheme).setThreshold(0, getIgnoreGapsConsensus());
\r
155 if (globalColourScheme != null)
\r
157 globalColourScheme.setConsensus(vconsensus);
\r
167 * @param b DOCUMENT ME!
\r
169 public void showSequenceFeatures(boolean b)
\r
171 showSequenceFeatures = b;
\r
177 public void updateConservation()
\r
179 Conservation cons = new jalview.analysis.Conservation("All",
\r
180 jalview.schemes.ResidueProperties.propHash, 3,
\r
181 alignment.getSequences(), 0, alignment.getWidth() - 1);
\r
183 cons.verdict(false, ConsPercGaps);
\r
184 cons.findQuality();
\r
186 int alWidth = alignment.getWidth();
\r
187 Annotation[] annotations = new Annotation[alWidth];
\r
188 Annotation[] qannotations = new Annotation[alWidth];
\r
189 String sequence = cons.getConsSequence().getSequence();
\r
199 maxR = 1.0f - minR;
\r
200 maxG = 0.9f - minG;
\r
201 maxB = 0f - minB; // scalable range for colouring both Conservation and Quality
\r
205 float qmin = cons.qualityRange[0].floatValue();
\r
206 float qmax = cons.qualityRange[1].floatValue();
\r
208 for (int i = 0; i < alWidth; i++)
\r
214 value = Integer.parseInt(sequence.charAt(i) + "");
\r
216 catch (Exception ex)
\r
218 if (sequence.charAt(i) == '*')
\r
223 if (sequence.charAt(i) == '+')
\r
229 float vprop = value - min;
\r
231 annotations[i] = new Annotation(sequence.charAt(i) + "",
\r
232 String.valueOf(value), ' ', value,
\r
233 new Color(minR + (maxR * vprop), minG + (maxG * vprop),
\r
234 minB + (maxB * vprop)));
\r
237 value = ((Double) cons.quality.get(i)).floatValue();
\r
238 vprop = value - qmin;
\r
240 qannotations[i] = new Annotation(" ", String.valueOf(value), ' ',
\r
242 new Color(minR + (maxR * vprop), minG + (maxG * vprop),
\r
243 minB + (maxB * vprop)));
\r
246 if (conservation == null)
\r
248 conservation = new AlignmentAnnotation("Conservation",
\r
249 "Conservation of total alignment less than " +
\r
250 ConsPercGaps + "% gaps", annotations, 0f, // cons.qualityRange[0].floatValue(),
\r
251 11f, // cons.qualityRange[1].floatValue()
\r
254 if (showConservation)
\r
256 alignment.addAnnotation(conservation);
\r
259 quality = new AlignmentAnnotation("Quality",
\r
260 "Alignment Quality based on Blosum62 scores", qannotations,
\r
261 cons.qualityRange[0].floatValue(),
\r
262 cons.qualityRange[1].floatValue(), 1);
\r
266 alignment.addAnnotation(quality);
\r
271 conservation.annotations = annotations;
\r
272 quality.annotations = qannotations;
\r
273 quality.graphMax = cons.qualityRange[1].floatValue();
\r
280 public void updateConsensus()
\r
282 Annotation[] annotations = new Annotation[alignment.getWidth()];
\r
284 // this routine prevents vconsensus becoming a new object each time
\r
285 // consenus is calculated. Important for speed of Blosum62
\r
286 // and PID colouring of alignment
\r
287 if (vconsensus == null)
\r
289 vconsensus = alignment.getAAFrequency();
\r
293 Vector temp = alignment.getAAFrequency();
\r
294 vconsensus.clear();
\r
296 Enumeration e = temp.elements();
\r
298 while (e.hasMoreElements())
\r
300 vconsensus.add(e.nextElement());
\r
304 Hashtable hash = null;
\r
306 for (int i = 0; i < alignment.getWidth(); i++)
\r
308 hash = (Hashtable) vconsensus.elementAt(i);
\r
311 if(ignoreGapsInConsensusCalculation)
\r
312 value = ((Float)hash.get("pid_nogaps")).floatValue();
\r
314 value = ((Float)hash.get("pid_gaps")).floatValue();
\r
316 String maxRes = hash.get("maxResidue").toString();
\r
317 String mouseOver = hash.get("maxResidue")+" ";
\r
319 if (maxRes.length() > 1)
\r
321 mouseOver = "[" + maxRes + "] ";
\r
325 mouseOver += ((int) value + "%");
\r
326 annotations[i] = new Annotation(maxRes, mouseOver, ' ', value);
\r
329 if (consensus == null)
\r
331 consensus = new AlignmentAnnotation("Consensus", "PID",
\r
332 annotations, 0f, 100f, 1);
\r
336 alignment.addAnnotation(consensus);
\r
341 consensus.annotations = annotations;
\r
344 if(globalColourScheme!=null)
\r
345 globalColourScheme.setConsensus(vconsensus);
\r
351 * @return DOCUMENT ME!
\r
353 public SequenceGroup getSelectionGroup()
\r
355 return selectionGroup;
\r
361 * @param sg DOCUMENT ME!
\r
363 public void setSelectionGroup(SequenceGroup sg)
\r
365 selectionGroup = sg;
\r
371 * @return DOCUMENT ME!
\r
373 public boolean getConservationSelected()
\r
375 return conservationColourSelected;
\r
381 * @param b DOCUMENT ME!
\r
383 public void setConservationSelected(boolean b)
\r
385 conservationColourSelected = b;
\r
391 * @return DOCUMENT ME!
\r
393 public boolean getAbovePIDThreshold()
\r
395 return abovePIDThreshold;
\r
401 * @param b DOCUMENT ME!
\r
403 public void setAbovePIDThreshold(boolean b)
\r
405 abovePIDThreshold = b;
\r
411 * @return DOCUMENT ME!
\r
413 public int getStartRes()
\r
421 * @return DOCUMENT ME!
\r
423 public int getEndRes()
\r
431 * @return DOCUMENT ME!
\r
433 public int getStartSeq()
\r
441 * @param cs DOCUMENT ME!
\r
443 public void setGlobalColourScheme(ColourSchemeI cs)
\r
445 globalColourScheme = cs;
\r
451 * @return DOCUMENT ME!
\r
453 public ColourSchemeI getGlobalColourScheme()
\r
455 return globalColourScheme;
\r
461 * @param res DOCUMENT ME!
\r
463 public void setStartRes(int res)
\r
465 this.startRes = res;
\r
471 * @param seq DOCUMENT ME!
\r
473 public void setStartSeq(int seq)
\r
475 this.startSeq = seq;
\r
481 * @param res DOCUMENT ME!
\r
483 public void setEndRes(int res)
\r
485 if (res > (alignment.getWidth() - 1))
\r
487 // log.System.out.println(" Corrected res from " + res + " to maximum " + (alignment.getWidth()-1));
\r
488 res = alignment.getWidth() - 1;
\r
502 * @param seq DOCUMENT ME!
\r
504 public void setEndSeq(int seq)
\r
506 if (seq > alignment.getHeight())
\r
508 seq = alignment.getHeight();
\r
522 * @return DOCUMENT ME!
\r
524 public int getEndSeq()
\r
532 * @param f DOCUMENT ME!
\r
534 public void setFont(Font f)
\r
538 Container c = new Container();
\r
540 java.awt.FontMetrics fm = c.getFontMetrics(font);
\r
541 setCharHeight(fm.getHeight());
\r
542 setCharWidth(fm.charWidth('M'));
\r
548 * @return DOCUMENT ME!
\r
550 public Font getFont()
\r
558 * @param w DOCUMENT ME!
\r
560 public void setCharWidth(int w)
\r
562 this.charWidth = w;
\r
568 * @return DOCUMENT ME!
\r
570 public int getCharWidth()
\r
578 * @param h DOCUMENT ME!
\r
580 public void setCharHeight(int h)
\r
582 this.charHeight = h;
\r
588 * @return DOCUMENT ME!
\r
590 public int getCharHeight()
\r
598 * @param w DOCUMENT ME!
\r
600 public void setChunkWidth(int w)
\r
602 this.chunkWidth = w;
\r
608 * @return DOCUMENT ME!
\r
610 public int getChunkWidth()
\r
618 * @param h DOCUMENT ME!
\r
620 public void setChunkHeight(int h)
\r
622 this.chunkHeight = h;
\r
628 * @return DOCUMENT ME!
\r
630 public int getChunkHeight()
\r
632 return chunkHeight;
\r
638 * @return DOCUMENT ME!
\r
640 public AlignmentI getAlignment()
\r
648 * @param align DOCUMENT ME!
\r
650 public void setAlignment(AlignmentI align)
\r
652 this.alignment = align;
\r
658 * @param state DOCUMENT ME!
\r
660 public void setWrapAlignment(boolean state)
\r
662 wrapAlignment = state;
\r
668 * @param state DOCUMENT ME!
\r
670 public void setShowText(boolean state)
\r
678 * @param state DOCUMENT ME!
\r
680 public void setRenderGaps(boolean state)
\r
682 renderGaps = state;
\r
688 * @return DOCUMENT ME!
\r
690 public boolean getColourText()
\r
692 return showColourText;
\r
698 * @param state DOCUMENT ME!
\r
700 public void setColourText(boolean state)
\r
702 showColourText = state;
\r
708 * @param state DOCUMENT ME!
\r
710 public void setShowBoxes(boolean state)
\r
718 * @return DOCUMENT ME!
\r
720 public boolean getWrapAlignment()
\r
722 return wrapAlignment;
\r
728 * @return DOCUMENT ME!
\r
730 public boolean getShowText()
\r
738 * @return DOCUMENT ME!
\r
740 public boolean getShowBoxes()
\r
748 * @return DOCUMENT ME!
\r
750 public char getGapCharacter()
\r
752 return getAlignment().getGapCharacter();
\r
758 * @param gap DOCUMENT ME!
\r
760 public void setGapCharacter(char gap)
\r
762 if (getAlignment() != null)
\r
764 getAlignment().setGapCharacter(gap);
\r
771 * @param thresh DOCUMENT ME!
\r
773 public void setThreshold(int thresh)
\r
775 threshold = thresh;
\r
781 * @return DOCUMENT ME!
\r
783 public int getThreshold()
\r
791 * @param inc DOCUMENT ME!
\r
793 public void setIncrement(int inc)
\r
801 * @return DOCUMENT ME!
\r
803 public int getIncrement()
\r
811 * @param y DOCUMENT ME!
\r
813 * @return DOCUMENT ME!
\r
815 public int getIndex(int y)
\r
818 int starty = getStartSeq();
\r
819 int endy = getEndSeq();
\r
821 for (int i = starty; i <= endy; i++)
\r
823 if ((i < alignment.getHeight()) &&
\r
824 (alignment.getSequenceAt(i) != null))
\r
826 int y2 = y1 + getCharHeight();
\r
828 if ((y >= y1) && (y <= y2))
\r
847 * @return DOCUMENT ME!
\r
849 public ColumnSelection getColumnSelection()
\r
857 * @param height DOCUMENT ME!
\r
859 public void resetSeqLimits(int height)
\r
861 setEndSeq(height / getCharHeight());
\r
867 * @param tree DOCUMENT ME!
\r
869 public void setCurrentTree(NJTree tree)
\r
871 currentTree = tree;
\r
877 * @return DOCUMENT ME!
\r
879 public NJTree getCurrentTree()
\r
881 return currentTree;
\r
887 * @param b DOCUMENT ME!
\r
889 public void setColourAppliesToAllGroups(boolean b)
\r
891 colourAppliesToAllGroups = b;
\r
897 * @return DOCUMENT ME!
\r
899 public boolean getColourAppliesToAllGroups()
\r
901 return colourAppliesToAllGroups;
\r
907 * @return DOCUMENT ME!
\r
909 public boolean getShowFullId()
\r
917 * @param b DOCUMENT ME!
\r
919 public void setShowFullId(boolean b)
\r
927 * @return DOCUMENT ME!
\r
929 public boolean getShowAnnotation()
\r
931 return showAnnotation;
\r
937 * @param b DOCUMENT ME!
\r
939 public void setShowAnnotation(boolean b)
\r
941 showAnnotation = b;
\r
947 * @return DOCUMENT ME!
\r
949 public boolean getScaleAboveWrapped()
\r
951 return scaleAboveWrapped;
\r
957 * @return DOCUMENT ME!
\r
959 public boolean getScaleLeftWrapped()
\r
961 return scaleLeftWrapped;
\r
967 * @return DOCUMENT ME!
\r
969 public boolean getScaleRightWrapped()
\r
971 return scaleRightWrapped;
\r
977 * @param b DOCUMENT ME!
\r
979 public void setScaleAboveWrapped(boolean b)
\r
981 scaleAboveWrapped = b;
\r
987 * @param b DOCUMENT ME!
\r
989 public void setScaleLeftWrapped(boolean b)
\r
991 scaleLeftWrapped = b;
\r
997 * @param b DOCUMENT ME!
\r
999 public void setScaleRightWrapped(boolean b)
\r
1001 scaleRightWrapped = b;
\r
1005 * Property change listener for changes in alignment
\r
1007 * @param listener DOCUMENT ME!
\r
1009 public void addPropertyChangeListener(
\r
1010 java.beans.PropertyChangeListener listener)
\r
1012 changeSupport.addPropertyChangeListener(listener);
\r
1018 * @param listener DOCUMENT ME!
\r
1020 public void removePropertyChangeListener(
\r
1021 java.beans.PropertyChangeListener listener)
\r
1023 changeSupport.removePropertyChangeListener(listener);
\r
1027 * Property change listener for changes in alignment
\r
1029 * @param prop DOCUMENT ME!
\r
1030 * @param oldvalue DOCUMENT ME!
\r
1031 * @param newvalue DOCUMENT ME!
\r
1033 public void firePropertyChange(String prop, Object oldvalue, Object newvalue)
\r
1035 changeSupport.firePropertyChange(prop, oldvalue, newvalue);
\r
1038 public void setIgnoreGapsConsensus(boolean b)
\r
1040 ignoreGapsInConsensusCalculation = b;
\r
1041 updateConsensus();
\r
1042 if(globalColourScheme!=null)
\r
1044 globalColourScheme.setThreshold(globalColourScheme.getThreshold(), ignoreGapsInConsensusCalculation);
\r
1049 public boolean getIgnoreGapsConsensus()
\r
1051 return ignoreGapsInConsensusCalculation;
\r