JAL-1648 improvement on finder searchbox keyboard control - Enter to update search...
[jalview.git] / src / jalview / jbgui / GFinder.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.jbgui;
22
23 import jalview.datamodel.AlignmentI;
24 import jalview.io.DataSourceType;
25 import jalview.io.FileFormat;
26 import jalview.io.FormatAdapter;
27 import jalview.io.cache.JvCacheableInputBox;
28 import jalview.util.MessageManager;
29
30 import java.awt.BorderLayout;
31 import java.awt.Dimension;
32 import java.awt.Font;
33 import java.awt.GridLayout;
34 import java.awt.Insets;
35 import java.awt.event.ActionEvent;
36 import java.awt.event.KeyEvent;
37
38 import javax.swing.JButton;
39 import javax.swing.JCheckBox;
40 import javax.swing.JLabel;
41 import javax.swing.JPanel;
42 import javax.swing.SwingConstants;
43 import javax.swing.SwingUtilities;
44 import javax.swing.event.CaretEvent;
45 import javax.swing.event.CaretListener;
46 import javax.swing.text.JTextComponent;
47
48 public class GFinder extends JPanel
49 {
50   JLabel jLabelFind = new JLabel();
51
52   protected JButton findAll = new JButton();
53
54   protected JButton findNext = new JButton();
55
56   JPanel actionsPanel = new JPanel();
57
58   GridLayout gridLayout1 = new GridLayout();
59
60   protected JButton createFeatures = new JButton();
61
62   protected JvCacheableInputBox<String> searchBox = new JvCacheableInputBox<String>(getCacheKey());
63
64   BorderLayout mainBorderLayout = new BorderLayout();
65
66   JPanel jPanel2 = new JPanel();
67
68   JPanel jPanel3 = new JPanel();
69
70   JPanel jPanel4 = new JPanel();
71
72   BorderLayout borderLayout2 = new BorderLayout();
73
74   JPanel jPanel6 = new JPanel();
75
76   protected JCheckBox caseSensitive = new JCheckBox();
77
78   protected JCheckBox searchDescription = new JCheckBox();
79
80   GridLayout optionsGridLayout = new GridLayout();
81
82   private static final String FINDER_CACHE_KEY = "CACHE.FINDER";
83
84   public GFinder()
85   {
86     try
87     {
88       jbInit();
89     } catch (Exception e)
90     {
91       e.printStackTrace();
92     }
93   }
94
95   private void jbInit() throws Exception
96   {
97     jLabelFind.setFont(new java.awt.Font("Verdana", 0, 12));
98     jLabelFind.setText(MessageManager.getString("label.find"));
99     this.setLayout(mainBorderLayout);
100     findAll.setFont(new java.awt.Font("Verdana", 0, 12));
101     findAll.setText(MessageManager.getString("action.find_all"));
102     findAll.addActionListener(new java.awt.event.ActionListener()
103     {
104       @Override
105       public void actionPerformed(ActionEvent e)
106       {
107         findAll_actionPerformed(e);
108       }
109     });
110     findNext.setFont(new java.awt.Font("Verdana", 0, 12));
111     findNext.setText(MessageManager.getString("action.find_next"));
112     findNext.addActionListener(new java.awt.event.ActionListener()
113     {
114       @Override
115       public void actionPerformed(ActionEvent e)
116       {
117         findNext_actionPerformed(e);
118       }
119     });
120     actionsPanel.setLayout(gridLayout1);
121     gridLayout1.setHgap(0);
122     gridLayout1.setRows(3);
123     gridLayout1.setVgap(2);
124     createFeatures.setEnabled(false);
125     createFeatures.setFont(new java.awt.Font("Verdana", 0, 12));
126     createFeatures.setMargin(new Insets(0, 0, 0, 0));
127     createFeatures.setText(MessageManager.getString("label.new_feature"));
128     createFeatures.addActionListener(new java.awt.event.ActionListener()
129     {
130       @Override
131       public void actionPerformed(ActionEvent e)
132       {
133         createFeatures_actionPerformed();
134       }
135     });
136     searchBox.setFont(new java.awt.Font("Verdana", Font.PLAIN, 12));
137     ((JTextComponent) searchBox.getEditor().getEditorComponent())
138             .addCaretListener(new CaretListener()
139     {
140       @Override
141       public void caretUpdate(CaretEvent e)
142       {
143         textfield_caretUpdate(e);
144       }
145     });
146     searchBox.getEditor().getEditorComponent()
147             .addKeyListener(new java.awt.event.KeyAdapter()
148             {
149               @Override
150               public void keyPressed(KeyEvent e)
151               {
152                 textfield_keyPressed(e);
153               }
154             });
155     mainBorderLayout.setHgap(5);
156     mainBorderLayout.setVgap(5);
157     jPanel4.setLayout(borderLayout2);
158     jPanel2.setPreferredSize(new Dimension(10, 1));
159     jPanel3.setPreferredSize(new Dimension(10, 1));
160     caseSensitive.setHorizontalAlignment(SwingConstants.LEFT);
161     caseSensitive.setText(MessageManager.getString("label.match_case"));
162
163     searchDescription.setText(MessageManager
164             .getString("label.include_description"));
165
166     actionsPanel.add(findNext, null);
167     actionsPanel.add(findAll, null);
168     actionsPanel.add(createFeatures, null);
169     this.add(jLabelFind, java.awt.BorderLayout.WEST);
170     this.add(actionsPanel, java.awt.BorderLayout.EAST);
171     this.add(jPanel2, java.awt.BorderLayout.SOUTH);
172     this.add(jPanel3, java.awt.BorderLayout.NORTH);
173     this.add(jPanel4, java.awt.BorderLayout.CENTER);
174     jPanel4.add(searchBox, java.awt.BorderLayout.NORTH);
175
176     JPanel optionsPanel = new JPanel();
177
178     optionsGridLayout.setHgap(0);
179     optionsGridLayout.setRows(2);
180     optionsGridLayout.setVgap(2);
181     optionsPanel.setLayout(optionsGridLayout);
182     optionsPanel.add(caseSensitive, null);
183     optionsPanel.add(searchDescription, null);
184
185     jPanel4.add(optionsPanel, java.awt.BorderLayout.WEST);
186   }
187
188   protected void textfield_keyPressed(KeyEvent e)
189   {
190     if (e.getKeyCode() == KeyEvent.VK_ENTER)
191     {
192       if (!searchBox.isPopupVisible())
193       {
194         e.consume();
195         findNext_actionPerformed(null);
196       }
197     }
198   }
199
200   protected void findNext_actionPerformed(ActionEvent e)
201   {
202   }
203
204   protected void findAll_actionPerformed(ActionEvent e)
205   {
206   }
207
208
209   public void createFeatures_actionPerformed()
210   {
211   }
212
213   public void textfield_caretUpdate(CaretEvent e)
214   {
215     if (searchBox.getUserInput().indexOf(">") > -1)
216     {
217       SwingUtilities.invokeLater(new Runnable()
218       {
219         @Override
220         public void run()
221         {
222           String str = searchBox.getUserInput();
223           AlignmentI al = null;
224           try
225           {
226             al = new FormatAdapter().readFile(str, DataSourceType.PASTE,
227                     FileFormat.Fasta);
228           } catch (Exception ex)
229           {
230           }
231           if (al != null && al.getHeight() > 0)
232           {
233             str = jalview.analysis.AlignSeq.extractGaps(
234                     jalview.util.Comparison.GapChars, al.getSequenceAt(0)
235                             .getSequenceAsString());
236
237           }
238         }
239       });
240     }
241   }
242
243
244
245
246
247   /**
248    * Returns unique key used for storing Finder cache items in the cache data
249    * structure
250    * 
251    * @return
252    */
253   public String getCacheKey()
254   {
255     return FINDER_CACHE_KEY;
256   }
257
258
259
260 }