1.2ish awt methods
[jalview.git] / src / jalview / appletgui / AlignmentPanel.java
index 874b552..5373894 100755 (executable)
@@ -1,25 +1,26 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
+ * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.appletgui;
 
 import java.awt.*;
 import java.awt.event.*;
+import java.util.Hashtable;
+import java.util.Vector;
 
 import jalview.datamodel.*;
 
@@ -63,9 +64,15 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     idPanel = new IdPanel(av, this);
     scalePanel = new ScalePanel(av, this);
     idwidthAdjuster = new IdwidthAdjuster(this);
+//    annotationScroller = new ScrollPane();
+ //   annotationScroller.setBackground(Color.white);
     annotationPanel = new AnnotationPanel(this);
-
-    sequenceHolderPanel.add(annotationPanel, BorderLayout.SOUTH);
+    annotationPanelHolder.add(annotationPanel, BorderLayout.CENTER);
+    // annotationScroller.setPreferredSize(new Dimension(10,80));
+//    annotationScroller.add(annotationPanel);
+//    annotationScroller.getInsets().set(0,0,0,0);
+    
+    sequenceHolderPanel.add(annotationPanelHolder, BorderLayout.SOUTH);
 
     alabels = new AnnotationLabels(this);
 
@@ -76,10 +83,11 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     annotationSpaceFillerHolder.add(alabels, BorderLayout.CENTER);
     scalePanelHolder.add(scalePanel, BorderLayout.CENTER);
     seqPanelHolder.add(seqPanel, BorderLayout.CENTER);
-
+    
     fontChanged();
     setScrollValues(0, 0);
 
+    apvscroll.addAdjustmentListener(this);
     hscroll.addAdjustmentListener(this);
     vscroll.addAdjustmentListener(this);
 
@@ -101,7 +109,6 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     annotationSpaceFillerHolder.setSize(d.width,
             annotationPanel.getSize().height);
     alabels.setSize(d.width, annotationPanel.getSize().height);
-
     final AlignmentPanel ap = this;
     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
     {
@@ -153,7 +160,7 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
             + fm.getDescent()));
     av.updateSequenceIdColours();
     annotationPanel.image = null;
-    int ap = annotationPanel.adjustPanelHeight();
+    int ap = annotationPanel.adjustPanelHeight(false);
     annotationPanel.repaint();
     Dimension d = calculateIdWidth();
     d.setSize(d.width + 4, seqPanel.seqCanvas.getSize().height);
@@ -225,40 +232,76 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     return new Dimension(idWidth, idPanel.idCanvas.getSize().height);
   }
 
+  /**
+   * Highlight the given results on the alignment.
+   * 
+   */
   public void highlightSearchResults(SearchResults results)
   {
+    scrollToPosition(results);
     seqPanel.seqCanvas.highlightSearchResults(results);
   }
+
+  /**
+   * scroll the view to show the position of the highlighted region in results
+   * (if any) and redraw the overview
+   * 
+   * @param results
+   * @return false if results were not found
+   */
+  public boolean scrollToPosition(SearchResults results)
+  {
+    return scrollToPosition(results, true);
+  }
+
   /**
-   * scroll the view to show the position of the highlighted
-   * region in results (if any)
+   * scroll the view to show the position of the highlighted region in results
+   * (if any)
+   * 
    * @param results
+   * @param redrawOverview
+   *          - when set, the overview will be recalculated (takes longer)
+   * @return false if results were not found
    */
-  public void scrollToPosition(SearchResults results)
+  public boolean scrollToPosition(SearchResults results,
+          boolean redrawOverview)
   {
     // do we need to scroll the panel?
-    if (results != null && results.getSize()>0)
+    if (results != null && results.getSize() > 0)
     {
       int seqIndex = av.alignment.findIndex(results);
-      if (seqIndex==-1)
+      if (seqIndex == -1)
       {
-        return;
+        return false;
       }
       SequenceI seq = av.alignment.getSequenceAt(seqIndex);
-      int [] r = results.getResults(seq, seq.getStart(), seq.getEnd());
-      if (r==null)
+      int[] r = results.getResults(seq, seq.getStart(), seq.getEnd());
+      if (r == null)
       {
-        return;
+        return false;
       }
       int start = r[0];
       int end = r[1];
-      if (start<0)
+      if (start < 0)
       {
-        return;
+        return false;
       }
-      if (end==seq.getEnd())
+      if (end == seq.getEnd())
+      {
+        return false;
+      }
+      if (av.hasHiddenColumns)
       {
-        return;
+        start = av.getColumnSelection().findColumnPosition(start);
+        end = av.getColumnSelection().findColumnPosition(end);
+        if (start == end)
+        {
+          if (!av.colSel.isVisible(r[0]))
+          {
+            // don't scroll - position isn't visible
+            return false;
+          }
+        }
       }
       if (!av.wrapAlignment)
       {
@@ -290,8 +333,12 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
         scrollToWrappedVisible(start);
       }
     }
-
-    repaint();
+    if (redrawOverview && overviewPanel != null)
+    {
+      overviewPanel.setBoxPosition();
+    }
+    paintAlignment(redrawOverview);
+    return true;
   }
 
   void scrollToWrappedVisible(int res)
@@ -417,8 +464,7 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     }
 
     av.setStartRes(x);
-    av
-            .setEndRes((x + (seqPanel.seqCanvas.getSize().width / av.charWidth)) - 1);
+    av.setEndRes((x + (seqPanel.seqCanvas.getSize().width / av.charWidth)) - 1);
 
     hextent = seqPanel.seqCanvas.getSize().width / av.charWidth;
     vextent = seqPanel.seqCanvas.getSize().height / av.charHeight;
@@ -477,6 +523,15 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     int oldX = av.getStartRes();
     int oldY = av.getStartSeq();
 
+    if (evt == null || evt.getSource()==apvscroll)
+    {
+      annotationPanel.setScrollOffset(apvscroll.getValue());
+      alabels.setScrollOffset(apvscroll.getValue());
+      //annotationPanel.image=null;
+      //alabels.image=null;
+      //alabels.repaint();
+      //annotationPanel.repaint();
+    }
     if (evt == null || evt.getSource() == hscroll)
     {
       int x = hscroll.getValue();
@@ -566,10 +621,11 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     invalidate();
     Dimension d = idPanel.idCanvas.getSize();
     idPanel.idCanvas.setSize(d.width, seqPanel.seqCanvas.getSize().height);
+    annotationPanelHolder.setSize(seqPanel.getSize().width, annotationPanel.getSize().height);
     annotationSpaceFillerHolder.setSize(d.width,
             annotationPanel.getSize().height);
 
-    alabels.setSize(d.width, annotationPanel.getSize().height);
+    alabels.setSize(d.width, annotationPanelHolder.getSize().height);
 
     if (av.getWrapAlignment())
     {
@@ -586,7 +642,7 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
       if (canvasWidth > 0)
       {
         int max = maxwidth / canvasWidth;
-        vscroll.setMaximum(max);
+        vscroll.setMaximum(1+max);
         vscroll.setUnitIncrement(1);
         vscroll.setVisibleAmount(1);
       }
@@ -642,6 +698,11 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
 
   BorderLayout borderLayout2 = new BorderLayout();
 
+  Panel annotationPanelHolder = new Panel();
+  protected Scrollbar apvscroll=new Scrollbar();
+
+  BorderLayout borderLayout12 = new BorderLayout();
+
   private void jbInit() throws Exception
   {
     // idPanelHolder.setPreferredSize(new Dimension(70, 10));
@@ -666,7 +727,13 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     hscroll.setOrientation(Scrollbar.HORIZONTAL);
     hscrollHolder.setLayout(borderLayout10);
     hscrollFillerPanel.setBackground(Color.white);
+    apvscroll.setOrientation(Scrollbar.VERTICAL);
+    apvscroll.setVisible(true);
+    apvscroll.addAdjustmentListener(this);
 
+    annotationPanelHolder.setBackground(Color.white);
+    annotationPanelHolder.setLayout(borderLayout12);
+    annotationPanelHolder.add(apvscroll, BorderLayout.EAST);
     // hscrollFillerPanel.setPreferredSize(new Dimension(70, 10));
     hscrollHolder.setBackground(Color.white);
 
@@ -688,4 +755,120 @@ public class AlignmentPanel extends Panel implements AdjustmentListener
     this.add(sequenceHolderPanel, BorderLayout.CENTER);
   }
 
+  /**
+   * hides or shows dynamic annotation rows based on groups and av state flags
+   */
+  public void updateAnnotation()
+  {
+    updateAnnotation(false);
+  }
+
+  public void updateAnnotation(boolean applyGlobalSettings)
+  {
+    // TODO: this should be merged with other annotation update stuff - that
+    // sits on AlignViewport
+    boolean updateCalcs = false;
+    boolean conv = av.isShowGroupConservation();
+    boolean cons = av.isShowGroupConsensus();
+    boolean showprf = av.isShowSequenceLogo();
+    boolean showConsHist = av.isShowConsensusHistogram();
+
+    boolean sortg = true;
+
+    // remove old automatic annotation
+    // add any new annotation
+
+    Vector gr = av.alignment.getGroups(); // OrderedBy(av.alignment.getSequencesArray());
+    // intersect alignment annotation with alignment groups
+
+    AlignmentAnnotation[] aan = av.alignment.getAlignmentAnnotation();
+    Hashtable oldrfs = new Hashtable();
+    if (aan != null)
+    {
+      for (int an = 0; an < aan.length; an++)
+      {
+        if (aan[an].autoCalculated && aan[an].groupRef != null)
+        {
+          oldrfs.put(aan[an].groupRef, aan[an].groupRef);
+          av.alignment.deleteAnnotation(aan[an]);
+          aan[an] = null;
+        }
+      }
+    }
+    SequenceGroup sg;
+    if (gr != null)
+    {
+      for (int g = 0; g < gr.size(); g++)
+      {
+        updateCalcs = false;
+        sg = (SequenceGroup) gr.elementAt(g);
+        if (applyGlobalSettings || !oldrfs.containsKey(sg))
+        {
+          // set defaults for this group's conservation/consensus
+          sg.setshowSequenceLogo(showprf);
+          sg.setShowConsensusHistogram(showConsHist);
+        }
+        if (conv)
+        {
+          updateCalcs = true;
+          av.alignment.addAnnotation(sg.getConservationRow(), 0);
+        }
+        if (cons)
+        {
+          updateCalcs = true;
+          av.alignment.addAnnotation(sg.getConsensus(), 0);
+        }
+        // refresh the annotation rows
+        if (updateCalcs)
+        {
+          sg.recalcConservation();
+        }
+      }
+    }
+    oldrfs.clear();
+    adjustAnnotationHeight();
+  }
+  /**
+   * automatically adjust annotation panel height for new annotation
+   * whilst ensuring the alignment is still visible.
+   */
+  public void adjustAnnotationHeight()
+  {
+    // TODO: display vertical annotation scrollbar if necessary
+    // this is called after loading new annotation onto alignment
+    if (alignFrame.getSize().height == 0)
+    {
+      System.out.println("NEEDS FIXING");
+    }
+    fontChanged();
+    int height = annotationPanel.adjustPanelHeight();
+    if (hscroll.isVisible())
+    {
+      height += hscroll.getPreferredSize().height;
+    }
+    int mheight=height;
+    // sets initial preferred height
+    if (height > alignFrame.getSize().height/ 2)
+    {
+      height = alignFrame.getSize().height / 2;
+    }
+    apvscroll.setValues(apvscroll.getValue(), height, 0, mheight);
+    annotationPanel.setScrollOffset(apvscroll.getValue());
+    alabels.setScrollOffset(apvscroll.getValue());
+    apvscroll.addNotify();
+    hscroll.addNotify();
+
+    annotationPanelHolder.setSize(new Dimension(annotationPanel
+            .getSize().width, height));
+
+    annotationSpaceFillerHolder.setSize(new Dimension(
+            annotationSpaceFillerHolder.getSize().width
+            , height));
+    
+    //annotationScroller.validate();// repaint();
+    validate();
+    addNotify();
+    repaint();
+  }
+
 }