Formatting changes
[jalview.git] / src / jalview / gui / SliderPanel.java
index 1a62fff..c18cc05 100755 (executable)
  */\r
 package jalview.gui;\r
 \r
-import java.util.*;\r
+import jalview.datamodel.*;\r
+\r
+import jalview.jbgui.*;\r
+\r
+import jalview.schemes.*;\r
 \r
 import java.awt.event.*;\r
+\r
+import java.util.*;\r
+\r
 import javax.swing.*;\r
 import javax.swing.event.*;\r
 \r
-import jalview.datamodel.*;\r
-import jalview.jbgui.*;\r
-import jalview.schemes.*;\r
 \r
-public class SliderPanel\r
-    extends GSliderPanel\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class SliderPanel extends GSliderPanel\r
 {\r
-  static JInternalFrame conservationSlider;\r
-  static JInternalFrame PIDSlider;\r
-  AlignmentPanel ap;\r
-  boolean forConservation = true;\r
-  ColourSchemeI cs;\r
-\r
-  public SliderPanel(AlignmentPanel ap, int value, boolean forConserve,\r
-                     ColourSchemeI cs)\r
-  {\r
-    this.ap = ap;\r
-    this.cs = cs;\r
-    forConservation = forConserve;\r
-    undoButton.setVisible(false);\r
-    applyButton.setVisible(false);\r
-\r
-    if (forConservation)\r
-    {\r
-      label.setText("Enter value to increase conservation visibility");\r
-      slider.setMinimum(0);\r
-      slider.setMaximum(50);\r
-    }\r
-    else\r
-    {\r
-      label.setText("Enter % identity above which to colour residues");\r
-      slider.setMinimum(0);\r
-      slider.setMaximum(100);\r
-    }\r
-\r
-    slider.addChangeListener(new ChangeListener()\r
+    static JInternalFrame conservationSlider;\r
+    static JInternalFrame PIDSlider;\r
+    AlignmentPanel ap;\r
+    boolean forConservation = true;\r
+    ColourSchemeI cs;\r
+\r
+    /**\r
+     * Creates a new SliderPanel object.\r
+     *\r
+     * @param ap DOCUMENT ME!\r
+     * @param value DOCUMENT ME!\r
+     * @param forConserve DOCUMENT ME!\r
+     * @param cs DOCUMENT ME!\r
+     */\r
+    public SliderPanel(AlignmentPanel ap, int value, boolean forConserve,\r
+        ColourSchemeI cs)\r
     {\r
-      public void stateChanged(ChangeEvent evt)\r
-      {\r
-        valueField.setText(slider.getValue() + "");\r
-        valueChanged(slider.getValue());\r
-      }\r
-    });\r
-\r
-    slider.setValue(value);\r
-    valueField.setText(value + "");\r
-  }\r
-\r
-  public static int setConservationSlider(AlignmentPanel ap,\r
-                                          ColourSchemeI cs, String source)\r
-  {\r
-    SliderPanel sp = null;\r
-    ConservationColourScheme ccs = (ConservationColourScheme) cs;\r
-\r
-    if (conservationSlider == null)\r
-    {\r
-      sp = new SliderPanel(ap, ccs.inc, true, cs);\r
-      conservationSlider = new JInternalFrame();\r
-      conservationSlider.setContentPane(sp);\r
-      conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
-    }\r
-    else\r
-    {\r
-      sp = (SliderPanel) conservationSlider.getContentPane();\r
-      sp.cs = cs;\r
-    }\r
+        this.ap = ap;\r
+        this.cs = cs;\r
+        forConservation = forConserve;\r
+        undoButton.setVisible(false);\r
+        applyButton.setVisible(false);\r
 \r
-    conservationSlider.setTitle("Conservation Colour Increment  (" +\r
-                                source + ")");\r
+        if (forConservation)\r
+        {\r
+            label.setText("Enter value to increase conservation visibility");\r
+            slider.setMinimum(0);\r
+            slider.setMaximum(50);\r
+        }\r
+        else\r
+        {\r
+            label.setText("Enter % identity above which to colour residues");\r
+            slider.setMinimum(0);\r
+            slider.setMaximum(100);\r
+        }\r
 \r
-    if (ap.av.alignment.getGroups() != null)\r
-    {\r
-      sp.setAllGroupsCheckEnabled(true);\r
+        slider.addChangeListener(new ChangeListener()\r
+            {\r
+                public void stateChanged(ChangeEvent evt)\r
+                {\r
+                    valueField.setText(slider.getValue() + "");\r
+                    valueChanged(slider.getValue());\r
+                }\r
+            });\r
+\r
+        slider.setValue(value);\r
+        valueField.setText(value + "");\r
     }\r
-    else\r
-    {\r
-      sp.setAllGroupsCheckEnabled(false);\r
-    }\r
-\r
-    return sp.getValue();\r
-  }\r
 \r
-  public static void showConservationSlider()\r
-  {\r
-    try\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param ap DOCUMENT ME!\r
+     * @param cs DOCUMENT ME!\r
+     * @param source DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static int setConservationSlider(AlignmentPanel ap,\r
+        ColourSchemeI cs, String source)\r
     {\r
-      PIDSlider.setClosed(true);\r
-      PIDSlider = null;\r
-    }\r
-    catch (Exception ex)\r
-    {\r
-    }\r
+        SliderPanel sp = null;\r
+        ConservationColourScheme ccs = (ConservationColourScheme) cs;\r
 \r
-    if (!conservationSlider.isVisible())\r
-    {\r
-      Desktop.addInternalFrame(conservationSlider,\r
-                               conservationSlider.getTitle(), 420, 90, false);\r
-      conservationSlider.addInternalFrameListener(new javax.swing.event.\r
-                                                  InternalFrameAdapter()\r
-      {\r
-        public void internalFrameClosed(\r
-            javax.swing.event.InternalFrameEvent e)\r
+        if (conservationSlider == null)\r
         {\r
-          conservationSlider = null;\r
+            sp = new SliderPanel(ap, ccs.inc, true, cs);\r
+            conservationSlider = new JInternalFrame();\r
+            conservationSlider.setContentPane(sp);\r
+            conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
+        }\r
+        else\r
+        {\r
+            sp = (SliderPanel) conservationSlider.getContentPane();\r
+            sp.cs = cs;\r
         }\r
-      });\r
-      conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
-    }\r
-  }\r
 \r
-  public static int setPIDSliderSource(AlignmentPanel ap, ColourSchemeI cs,\r
-                                       String source)\r
-  {\r
-    SliderPanel pid = null;\r
+        conservationSlider.setTitle("Conservation Colour Increment  (" +\r
+            source + ")");\r
 \r
-    int threshold = 50;\r
+        if (ap.av.alignment.getGroups() != null)\r
+        {\r
+            sp.setAllGroupsCheckEnabled(true);\r
+        }\r
+        else\r
+        {\r
+            sp.setAllGroupsCheckEnabled(false);\r
+        }\r
 \r
-    if (cs instanceof ResidueColourScheme)\r
-    {\r
-      threshold = ( ( (ResidueColourScheme) cs).getThreshold());\r
-    }\r
-    else if (cs instanceof ScoreColourScheme)\r
-    {\r
-      threshold = ( ( (ScoreColourScheme) cs).getThreshold());\r
+        return sp.getValue();\r
     }\r
 \r
-    if (PIDSlider == null)\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    public static void showConservationSlider()\r
     {\r
-      pid = new SliderPanel(ap, threshold, false, cs);\r
-      PIDSlider = new JInternalFrame();\r
-      PIDSlider.setContentPane(pid);\r
-      PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
+        try\r
+        {\r
+            PIDSlider.setClosed(true);\r
+            PIDSlider = null;\r
+        }\r
+        catch (Exception ex)\r
+        {\r
+        }\r
+\r
+        if (!conservationSlider.isVisible())\r
+        {\r
+            Desktop.addInternalFrame(conservationSlider,\r
+                conservationSlider.getTitle(), 420, 90, false);\r
+            conservationSlider.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()\r
+                {\r
+                    public void internalFrameClosed(\r
+                        javax.swing.event.InternalFrameEvent e)\r
+                    {\r
+                        conservationSlider = null;\r
+                    }\r
+                });\r
+            conservationSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
+        }\r
     }\r
-    else\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param ap DOCUMENT ME!\r
+     * @param cs DOCUMENT ME!\r
+     * @param source DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public static int setPIDSliderSource(AlignmentPanel ap, ColourSchemeI cs,\r
+        String source)\r
     {\r
-      pid = (SliderPanel) PIDSlider.getContentPane();\r
-      pid.cs = cs;\r
-    }\r
+        SliderPanel pid = null;\r
 \r
-    PIDSlider.setTitle("Percentage Identity Threshold (" + source + ")");\r
+        int threshold = 50;\r
 \r
-    if (ap.av.alignment.getGroups() != null)\r
-    {\r
-      pid.setAllGroupsCheckEnabled(true);\r
-    }\r
-    else\r
-    {\r
-      pid.setAllGroupsCheckEnabled(false);\r
-    }\r
+        if (cs instanceof ResidueColourScheme)\r
+        {\r
+            threshold = (((ResidueColourScheme) cs).getThreshold());\r
+        }\r
+        else if (cs instanceof ScoreColourScheme)\r
+        {\r
+            threshold = (((ScoreColourScheme) cs).getThreshold());\r
+        }\r
 \r
-    return pid.getValue();\r
-  }\r
+        if (PIDSlider == null)\r
+        {\r
+            pid = new SliderPanel(ap, threshold, false, cs);\r
+            PIDSlider = new JInternalFrame();\r
+            PIDSlider.setContentPane(pid);\r
+            PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
+        }\r
+        else\r
+        {\r
+            pid = (SliderPanel) PIDSlider.getContentPane();\r
+            pid.cs = cs;\r
+        }\r
 \r
-  public static void showPIDSlider()\r
-  {\r
-    try\r
-    {\r
-      conservationSlider.setClosed(true);\r
-      conservationSlider = null;\r
-    }\r
-    catch (Exception ex)\r
-    {\r
+        PIDSlider.setTitle("Percentage Identity Threshold (" + source + ")");\r
+\r
+        if (ap.av.alignment.getGroups() != null)\r
+        {\r
+            pid.setAllGroupsCheckEnabled(true);\r
+        }\r
+        else\r
+        {\r
+            pid.setAllGroupsCheckEnabled(false);\r
+        }\r
+\r
+        return pid.getValue();\r
     }\r
 \r
-    if (!PIDSlider.isVisible())\r
+    /**\r
+     * DOCUMENT ME!\r
+     */\r
+    public static void showPIDSlider()\r
     {\r
-      Desktop.addInternalFrame(PIDSlider, PIDSlider.getTitle(), 420, 90,\r
-                               false);\r
-      PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
-      PIDSlider.addInternalFrameListener(new javax.swing.event.\r
-                                         InternalFrameAdapter()\r
-      {\r
-        public void internalFrameClosed(\r
-            javax.swing.event.InternalFrameEvent e)\r
+        try\r
         {\r
-          PIDSlider = null;\r
+            conservationSlider.setClosed(true);\r
+            conservationSlider = null;\r
+        }\r
+        catch (Exception ex)\r
+        {\r
+        }\r
+\r
+        if (!PIDSlider.isVisible())\r
+        {\r
+            Desktop.addInternalFrame(PIDSlider, PIDSlider.getTitle(), 420, 90,\r
+                false);\r
+            PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
+            PIDSlider.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()\r
+                {\r
+                    public void internalFrameClosed(\r
+                        javax.swing.event.InternalFrameEvent e)\r
+                    {\r
+                        PIDSlider = null;\r
+                    }\r
+                });\r
+            PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
         }\r
-      });\r
-      PIDSlider.setLayer(JLayeredPane.PALETTE_LAYER);\r
     }\r
-  }\r
 \r
-  public void valueChanged(int i)\r
-  {\r
-    if (cs == null)\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param i DOCUMENT ME!\r
+     */\r
+    public void valueChanged(int i)\r
     {\r
-      return;\r
-    }\r
+        if (cs == null)\r
+        {\r
+            return;\r
+        }\r
 \r
-    ColourSchemeI toChange = null;\r
-    Vector allGroups = null;\r
-    int groupIndex = 0;\r
+        ColourSchemeI toChange = null;\r
+        Vector allGroups = null;\r
+        int groupIndex = 0;\r
 \r
-    if (allGroupsCheck.isSelected())\r
-    {\r
-      allGroups = ap.av.alignment.getGroups();\r
-      groupIndex = allGroups.size() - 1;\r
+        if (allGroupsCheck.isSelected())\r
+        {\r
+            allGroups = ap.av.alignment.getGroups();\r
+            groupIndex = allGroups.size() - 1;\r
+        }\r
+        else\r
+        {\r
+            toChange = cs;\r
+        }\r
+\r
+        while (groupIndex > -1)\r
+        {\r
+            if (allGroups != null)\r
+            {\r
+                toChange = ((SequenceGroup) allGroups.get(groupIndex)).cs;\r
+\r
+                if (toChange == null)\r
+                {\r
+                    groupIndex--;\r
+\r
+                    continue;\r
+                }\r
+            }\r
+\r
+            if (forConservation)\r
+            {\r
+                if (toChange instanceof ConservationColourScheme)\r
+                {\r
+                    ((ConservationColourScheme) toChange).inc = i;\r
+                }\r
+            }\r
+            else\r
+            {\r
+                ((ResidueColourScheme) toChange).setThreshold(i);\r
+            }\r
+\r
+            groupIndex--;\r
+        }\r
+\r
+        ap.seqPanel.seqCanvas.repaint();\r
     }\r
-    else\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param b DOCUMENT ME!\r
+     */\r
+    public void setAllGroupsCheckEnabled(boolean b)\r
     {\r
-      toChange = cs;\r
+        allGroupsCheck.setEnabled(b);\r
     }\r
 \r
-    while (groupIndex > -1)\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void valueField_actionPerformed(ActionEvent e)\r
     {\r
-      if (allGroups != null)\r
-      {\r
-        toChange = ( (SequenceGroup) allGroups.get(groupIndex)).cs;\r
-        if(toChange==null)\r
+        try\r
         {\r
-          groupIndex--;\r
-          continue;\r
+            int i = Integer.parseInt(valueField.getText());\r
+            slider.setValue(i);\r
         }\r
-      }\r
-\r
-      if (forConservation)\r
-      {\r
-        if (toChange instanceof ConservationColourScheme)\r
+        catch (Exception ex)\r
         {\r
-          ( (ConservationColourScheme) toChange).inc = i;\r
+            valueField.setText(slider.getValue() + "");\r
         }\r
-      }\r
-      else\r
-      {\r
-        ( (ResidueColourScheme) toChange).setThreshold(i);\r
-      }\r
-\r
-      groupIndex--;\r
     }\r
 \r
-    ap.seqPanel.seqCanvas.repaint();\r
-  }\r
-\r
-  public void setAllGroupsCheckEnabled(boolean b)\r
-  {\r
-    allGroupsCheck.setEnabled(b);\r
-  }\r
-\r
-  public void valueField_actionPerformed(ActionEvent e)\r
-  {\r
-    try\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param value DOCUMENT ME!\r
+     */\r
+    public void setValue(int value)\r
     {\r
-      int i = Integer.parseInt(valueField.getText());\r
-      slider.setValue(i);\r
+        slider.setValue(value);\r
     }\r
-    catch (Exception ex)\r
+\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getValue()\r
     {\r
-      valueField.setText(slider.getValue() + "");\r
+        return Integer.parseInt(valueField.getText());\r
     }\r
-  }\r
-\r
-  public void setValue(int value)\r
-  {\r
-    slider.setValue(value);\r
-  }\r
-\r
-  public int getValue()\r
-  {\r
-    return Integer.parseInt(valueField.getText());\r
-  }\r
 }\r