javatidy
[jalview.git] / src / jalview / appletgui / AlignFrame.java
index 5a199bb..4948613 100644 (file)
@@ -1,18 +1,18 @@
 /*\r
  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle\r
- * \r
+ *\r
  * This file is part of Jalview.\r
- * \r
+ *\r
  * Jalview is free software: you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License \r
+ * modify it under the terms of the GNU General Public License\r
  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
- * \r
- * Jalview is distributed in the hope that it will be useful, but \r
- * WITHOUT ANY WARRANTY; without even the implied warranty \r
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
+ *\r
+ * Jalview is distributed in the hope that it will be useful, but\r
+ * WITHOUT ANY WARRANTY; without even the implied warranty\r
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR\r
  * PURPOSE.  See the GNU General Public License for more details.\r
- * \r
+ *\r
  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  */\r
 package jalview.appletgui;\r
@@ -103,7 +103,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   int DEFAULT_HEIGHT = 500;\r
 \r
   String jalviewServletURL;\r
-  \r
+\r
 \r
   public AlignFrame(AlignmentI al, jalview.bin.JalviewLite applet, String title, boolean embedded)\r
   {\r
@@ -233,7 +233,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * Load a features file onto the alignment\r
-   * \r
+   *\r
    * @param file file URL, content, or other resolvable path\r
    * @param type is protocol for accessing data referred to by file\r
    */\r
@@ -242,19 +242,19 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   {\r
     return parseFeaturesFile(file, type, true);\r
   }\r
-  \r
+\r
   /**\r
    * Load a features file onto the alignment\r
-   * \r
+   *\r
    * @param file file URL, content, or other resolvable path\r
    * @param type is protocol for accessing data referred to by file\r
    * @param autoenabledisplay when true, display features flag will be automatically enabled if features are loaded\r
    * @return true if data parsed as a features file\r
    */\r
   public boolean parseFeaturesFile(String file, String type, boolean autoenabledisplay)\r
-  {    \r
+  {\r
     // TODO: test if importing a features file onto an alignment which already has features with links overwrites the original links.\r
-    \r
+\r
     Hashtable featureLinks = new Hashtable();\r
     boolean featuresFile = false;\r
     try\r
@@ -289,6 +289,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     return featuresFile;\r
   }\r
 \r
+  @Override\r
   public void keyPressed(KeyEvent evt)\r
   {\r
     if (viewport.cursorMode\r
@@ -302,8 +303,8 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     {\r
     case 27: // escape key\r
       deselectAllSequenceMenuItem_actionPerformed();\r
-      \r
-      alignPanel.alabels.cancelDrag(); \r
+\r
+      alignPanel.alabels.cancelDrag();\r
       break;\r
     case KeyEvent.VK_X:\r
       if (evt.isControlDown() || evt.isMetaDown())\r
@@ -550,7 +551,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * called by key handler and the hide all/show all menu items\r
-   * \r
+   *\r
    * @param toggleSeqs\r
    * @param toggleCols\r
    */\r
@@ -615,14 +616,17 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     }\r
   }\r
 \r
+  @Override\r
   public void keyReleased(KeyEvent evt)\r
   {\r
   }\r
 \r
+  @Override\r
   public void keyTyped(KeyEvent evt)\r
   {\r
   }\r
 \r
+  @Override\r
   public void itemStateChanged(ItemEvent evt)\r
   {\r
     if (evt.getSource() == displayNonconservedMenuItem)\r
@@ -739,6 +743,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     this.alignPanel.annotationPanel.repaint();\r
   }\r
 \r
+  @Override\r
   public void actionPerformed(ActionEvent evt)\r
   {\r
     Object source = evt.getSource();\r
@@ -1112,7 +1117,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     jalview.bin.JalviewLite.addFrame(frame, "Paste Annotations ", 400, 300);\r
 \r
   }\r
-  \r
+\r
   public String outputAnnotations(boolean displayTextbox)\r
   {\r
     String annotation = new AnnotationFile().printAnnotations(\r
@@ -1174,7 +1179,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
         features = "# No features visible - paste some and import them here.";\r
         frimport=true;\r
       }\r
-      \r
+\r
       CutAndPasteTransfer cap = new CutAndPasteTransfer(frimport, this);\r
       if (frimport)\r
       {\r
@@ -1353,7 +1358,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   /**\r
    * TODO: JAL-1104\r
    * DOCUMENT ME!\r
-   * \r
+   *\r
    * @param e\r
    *          DOCUMENT ME!\r
    */\r
@@ -1382,7 +1387,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   /**\r
    * TODO: JAL-1104\r
    * DOCUMENT ME!\r
-   * \r
+   *\r
    * @param e\r
    *          DOCUMENT ME!\r
    */\r
@@ -1494,7 +1499,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
     SequenceI[] seqs2 = invertGroup.toArray(new SequenceI[invertGroup.size()]);\r
     for (int i = 0; i < invertGroup.size(); i++)\r
-      seqs2[i] = (SequenceI) invertGroup.elementAt(i);\r
+      seqs2[i] = invertGroup.elementAt(i);\r
 \r
     SlideSequencesCommand ssc;\r
     if (right)\r
@@ -1786,7 +1791,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * group consensus toggled\r
-   * \r
+   *\r
    */\r
   protected void showGroupConsensus_actionPerformed()\r
   {\r
@@ -1806,7 +1811,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /*\r
    * (non-Javadoc)\r
-   * \r
+   *\r
    * @see\r
    * jalview.jbgui.GAlignFrame#showConsensusHistogram_actionPerformed(java.awt\r
    * .event.ActionEvent)\r
@@ -1818,7 +1823,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   }\r
   /*\r
    * (non-Javadoc)\r
-   * \r
+   *\r
    * @see\r
    * jalview.jbgui.GAlignFrame#showConsensusProfile_actionPerformed(java.awt\r
    * .event.ActionEvent)\r
@@ -2069,7 +2074,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * create a new view derived from the current view\r
-   * \r
+   *\r
    * @param viewtitle\r
    * @return frame for the new view\r
    */\r
@@ -2142,7 +2147,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   }\r
 \r
   /**\r
-   * \r
+   *\r
    * @return list of feature groups on the view\r
    */\r
   public String[] getFeatureGroups()\r
@@ -2158,7 +2163,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * get sequence feature groups that are hidden or shown\r
-   * \r
+   *\r
    * @param visible\r
    *          true is visible\r
    * @return list\r
@@ -2176,7 +2181,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * Change the display state for the given feature groups\r
-   * \r
+   *\r
    * @param groups\r
    *          list of group strings\r
    * @param state\r
@@ -2247,6 +2252,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     final AlignmentPanel ap=alignPanel;\r
     frame.addWindowListener(new WindowAdapter()\r
     {\r
+      @Override\r
       public void windowClosing(WindowEvent e)\r
       {\r
         if (ap!=null) {\r
@@ -2303,7 +2309,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
       cs.setConsensus(viewport.getSequenceConsensusHash());\r
 \r
-    }             \r
+    }\r
     viewport.setGlobalColourScheme(cs);\r
 \r
 \r
@@ -2530,7 +2536,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * sort the alignment using the given treePanel\r
-   * \r
+   *\r
    * @param treePanel\r
    *          tree used to sort view\r
    * @param title\r
@@ -2551,7 +2557,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   /**\r
    * Do any automatic reordering of the alignment and add the necessary bits to\r
    * the menu structure for the new tree\r
-   * \r
+   *\r
    * @param treePanel\r
    * @param title\r
    */\r
@@ -2562,14 +2568,16 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     sortByTreeMenu.add(item);\r
     item.addActionListener(new java.awt.event.ActionListener()\r
     {\r
+      @Override\r
       public void actionPerformed(ActionEvent evt)\r
       {\r
         sortByTree(treePanel, title); // treePanel.getTitle());\r
       }\r
     });\r
-    \r
+\r
     treePanel.addWindowListener(new WindowAdapter()\r
     {\r
+      @Override\r
       public void windowOpened(WindowEvent e)\r
       {\r
         if (viewport.sortByTree)\r
@@ -2579,6 +2587,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
         super.windowOpened(e);\r
       }\r
 \r
+      @Override\r
       public void windowClosing(WindowEvent e)\r
       {\r
         sortByTreeMenu.remove(item);\r
@@ -2622,6 +2631,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
         this.builddate = builddate;\r
       }\r
 \r
+      @Override\r
       public void paint(Graphics g)\r
       {\r
         g.setColor(Color.white);\r
@@ -2691,7 +2701,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   MenuItem loadTree = new MenuItem("Load Associated Tree ...");\r
 \r
   MenuItem loadAnnotations = new MenuItem("Load Features/Annotations ...");\r
-  \r
+\r
   MenuItem outputFeatures = new MenuItem("Export Features ...");\r
 \r
   MenuItem outputAnnotations = new MenuItem("Export Annotations ...");\r
@@ -2766,13 +2776,13 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   MenuItem purinePyrimidineColour = new MenuItem();\r
   MenuItem RNAHelixColour = new MenuItem();\r
-  \r
+\r
   MenuItem userDefinedColour = new MenuItem();\r
 \r
   MenuItem PIDColour = new MenuItem();\r
 \r
   MenuItem BLOSUM62Colour = new MenuItem();\r
-  \r
+\r
   MenuItem tcoffeeColour = new MenuItem();\r
 \r
   MenuItem njTreeBlosumMenuItem = new MenuItem();\r
@@ -2860,7 +2870,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   CheckboxMenuItem seqLimits = new CheckboxMenuItem();\r
 \r
   CheckboxMenuItem centreColumnLabelFlag = new CheckboxMenuItem();\r
-  \r
+\r
   CheckboxMenuItem followMouseOverFlag = new CheckboxMenuItem();\r
   Menu autoAnnMenu=new Menu();\r
   CheckboxMenuItem showSequenceLogo= new CheckboxMenuItem();\r
@@ -2885,6 +2895,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
       item.addActionListener(new java.awt.event.ActionListener()\r
       {\r
+        @Override\r
         public void actionPerformed(ActionEvent e)\r
         {\r
           outputText_actionPerformed(e);\r
@@ -3085,7 +3096,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     applyAutoAnnotationSettings.setLabel("Apply to all groups");\r
     applyAutoAnnotationSettings.setState(true);\r
     autoAnnMenu.setLabel("Autocalculated Annotation");\r
-    \r
+\r
     invertColSel.addActionListener(this);\r
     showColumns.addActionListener(this);\r
     showSeqs.addActionListener(this);\r
@@ -3115,7 +3126,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
     fileMenu.add(inputText);\r
     fileMenu.add(loadTree);\r
     fileMenu.add(loadAnnotations);\r
-    \r
+\r
     fileMenu.addSeparator();\r
     fileMenu.add(outputTextboxMenu);\r
     fileMenu.add(outputFeatures);\r
@@ -3273,7 +3284,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
    * Attach the alignFrame panels after embedding menus, if necessary. This used\r
    * to be called setEmbedded, but is now creates the dropdown menus in a\r
    * platform independent manner to avoid OSX/Mac menu appendage daftness.\r
-   * \r
+   *\r
    * @param reallyEmbedded\r
    *          true to attach the view to the applet area on the page rather than\r
    *          in a new window\r
@@ -3301,14 +3312,14 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
       final AlignFrame me = this;\r
       viewport.applet.addFocusListener(new FocusListener()\r
       {\r
-        \r
+\r
         @Override\r
         public void focusLost(FocusEvent e)\r
         {\r
           if (me.viewport.applet.currentAlignFrame==me) {\r
                   me.viewport.applet.currentAlignFrame = null;\r
         }}\r
-        \r
+\r
         @Override\r
         public void focusGained(FocusEvent e)\r
         {\r
@@ -3343,7 +3354,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
    * structures in the original jmol window. Note This method doesn't work\r
    * without an additional javascript library to exchange messages between the\r
    * distinct applets. See http://issues.jalview.org/browse/JAL-621\r
-   * \r
+   *\r
    * @param viewer\r
    *          JmolViewer instance\r
    * @param sequenceIds\r
@@ -3408,7 +3419,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   }\r
   /**\r
    * bind a pdb file to a sequence in the current view\r
-   * \r
+   *\r
    * @param sequenceId\r
    *          - sequenceId within the dataset.\r
    * @param pdbEntryString\r
@@ -3580,7 +3591,7 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   /**\r
    * modify the current selection, providing the user has not made a selection already.\r
-   * @param sel - sequences from this alignment \r
+   * @param sel - sequences from this alignment\r
    * @param csel - columns to be selected on the alignment\r
    */\r
   public void select(SequenceGroup sel, ColumnSelection csel)\r
@@ -3590,15 +3601,15 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
 \r
   public void scrollTo(int row, int column)\r
   {\r
-    alignPanel.seqPanel.scrollTo(row, column);    \r
+    alignPanel.seqPanel.scrollTo(row, column);\r
   }\r
   public void scrollToRow(int row)\r
   {\r
-    alignPanel.seqPanel.scrollToRow(row);    \r
+    alignPanel.seqPanel.scrollToRow(row);\r
   }\r
   public void scrollToColumn(int column)\r
   {\r
-    alignPanel.seqPanel.scrollToColumn(column);    \r
+    alignPanel.seqPanel.scrollToColumn(column);\r
   }\r
   /**\r
    * @return the alignments unique ID.\r
@@ -3606,13 +3617,13 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
   public String getSequenceSetId() {\r
     return viewport.getSequenceSetId();\r
   }\r
-  \r
-  \r
+\r
+\r
   /**\r
-   * Load the (T-Coffee) score file from the specified url \r
-   * \r
+   * Load the (T-Coffee) score file from the specified url\r
+   *\r
    * @param source File/URL/T-COFFEE score file contents\r
-   * @throws IOException \r
+   * @throws IOException\r
    * @return true if alignment was annotated with data from source\r
    */\r
   public boolean loadScoreFile( String source ) throws IOException {\r
@@ -3624,17 +3635,17 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
            System.err.println("Origin was:\n"+source);\r
            return false;\r
          }\r
-         \r
+\r
          /*\r
           * check that the score matrix matches the alignment dimensions\r
           */\r
-         AlignmentI aln; \r
+         AlignmentI aln;\r
          if( (aln=viewport.getAlignment()) != null && (aln.getHeight() != file.getHeight() || aln.getWidth() != file.getWidth()) ) {\r
            // TODO: raise a dialog box here rather than bomb out.\r
            System.err.println("The scores matrix does not match the alignment dimensions");\r
-                 \r
+\r
          }\r
-         \r
+\r
           // TODO add parameter to indicate if matching should be done\r
          if (file.annotateAlignment(alignPanel.getAlignment(), false))\r
          {\r
@@ -3651,6 +3662,6 @@ public class AlignFrame extends EmbmenuFrame implements ActionListener,  ItemLis
           }\r
          return false;\r
   }\r
-  \r
-  \r
+\r
+\r
 }\r