added help and documentation for annotation editing.
[jalview.git] / src / jalview / gui / RedundancyPanel.java
1 /*\r
2  * Jalview - A Sequence Alignment Editor and Viewer\r
3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
4  *\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
9  *\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
14  *\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
18  */\r
19 package jalview.gui;\r
20 \r
21 import jalview.datamodel.*;\r
22 \r
23 import jalview.jbgui.*;\r
24 \r
25 import java.awt.event.*;\r
26 \r
27 import java.util.*;\r
28 \r
29 import javax.swing.event.*;\r
30 \r
31 \r
32 /**\r
33  * DOCUMENT ME!\r
34  *\r
35  * @author $author$\r
36  * @version $Revision$\r
37  */\r
38 public class RedundancyPanel extends GSliderPanel\r
39 {\r
40     AlignFrame af;\r
41     AlignmentPanel ap;\r
42     Stack historyList = new Stack(); // simpler than synching with alignFrame.\r
43 \r
44     /**\r
45      * Creates a new RedundancyPanel object.\r
46      *\r
47      * @param ap DOCUMENT ME!\r
48      * @param af DOCUMENT ME!\r
49      */\r
50     public RedundancyPanel(AlignmentPanel ap, AlignFrame af)\r
51     {\r
52         this.ap = ap;\r
53         this.af = af;\r
54         label.setText("Enter the redundancy threshold");\r
55 \r
56         slider.addChangeListener(new ChangeListener()\r
57             {\r
58                 public void stateChanged(ChangeEvent evt)\r
59                 {\r
60                     valueField.setText(slider.getValue() + "");\r
61                 }\r
62             });\r
63 \r
64         slider.setMinimum(0);\r
65         slider.setMaximum(100);\r
66         slider.setValue(100);\r
67     }\r
68 \r
69     /**\r
70      * DOCUMENT ME!\r
71      *\r
72      * @param e DOCUMENT ME!\r
73      */\r
74     public void applyButton_actionPerformed(ActionEvent e)\r
75     {\r
76         float threshold = slider.getValue();\r
77         Vector del;\r
78         HistoryItem it;\r
79         historyList.push(it = new HistoryItem("Remove redundancy",\r
80                     ap.av.alignment, HistoryItem.HIDE));\r
81 \r
82         if ((historyList.size() == 1) ||\r
83                 !af.historyList.contains(historyList.firstElement()))\r
84         {\r
85             af.addHistoryItem((HistoryItem) historyList.firstElement());\r
86             af.updateEditMenuBar();\r
87         }\r
88 \r
89         undoButton.setEnabled(true);\r
90 \r
91         SequenceGroup sg = ap.av.getSelectionGroup();\r
92 \r
93         if ((sg != null) && (sg.getSize() >= 1))\r
94         {\r
95             del = ap.av.alignment.removeRedundancy(threshold, sg.sequences);\r
96 \r
97             for (int i = 0; i < del.size(); i++)\r
98             {\r
99                 if (sg.sequences.contains((SequenceI) del.elementAt(i)))\r
100                 {\r
101                     sg.deleteSequence((SequenceI) del.elementAt(i), true);\r
102                 }\r
103             }\r
104         }\r
105         else\r
106         {\r
107             Vector s = new Vector();\r
108             int i = 0;\r
109 \r
110             while (i < ap.av.alignment.getHeight())\r
111             {\r
112                 s.addElement(ap.av.alignment.getSequenceAt(i));\r
113                 i++;\r
114             }\r
115 \r
116             del = ap.av.alignment.removeRedundancy(threshold, s);\r
117         }\r
118 \r
119         // This has to be done before the restoreHistoryItem method of alignFrame will\r
120         // actually restore these sequences.\r
121         if (del.size() > 0)\r
122         {\r
123             for (int i = 0, j = del.size(); i < j; i++)\r
124             {\r
125                 SequenceI sq = (SequenceI) del.elementAt(i);\r
126                 sq.deleteChars(0, sq.getLength());\r
127             }\r
128         }\r
129 \r
130         ap.av.firePropertyChange("alignment", null,\r
131             ap.av.getAlignment().getSequences());\r
132         ap.av.resetSeqLimits(ap.seqPanel.seqCanvas.getHeight());\r
133 \r
134         if (ap.av.getAlignment().getHeight() < 1)\r
135         {\r
136             try\r
137             {\r
138                 af.setClosed(true);\r
139             }\r
140             catch (Exception ex)\r
141             {\r
142             }\r
143         }\r
144 \r
145         ap.av.updateConservation();\r
146         ap.av.updateConsensus();\r
147         af.updateEditMenuBar();\r
148         ap.repaint();\r
149     }\r
150 \r
151     /**\r
152      * DOCUMENT ME!\r
153      *\r
154      * @param e DOCUMENT ME!\r
155      */\r
156     public void undoButton_actionPerformed(ActionEvent e)\r
157     {\r
158         HistoryItem hi = (HistoryItem) historyList.pop();\r
159         af.restoreHistoryItem(hi);\r
160 \r
161         if (historyList.size() == 0)\r
162         {\r
163             undoButton.setEnabled(false);\r
164 \r
165             if (af.historyList.contains(hi))\r
166             {\r
167                 af.historyList.remove(hi);\r
168                 af.updateEditMenuBar();\r
169             }\r
170         }\r
171     }\r
172 \r
173     /**\r
174      * DOCUMENT ME!\r
175      *\r
176      * @param e DOCUMENT ME!\r
177      */\r
178     public void valueField_actionPerformed(ActionEvent e)\r
179     {\r
180         try\r
181         {\r
182             int i = Integer.parseInt(valueField.getText());\r
183             slider.setValue(i);\r
184         }\r
185         catch (Exception ex)\r
186         {\r
187             valueField.setText(slider.getValue() + "");\r
188         }\r
189     }\r
190 }\r