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.
23 import jalview.api.AlignmentViewPanel;
24 import jalview.util.MessageManager;
26 import java.awt.Component;
27 import java.awt.event.ActionEvent;
28 import java.awt.event.ActionListener;
29 import java.awt.event.ItemEvent;
30 import java.awt.event.ItemListener;
31 import java.awt.event.MouseAdapter;
32 import java.awt.event.MouseEvent;
33 import java.util.List;
35 import javax.swing.JCheckBoxMenuItem;
36 import javax.swing.JMenu;
37 import javax.swing.JMenuItem;
38 import javax.swing.event.MenuEvent;
39 import javax.swing.event.MenuListener;
42 * this is an implementation of an abstract Jalview GUI class that provides a
43 * dialog/menu which allows the user to select/deselect specific views from a
44 * list of associated views.
46 * Includes patches related to JAL-641
51 public class ViewSelectionMenu extends JMenu
53 public interface ViewSetProvider
55 public AlignmentPanel[] getAllAlignmentPanels();
58 private ViewSetProvider _allviews;
60 private List<AlignmentViewPanel> _selectedviews;
62 private ItemListener _handler;
65 * create a new view selection menu. This menu has some standard entries
66 * (select all, invert selection), and a checkbox for every view. Mousing over
67 * a view entry will cause it to be raised/selected in the Desktop, allowing
68 * the user to easily identify which view is being referred to.
73 * all the views that might be selected
74 * @param selectedviews
75 * the list of selected views which will be updated when
76 * selection/deselections occur
78 * a handler called for each selection/deselection - use this to
79 * update any gui elements which need to reflect current
80 * selection/deselection state
82 public ViewSelectionMenu(String title, final ViewSetProvider allviews,
83 final List<AlignmentViewPanel> selectedviews,
84 final ItemListener handler)
87 this._allviews = allviews;
88 this._selectedviews = selectedviews;
89 this._handler = handler;
90 addMenuListener(new MenuListener()
94 public void menuSelected(MenuEvent e)
101 public void menuDeselected(MenuEvent e)
103 // TODO Auto-generated method stub
108 public void menuCanceled(MenuEvent e)
110 // TODO Auto-generated method stub
117 * view selection modifier flag - indicates if an action key is pressed when
118 * menu selection event occurred.
120 private boolean append = false;
123 * flag indicating if the itemStateChanged listener for view associated menu
124 * items is currently enabled
126 private boolean enabled = true;
128 private JMenuItem selectAll, invertSel;
130 private JCheckBoxMenuItem toggleview = null;
132 private void rebuild()
135 AlignmentPanel[] allviews = _allviews.getAllAlignmentPanels();
136 if (allviews == null)
141 if (allviews.length >= 2)
143 // ensure we update menu state to reflect external selection list state
144 append = append || _selectedviews.size() > 1;
145 toggleview = new JCheckBoxMenuItem(
146 MessageManager.getString("label.select_many_views"), append);
147 toggleview.setToolTipText(
148 MessageManager.getString("label.toggle_enabled_views"));
149 toggleview.addItemListener(new ItemListener()
153 public void itemStateChanged(ItemEvent arg0)
158 selectAll.setEnabled(append);
159 invertSel.setEnabled(append);
166 add(selectAll = new JMenuItem(
167 MessageManager.getString("label.select_all_views")));
168 selectAll.addActionListener(new ActionListener()
172 public void actionPerformed(ActionEvent e)
174 for (Component c : getMenuComponents())
178 if (c instanceof JCheckBoxMenuItem)
180 if (toggleview != c && !((JCheckBoxMenuItem) c).isSelected())
182 ((JCheckBoxMenuItem) c).doClick();
189 add(invertSel = new JMenuItem(
190 MessageManager.getString("label.invert_selection")));
191 invertSel.addActionListener(new ActionListener()
195 public void actionPerformed(ActionEvent e)
199 for (Component c : getMenuComponents())
201 if (toggleview != c && c instanceof JCheckBoxMenuItem)
203 ((JCheckBoxMenuItem) c).doClick();
209 invertSel.setEnabled(append);
210 selectAll.setEnabled(append);
212 for (final AlignmentPanel ap : allviews)
214 String nm = ((ap.getViewName() == null
215 || ap.getViewName().length() == 0) ? ""
216 : ap.getViewName() + " for ")
217 + ap.alignFrame.getTitle();
218 final JCheckBoxMenuItem checkBox = new JCheckBoxMenuItem(nm,
219 _selectedviews.contains(ap));
220 checkBox.addItemListener(new ItemListener()
223 public void itemStateChanged(ItemEvent e)
230 // toggle the inclusion state
231 if (_selectedviews.indexOf(ap) == -1)
233 _selectedviews.add(ap);
234 checkBox.setSelected(true);
238 _selectedviews.remove(ap);
239 checkBox.setSelected(false);
242 _handler.itemStateChanged(e);
246 // Deselect everything and select this item only
247 _selectedviews.clear();
248 _selectedviews.add(ap);
250 for (Component c : getMenuComponents())
252 if (c instanceof JCheckBoxMenuItem)
254 ((JCheckBoxMenuItem) c).setSelected(checkBox == c);
258 // only fire event if we weren't selected before
259 _handler.itemStateChanged(e);
264 checkBox.addMouseListener(new MouseAdapter()
267 public void mouseExited(MouseEvent e)
271 ap.setSelected(false);
272 } catch (Exception ex)
278 public void mouseEntered(MouseEvent e)
282 ap.setSelected(true);
283 } catch (Exception ex)