2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.io.cache;
23 import jalview.bin.Cache;
24 import jalview.util.MessageManager;
25 import jalview.util.Platform;
27 import java.awt.event.ActionEvent;
28 import java.awt.event.ActionListener;
29 import java.awt.event.FocusListener;
30 import java.awt.event.KeyAdapter;
31 import java.awt.event.KeyEvent;
32 import java.awt.event.KeyListener;
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.Collections;
36 import java.util.LinkedHashSet;
37 import java.util.List;
40 import javax.swing.JComboBox;
41 import javax.swing.JComponent;
42 import javax.swing.JMenuItem;
43 import javax.swing.JPopupMenu;
44 import javax.swing.JTextField;
45 import javax.swing.SwingUtilities;
46 import javax.swing.event.CaretListener;
47 import javax.swing.event.DocumentListener;
48 import javax.swing.text.JTextComponent;
51 * A class that provides an editable combobox with a memory of previous entries
52 * that may be persisted
59 * (temporary?) patches to wrap a JTextField instead when running as Javascript
61 public class JvCacheableInputBox<E>
63 protected JComboBox<String> comboBox; // used for Jalview
65 protected JTextField textField; // used for JalviewJS
67 protected JTextComponent textComponent; // used for both
69 protected String cacheKey;
71 protected AppCache appCache;
73 private JPopupMenu popup = new JPopupMenu();
75 private JMenuItem menuItemClearCache = new JMenuItem();
77 volatile boolean enterWasPressed = false;
79 private String prototypeDisplayValue;
82 * @return flag indicating if the most recent keypress was enter
84 public boolean wasEnterPressed()
86 return enterWasPressed;
90 * Constructor given the key to cached values, and the (approximate) length in
91 * characters of the input field
96 public JvCacheableInputBox(String newCacheKey, int length)
99 cacheKey = newCacheKey;
100 prototypeDisplayValue = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
103 StringBuilder sb = new StringBuilder();
104 for (int i = 0; i < length; i++)
108 setPrototypeDisplayValue(sb.toString());
110 boolean useTextField = Platform.isJS();
111 // BH 2019.03 only switch for JavaScript here
112 // SwingJS TODO implement editable combo box
116 textComponent = textField = new JTextField();
119 // public Dimension getPreferredSize() {
120 // return super.getPreferredSize();
121 //// FontMetrics fm = getFontMetrics(getFont());
122 //// return new Dimension(fm.stringWidth(prototypeDisplayValue),
129 appCache = AppCache.getInstance();
130 comboBox = new JComboBox<>();
131 textComponent = (JTextComponent) comboBox.getEditor()
132 .getEditorComponent();
133 comboBox.setEditable(true);
134 comboBox.addKeyListener(new KeyAdapter()
137 public void keyTyped(KeyEvent e)
139 enterWasPressed = false;
140 if (e.getKeyCode() == KeyEvent.VK_ENTER)
142 enterWasPressed = true;
144 // let event bubble up
147 comboBox.setPrototypeDisplayValue(prototypeDisplayValue);
149 appCache = AppCache.getInstance();
150 initCachePopupMenu();
151 initCache(newCacheKey);
156 * Method for initialising cache items for a given cache key and populating
157 * the in-memory cache with persisted cache items
161 private void initCache(String cacheKey)
163 if (appCache == null)
167 // obtain persisted cache items from properties file as a delimited string
168 String delimitedCacheStr = Cache.getProperty(cacheKey);
169 if (delimitedCacheStr == null || delimitedCacheStr.isEmpty())
173 // convert delimited cache items to a list of strings
174 List<String> persistedCacheItems = Arrays
175 .asList(delimitedCacheStr.split(AppCache.CACHE_DELIMITER));
177 LinkedHashSet<String> foundCacheItems = appCache
178 .getAllCachedItemsFor(cacheKey);
179 if (foundCacheItems == null)
181 foundCacheItems = new LinkedHashSet<>();
183 // populate memory cache
184 for (String cacheItem : persistedCacheItems)
186 foundCacheItems.add(cacheItem);
188 appCache.putCache(cacheKey, foundCacheItems);
192 * Initialise this cache's pop-up menu
194 private void initCachePopupMenu()
196 if (appCache == null)
200 menuItemClearCache.setFont(new java.awt.Font("Verdana", 0, 12));
202 .setText(MessageManager.getString("action.clear_cached_items"));
203 menuItemClearCache.addActionListener(new ActionListener()
206 public void actionPerformed(ActionEvent e)
208 // System.out.println(">>>>> Clear cache items");
210 appCache.deleteCacheItems(cacheKey);
215 popup.add(menuItemClearCache);
216 comboBox.setComponentPopupMenu(popup);
221 * Answers true if input text is an integer
226 static boolean isInteger(String text)
230 Integer.parseInt(text);
232 } catch (NumberFormatException e)
239 * Method called to update the cache with the last user input
241 public void updateCache()
243 if (appCache == null)
247 SwingUtilities.invokeLater(new Runnable()
252 int cacheLimit = Integer.parseInt(appCache.getCacheLimit(cacheKey));
253 String userInput = getUserInput();
254 if (userInput != null && !userInput.isEmpty())
256 LinkedHashSet<String> foundCache = appCache
257 .getAllCachedItemsFor(cacheKey);
258 // remove old cache item so as to place current input at the top of
260 foundCache.remove(userInput);
261 foundCache.add(userInput);
262 appCache.putCache(cacheKey, foundCache);
265 String lastSearch = userInput;
266 if (comboBox.getItemCount() > 0)
268 comboBox.removeAllItems();
270 Set<String> cacheItems = appCache.getAllCachedItemsFor(cacheKey);
271 List<String> reversedCacheItems = new ArrayList<>();
272 reversedCacheItems.addAll(cacheItems);
274 Collections.reverse(reversedCacheItems);
275 if (lastSearch.isEmpty())
277 comboBox.addItem("");
280 if (reversedCacheItems != null && !reversedCacheItems.isEmpty())
282 LinkedHashSet<String> foundCache = appCache
283 .getAllCachedItemsFor(cacheKey);
284 boolean prune = reversedCacheItems.size() > cacheLimit;
286 boolean limitExceeded = false;
287 for (String cacheItem : reversedCacheItems)
289 limitExceeded = (count++ > cacheLimit);
294 foundCache.remove(cacheItem);
298 comboBox.addItem(cacheItem);
303 comboBox.addItem(cacheItem);
306 appCache.putCache(cacheKey, foundCache);
308 setSelectedItem(lastSearch.isEmpty() ? "" : lastSearch);
314 * This method should be called to persist the in-memory cache when this
315 * components parent frame is closed / exited
317 public void persistCache()
319 if (appCache == null)
323 appCache.persistCache(cacheKey);
327 * Returns the trimmed text in the input field
331 public String getUserInput()
333 if (comboBox == null)
335 return textField.getText().trim();
337 Object item = comboBox.getEditor().getItem();
338 return item == null ? "" : item.toString().trim();
341 public JComponent getComponent()
343 return (comboBox == null ? textField : comboBox);
346 public void addActionListener(ActionListener actionListener)
348 if (comboBox == null)
350 textField.addActionListener(actionListener);
354 comboBox.addActionListener(actionListener);
358 public void addDocumentListener(DocumentListener listener)
360 textComponent.getDocument().addDocumentListener(listener);
363 public void addFocusListener(FocusListener focusListener)
365 textComponent.addFocusListener(focusListener);
368 public void addKeyListener(KeyListener kl)
370 textComponent.addKeyListener(kl);
373 public void addCaretListener(CaretListener caretListener)
375 textComponent.addCaretListener(caretListener);
378 public void setEditable(boolean b)
380 if (comboBox != null)
382 comboBox.setEditable(b);
386 public void setPrototypeDisplayValue(String string)
388 prototypeDisplayValue = string;
389 if (comboBox != null)
391 comboBox.setPrototypeDisplayValue(string);
395 public void setSelectedItem(String userInput)
397 if (comboBox != null)
399 comboBox.setSelectedItem(userInput);
403 public boolean isPopupVisible()
405 return (comboBox != null && comboBox.isPopupVisible());
408 public void addItem(String item)
410 if (comboBox != null)
412 comboBox.addItem(item);