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
180 Conservation cons = new jalview.analysis.Conservation("All",
\r
181 jalview.schemes.ResidueProperties.propHash, 3,
\r
182 alignment.getSequences(), 0, alignment.getWidth() - 1);
\r
184 cons.verdict(false, ConsPercGaps);
\r
185 cons.findQuality();
\r
187 int alWidth = alignment.getWidth();
\r
188 Annotation[] annotations = new Annotation[alWidth];
\r
189 Annotation[] qannotations = new Annotation[alWidth];
\r
190 String sequence = cons.getConsSequence().getSequence();
\r
200 maxR = 1.0f - minR;
\r
201 maxG = 0.9f - minG;
\r
202 maxB = 0f - minB; // scalable range for colouring both Conservation and Quality
\r
206 float qmin = cons.qualityRange[0].floatValue();
\r
207 float qmax = cons.qualityRange[1].floatValue();
\r
209 for (int i = 0; i < alWidth; i++)
\r
215 value = Integer.parseInt(sequence.charAt(i) + "");
\r
217 catch (Exception ex)
\r
219 if (sequence.charAt(i) == '*')
\r
224 if (sequence.charAt(i) == '+')
\r
230 float vprop = value - min;
\r
232 annotations[i] = new Annotation(sequence.charAt(i) + "",
\r
233 String.valueOf(value), ' ', value,
\r
234 new Color(minR + (maxR * vprop),
\r
235 minG + (maxG * vprop),
\r
236 minB + (maxB * vprop)));
\r
239 value = ( (Double) cons.quality.get(i)).floatValue();
\r
240 vprop = value - qmin;
\r
242 qannotations[i] = new Annotation(" ", String.valueOf(value), ' ',
\r
244 new Color(minR + (maxR * vprop),
\r
245 minG + (maxG * vprop),
\r
246 minB + (maxB * vprop)));
\r
249 if (conservation == null)
\r
251 conservation = new AlignmentAnnotation("Conservation",
\r
252 "Conservation of total alignment less than " +
\r
253 ConsPercGaps + "% gaps",
\r
254 annotations, 0f, // cons.qualityRange[0].floatValue(),
\r
255 11f, // cons.qualityRange[1].floatValue()
\r
258 if (showConservation)
\r
260 alignment.addAnnotation(conservation);
\r
263 quality = new AlignmentAnnotation("Quality",
\r
264 "Alignment Quality based on Blosum62 scores",
\r
266 cons.qualityRange[0].floatValue(),
\r
267 cons.qualityRange[1].floatValue(),
\r
272 alignment.addAnnotation(quality);
\r
277 conservation.annotations = annotations;
\r
278 quality.annotations = qannotations;
\r
279 quality.graphMax = cons.qualityRange[1].floatValue();
\r
281 }catch(OutOfMemoryError error)
\r
283 System.out.println("Out of memory calculating conservation.");
\r
291 public void updateConsensus()
\r
294 Annotation[] annotations = new Annotation[alignment.getWidth()];
\r
296 // this routine prevents vconsensus becoming a new object each time
\r
297 // consenus is calculated. Important for speed of Blosum62
\r
298 // and PID colouring of alignment
\r
299 if (vconsensus == null)
\r
301 vconsensus = alignment.getAAFrequency();
\r
305 Vector temp = alignment.getAAFrequency();
\r
306 vconsensus.clear();
\r
308 Enumeration e = temp.elements();
\r
310 while (e.hasMoreElements())
\r
312 vconsensus.add(e.nextElement());
\r
316 Hashtable hash = null;
\r
318 for (int i = 0; i < alignment.getWidth(); i++)
\r
320 hash = (Hashtable) vconsensus.elementAt(i);
\r
323 if (ignoreGapsInConsensusCalculation)
\r
324 value = ( (Float) hash.get("pid_nogaps")).floatValue();
\r
326 value = ( (Float) hash.get("pid_gaps")).floatValue();
\r
328 String maxRes = hash.get("maxResidue").toString();
\r
329 String mouseOver = hash.get("maxResidue") + " ";
\r
331 if (maxRes.length() > 1)
\r
333 mouseOver = "[" + maxRes + "] ";
\r
337 mouseOver += ( (int) value + "%");
\r
338 annotations[i] = new Annotation(maxRes, mouseOver, ' ', value);
\r
341 if (consensus == null)
\r
343 consensus = new AlignmentAnnotation("Consensus", "PID",
\r
344 annotations, 0f, 100f, 1);
\r
348 alignment.addAnnotation(consensus);
\r
353 consensus.annotations = annotations;
\r
356 if (globalColourScheme != null)
\r
357 globalColourScheme.setConsensus(vconsensus);
\r
359 }catch(OutOfMemoryError error)
\r
361 System.out.println("Out of memory calculating consensus.");
\r
370 * @return DOCUMENT ME!
\r
372 public SequenceGroup getSelectionGroup()
\r
374 return selectionGroup;
\r
380 * @param sg DOCUMENT ME!
\r
382 public void setSelectionGroup(SequenceGroup sg)
\r
384 selectionGroup = sg;
\r
390 * @return DOCUMENT ME!
\r
392 public boolean getConservationSelected()
\r
394 return conservationColourSelected;
\r
400 * @param b DOCUMENT ME!
\r
402 public void setConservationSelected(boolean b)
\r
404 conservationColourSelected = b;
\r
410 * @return DOCUMENT ME!
\r
412 public boolean getAbovePIDThreshold()
\r
414 return abovePIDThreshold;
\r
420 * @param b DOCUMENT ME!
\r
422 public void setAbovePIDThreshold(boolean b)
\r
424 abovePIDThreshold = b;
\r
430 * @return DOCUMENT ME!
\r
432 public int getStartRes()
\r
440 * @return DOCUMENT ME!
\r
442 public int getEndRes()
\r
450 * @return DOCUMENT ME!
\r
452 public int getStartSeq()
\r
460 * @param cs DOCUMENT ME!
\r
462 public void setGlobalColourScheme(ColourSchemeI cs)
\r
464 globalColourScheme = cs;
\r
470 * @return DOCUMENT ME!
\r
472 public ColourSchemeI getGlobalColourScheme()
\r
474 return globalColourScheme;
\r
480 * @param res DOCUMENT ME!
\r
482 public void setStartRes(int res)
\r
484 this.startRes = res;
\r
490 * @param seq DOCUMENT ME!
\r
492 public void setStartSeq(int seq)
\r
494 this.startSeq = seq;
\r
500 * @param res DOCUMENT ME!
\r
502 public void setEndRes(int res)
\r
504 if (res > (alignment.getWidth() - 1))
\r
506 // log.System.out.println(" Corrected res from " + res + " to maximum " + (alignment.getWidth()-1));
\r
507 res = alignment.getWidth() - 1;
\r
521 * @param seq DOCUMENT ME!
\r
523 public void setEndSeq(int seq)
\r
525 if (seq > alignment.getHeight())
\r
527 seq = alignment.getHeight();
\r
541 * @return DOCUMENT ME!
\r
543 public int getEndSeq()
\r
551 * @param f DOCUMENT ME!
\r
553 public void setFont(Font f)
\r
557 Container c = new Container();
\r
559 java.awt.FontMetrics fm = c.getFontMetrics(font);
\r
560 setCharHeight(fm.getHeight());
\r
561 setCharWidth(fm.charWidth('M'));
\r
567 * @return DOCUMENT ME!
\r
569 public Font getFont()
\r
577 * @param w DOCUMENT ME!
\r
579 public void setCharWidth(int w)
\r
581 this.charWidth = w;
\r
587 * @return DOCUMENT ME!
\r
589 public int getCharWidth()
\r
597 * @param h DOCUMENT ME!
\r
599 public void setCharHeight(int h)
\r
601 this.charHeight = h;
\r
607 * @return DOCUMENT ME!
\r
609 public int getCharHeight()
\r
617 * @param w DOCUMENT ME!
\r
619 public void setChunkWidth(int w)
\r
621 this.chunkWidth = w;
\r
627 * @return DOCUMENT ME!
\r
629 public int getChunkWidth()
\r
637 * @param h DOCUMENT ME!
\r
639 public void setChunkHeight(int h)
\r
641 this.chunkHeight = h;
\r
647 * @return DOCUMENT ME!
\r
649 public int getChunkHeight()
\r
651 return chunkHeight;
\r
657 * @return DOCUMENT ME!
\r
659 public AlignmentI getAlignment()
\r
667 * @param align DOCUMENT ME!
\r
669 public void setAlignment(AlignmentI align)
\r
671 this.alignment = align;
\r
677 * @param state DOCUMENT ME!
\r
679 public void setWrapAlignment(boolean state)
\r
681 wrapAlignment = state;
\r
687 * @param state DOCUMENT ME!
\r
689 public void setShowText(boolean state)
\r
697 * @param state DOCUMENT ME!
\r
699 public void setRenderGaps(boolean state)
\r
701 renderGaps = state;
\r
707 * @return DOCUMENT ME!
\r
709 public boolean getColourText()
\r
711 return showColourText;
\r
717 * @param state DOCUMENT ME!
\r
719 public void setColourText(boolean state)
\r
721 showColourText = state;
\r
727 * @param state DOCUMENT ME!
\r
729 public void setShowBoxes(boolean state)
\r
737 * @return DOCUMENT ME!
\r
739 public boolean getWrapAlignment()
\r
741 return wrapAlignment;
\r
747 * @return DOCUMENT ME!
\r
749 public boolean getShowText()
\r
757 * @return DOCUMENT ME!
\r
759 public boolean getShowBoxes()
\r
767 * @return DOCUMENT ME!
\r
769 public char getGapCharacter()
\r
771 return getAlignment().getGapCharacter();
\r
777 * @param gap DOCUMENT ME!
\r
779 public void setGapCharacter(char gap)
\r
781 if (getAlignment() != null)
\r
783 getAlignment().setGapCharacter(gap);
\r
790 * @param thresh DOCUMENT ME!
\r
792 public void setThreshold(int thresh)
\r
794 threshold = thresh;
\r
800 * @return DOCUMENT ME!
\r
802 public int getThreshold()
\r
810 * @param inc DOCUMENT ME!
\r
812 public void setIncrement(int inc)
\r
820 * @return DOCUMENT ME!
\r
822 public int getIncrement()
\r
830 * @param y DOCUMENT ME!
\r
832 * @return DOCUMENT ME!
\r
834 public int getIndex(int y)
\r
837 int starty = getStartSeq();
\r
838 int endy = getEndSeq();
\r
840 for (int i = starty; i <= endy; i++)
\r
842 if ((i < alignment.getHeight()) &&
\r
843 (alignment.getSequenceAt(i) != null))
\r
845 int y2 = y1 + getCharHeight();
\r
847 if ((y >= y1) && (y <= y2))
\r
866 * @return DOCUMENT ME!
\r
868 public ColumnSelection getColumnSelection()
\r
877 * @param tree DOCUMENT ME!
\r
879 public void setCurrentTree(NJTree tree)
\r
881 currentTree = tree;
\r
887 * @return DOCUMENT ME!
\r
889 public NJTree getCurrentTree()
\r
891 return currentTree;
\r
897 * @param b DOCUMENT ME!
\r
899 public void setColourAppliesToAllGroups(boolean b)
\r
901 colourAppliesToAllGroups = b;
\r
907 * @return DOCUMENT ME!
\r
909 public boolean getColourAppliesToAllGroups()
\r
911 return colourAppliesToAllGroups;
\r
917 * @return DOCUMENT ME!
\r
919 public boolean getShowFullId()
\r
927 * @param b DOCUMENT ME!
\r
929 public void setShowFullId(boolean b)
\r
937 * @return DOCUMENT ME!
\r
939 public boolean getShowAnnotation()
\r
941 return showAnnotation;
\r
947 * @param b DOCUMENT ME!
\r
949 public void setShowAnnotation(boolean b)
\r
951 showAnnotation = b;
\r
957 * @return DOCUMENT ME!
\r
959 public boolean getScaleAboveWrapped()
\r
961 return scaleAboveWrapped;
\r
967 * @return DOCUMENT ME!
\r
969 public boolean getScaleLeftWrapped()
\r
971 return scaleLeftWrapped;
\r
977 * @return DOCUMENT ME!
\r
979 public boolean getScaleRightWrapped()
\r
981 return scaleRightWrapped;
\r
987 * @param b DOCUMENT ME!
\r
989 public void setScaleAboveWrapped(boolean b)
\r
991 scaleAboveWrapped = b;
\r
997 * @param b DOCUMENT ME!
\r
999 public void setScaleLeftWrapped(boolean b)
\r
1001 scaleLeftWrapped = b;
\r
1007 * @param b DOCUMENT ME!
\r
1009 public void setScaleRightWrapped(boolean b)
\r
1011 scaleRightWrapped = b;
\r
1015 * Property change listener for changes in alignment
\r
1017 * @param listener DOCUMENT ME!
\r
1019 public void addPropertyChangeListener(
\r
1020 java.beans.PropertyChangeListener listener)
\r
1022 changeSupport.addPropertyChangeListener(listener);
\r
1028 * @param listener DOCUMENT ME!
\r
1030 public void removePropertyChangeListener(
\r
1031 java.beans.PropertyChangeListener listener)
\r
1033 changeSupport.removePropertyChangeListener(listener);
\r
1037 * Property change listener for changes in alignment
\r
1039 * @param prop DOCUMENT ME!
\r
1040 * @param oldvalue DOCUMENT ME!
\r
1041 * @param newvalue DOCUMENT ME!
\r
1043 public void firePropertyChange(String prop, Object oldvalue, Object newvalue)
\r
1045 changeSupport.firePropertyChange(prop, oldvalue, newvalue);
\r
1048 public void setIgnoreGapsConsensus(boolean b)
\r
1050 ignoreGapsInConsensusCalculation = b;
\r
1051 updateConsensus();
\r
1052 if(globalColourScheme!=null)
\r
1054 globalColourScheme.setThreshold(globalColourScheme.getThreshold(), ignoreGapsInConsensusCalculation);
\r
1059 public boolean getIgnoreGapsConsensus()
\r
1061 return ignoreGapsInConsensusCalculation;
\r