formatting
[jalview.git] / src / jalview / viewmodel / AlignmentViewport.java
index a53a68c..f37e2bd 100644 (file)
@@ -49,9 +49,9 @@ import java.util.Vector;
 /**
  * base class holding visualization and analysis attributes and common logic for
  * an active alignment view displayed in the GUI
- *
+ * 
  * @author jimp
- *
+ * 
  */
 public abstract class AlignmentViewport implements AlignViewportI
 {
@@ -96,8 +96,8 @@ public abstract class AlignmentViewport implements AlignViewportI
   }
 
   /**
-   *
-   *
+   * 
+   * 
    * @return flag indicating if colourchanges propagated to all groups
    */
   public boolean getColourAppliesToAllGroups()
@@ -109,7 +109,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * GUI state
-   *
+   * 
    * @return true if percent identity threshold is applied to shading
    */
   public boolean getAbovePIDThreshold()
@@ -119,8 +119,8 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * GUI state
-   *
-   *
+   * 
+   * 
    * @param b
    *          indicate if percent identity threshold is applied to shading
    */
@@ -133,7 +133,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @param thresh
    *          DOCUMENT ME!
    */
@@ -144,7 +144,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @return DOCUMENT ME!
    */
   public int getThreshold()
@@ -155,7 +155,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   int increment;
 
   /**
-   *
+   * 
    * @param inc
    *          set the scalar for bleaching colourschemes according to degree of
    *          conservation
@@ -167,7 +167,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * GUI State
-   *
+   * 
    * @return get scalar for bleaching colourschemes by conservation
    */
   public int getIncrement()
@@ -179,7 +179,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * GUI state
-   *
+   * 
    * @return true if conservation based shading is enabled
    */
   public boolean getConservationSelected()
@@ -189,7 +189,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * GUI state
-   *
+   * 
    * @param b
    *          enable conservation based shading
    */
@@ -373,7 +373,7 @@ public abstract class AlignmentViewport implements AlignViewportI
       return;
     }
     if (calculator
-            .getRegisteredWorkersOfClass(jalview.workers.ConservationThread.class)==null)
+            .getRegisteredWorkersOfClass(jalview.workers.ConservationThread.class) == null)
     {
       calculator.registerWorker(new jalview.workers.ConservationThread(
               this, ap));
@@ -390,7 +390,7 @@ public abstract class AlignmentViewport implements AlignViewportI
     {
       return;
     }
-    if (calculator.getRegisteredWorkersOfClass(ConsensusThread.class)==null)
+    if (calculator.getRegisteredWorkersOfClass(ConsensusThread.class) == null)
     {
       calculator.registerWorker(new ConsensusThread(this, ap));
     }
@@ -410,8 +410,7 @@ public abstract class AlignmentViewport implements AlignViewportI
     {
       return;
     }
-    if (calculator
-            .getRegisteredWorkersOfClass(StrucConsensusThread.class)==null)
+    if (calculator.getRegisteredWorkersOfClass(StrucConsensusThread.class) == null)
     {
       calculator.registerWorker(new StrucConsensusThread(this, ap));
     }
@@ -545,7 +544,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   }
 
   /**
-   *
+   * 
    * @return flag to indicate if the consensus histogram should be rendered by
    *         default
    */
@@ -590,8 +589,8 @@ public abstract class AlignmentViewport implements AlignViewportI
   }
 
   /**
-   *
-   *
+   * 
+   * 
    * @return null or the currently selected sequence region
    */
   public SequenceGroup getSelectionGroup()
@@ -601,10 +600,10 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * Set the selection group for this window.
-   *
+   * 
    * @param sg
    *          - group holding references to sequences in this alignment view
-   *
+   * 
    */
   public void setSelectionGroup(SequenceGroup sg)
   {
@@ -632,7 +631,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   }
 
   /**
-   *
+   * 
    * @return
    */
   @Override
@@ -686,7 +685,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * unique viewId for synchronizing state (e.g. with stored Jalview Project)
-   *
+   * 
    */
   protected String viewId = null;
 
@@ -719,10 +718,10 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * checks current SelectionGroup against record of last hash value, and
    * updates record.
-   *
+   * 
    * @param b
    *          update the record of last hash value
-   *
+   * 
    * @return true if SelectionGroup changed since last call (when b is true)
    */
   public boolean isSelectionGroupChanged(boolean b)
@@ -743,7 +742,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * checks current colsel against record of last hash value, and optionally
    * updates record.
-   *
+   * 
    * @param b
    *          update the record of last hash value
    * @return true if colsel changed since last call (when b is true)
@@ -783,7 +782,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * Property change listener for changes in alignment
-   *
+   * 
    * @param listener
    *          DOCUMENT ME!
    */
@@ -795,7 +794,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @param listener
    *          DOCUMENT ME!
    */
@@ -807,7 +806,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * Property change listener for changes in alignment
-   *
+   * 
    * @param prop
    *          DOCUMENT ME!
    * @param oldvalue
@@ -1015,7 +1014,7 @@ public abstract class AlignmentViewport implements AlignViewportI
    * This method returns an array of new SequenceI objects derived from the
    * whole alignment or just the current selection with start and end points
    * adjusted
-   *
+   * 
    * @note if you need references to the actual SequenceI objects in the
    *       alignment or currently selected then use getSequenceSelection()
    * @return selection as new sequenceI objects
@@ -1028,7 +1027,7 @@ public abstract class AlignmentViewport implements AlignViewportI
     // JBPNote: in applet, this method returned references to the alignment
     // sequences, and it did not honour the presence/absence of annotation
     // attached to the alignment (probably!)
-    if (selectionGroup == null || selectionGroup.getSize()==0)
+    if (selectionGroup == null || selectionGroup.getSize() == 0)
     {
       sequences = alignment.getSequencesArray();
       AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
@@ -1051,7 +1050,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * get the currently selected sequence objects or all the sequences in the
    * alignment.
-   *
+   * 
    * @return array of references to sequence objects
    */
   public SequenceI[] getSequenceSelection()
@@ -1073,7 +1072,7 @@ public abstract class AlignmentViewport implements AlignViewportI
    * if columns are hidden they will not be returned in the result. Use this for
    * calculating trees, PCA, redundancy etc on views which contain hidden
    * columns.
-   *
+   * 
    * @return String[]
    */
   public jalview.datamodel.CigarArray getViewAsCigars(
@@ -1087,7 +1086,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * return a compact representation of the current alignment selection to pass
    * to an analysis function
-   *
+   * 
    * @param selectedOnly
    *          boolean true to just return the selected view
    * @return AlignmentView
@@ -1101,7 +1100,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * return a compact representation of the current alignment selection to pass
    * to an analysis function
-   *
+   * 
    * @param selectedOnly
    *          boolean true to just return the selected view
    * @param markGroups
@@ -1122,7 +1121,7 @@ public abstract class AlignmentViewport implements AlignViewportI
    * if columns are hidden they will not be returned in the result. Use this for
    * calculating trees, PCA, redundancy etc on views which contain hidden
    * columns.
-   *
+   * 
    * @return String[]
    */
   public String[] getViewAsString(boolean selectedRegionOnly)
@@ -1163,7 +1162,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /**
    * return visible region boundaries within given column range
-   *
+   * 
    * @param min
    *          first column (inclusive, from 0)
    * @param max
@@ -1234,7 +1233,7 @@ public abstract class AlignmentViewport implements AlignViewportI
   /**
    * apply any post-edit constraints and trigger any calculations needed after
    * an edit has been performed on the alignment
-   *
+   * 
    * @param ap
    */
   public void alignmentChanged(AlignmentViewPanel ap)
@@ -1377,6 +1376,7 @@ public abstract class AlignmentViewport implements AlignViewportI
 
   /*
    * (non-Javadoc)
+   * 
    * @see jalview.api.AlignViewportI#calcPanelHeight()
    */
   public int calcPanelHeight()
@@ -1384,7 +1384,7 @@ public abstract class AlignmentViewport implements AlignViewportI
     // setHeight of panels
     AlignmentAnnotation[] aa = getAlignment().getAlignmentAnnotation();
     int height = 0;
-    int charHeight=getCharHeight();
+    int charHeight = getCharHeight();
     if (aa != null)
     {
       boolean graphgrp[] = null;
@@ -1415,27 +1415,27 @@ public abstract class AlignmentViewport implements AlignViewportI
           }
         }
         aa[i].height = 0;
-  
+
         if (aa[i].hasText)
         {
           aa[i].height += charHeight;
         }
-  
+
         if (aa[i].hasIcons)
         {
           aa[i].height += 16;
         }
-  
+
         if (aa[i].graph > 0)
         {
           aa[i].height += aa[i].graphHeight;
         }
-  
+
         if (aa[i].height == 0)
         {
           aa[i].height = 20;
         }
-  
+
         height += aa[i].height;
       }
     }
@@ -1459,7 +1459,8 @@ public abstract class AlignmentViewport implements AlignViewportI
     boolean normLogo = isNormaliseSequenceLogo();
 
     /**
-     * TODO reorder the annotation rows according to group/sequence ordering on alignment
+     * TODO reorder the annotation rows according to group/sequence ordering on
+     * alignment
      */
     boolean sortg = true;