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.appletgui;
23 import jalview.util.Platform;
25 import java.awt.BorderLayout;
26 import java.awt.Color;
27 import java.awt.FlowLayout;
29 import java.awt.Frame;
30 import java.awt.HeadlessException;
31 import java.awt.Label;
33 import java.awt.MenuBar;
34 import java.awt.Panel;
35 import java.awt.PopupMenu;
36 import java.awt.event.MouseEvent;
37 import java.awt.event.MouseListener;
38 import java.util.HashMap;
42 * This class implements a pattern for embedding toolbars as a panel with popups
43 * for situations where the system menu bar is either invisible or
44 * inappropriate. It was derived from the code for embedding the jalview applet
45 * alignFrame as a component on the web-page, which requires the local
46 * alignFrame menu to be attached to that panel rather than placed on the parent
47 * (which isn't allowed anyhow). TODO: try to modify the embeddedMenu display so
48 * it looks like a real toolbar menu TODO: modify click/mouse handler for
49 * embeddedMenu so it behaves more like a real pulldown menu toolbar
51 * @author Jim Procter and Andrew Waterhouse
54 public class EmbmenuFrame extends Frame implements MouseListener
56 protected static final Font FONT_ARIAL_PLAIN_11 = new Font("Arial",
59 public static final Font DEFAULT_MENU_FONT = FONT_ARIAL_PLAIN_11;
62 * map from labels to popup menus for the embedded menubar
64 protected Map<Label, PopupMenu> embeddedPopup = new HashMap<Label, PopupMenu>();
67 * the embedded menu is built on this and should be added to the frame at the
68 * appropriate position.
71 protected Panel embeddedMenu;
73 public EmbmenuFrame() throws HeadlessException
78 public EmbmenuFrame(String title) throws HeadlessException
84 * Check if the applet is running on a platform that requires the Frame
85 * menuBar to be embedded, and if so, embeds it.
88 * the panel that is to be reduced to make space for the embedded
90 * @return true if menuBar was embedded and tobeAdjusted's height modified
92 protected boolean embedMenuIfNeeded(Panel tobeAdjusted)
94 MenuBar topMenuBar = getMenuBar();
95 if (topMenuBar == null)
99 // DEBUG Hint: can test embedded menus by inserting true here.
100 if (Platform.isAMacAndNotJS())
102 // Build the embedded menu panel, allowing override with system font
103 embeddedMenu = makeEmbeddedPopupMenu(topMenuBar, true, false);
105 // add the components to the Panel area.
106 add(embeddedMenu, BorderLayout.NORTH);
107 tobeAdjusted.setSize(getSize().width,
108 getSize().height - embeddedMenu.getHeight());
115 * Create or add elements to the embedded menu from menuBar. This removes all
116 * menu from menuBar and it is up to the caller to remove the now useless
117 * menuBar from the Frame if it is already attached.
120 * @param overrideFonts
122 * true means existing menu will be emptied before adding new
126 protected Panel makeEmbeddedPopupMenu(MenuBar menuBar,
127 boolean overrideFonts, boolean append)
131 embeddedPopup.clear(); // TODO: check if j1.1
132 if (embeddedMenu != null)
134 embeddedMenu.removeAll();
137 embeddedMenu = makeEmbeddedPopupMenu(menuBar, DEFAULT_MENU_FONT,
138 overrideFonts, new Panel(), this);
143 * Generic method to move elements from menubar onto embeddedMenu using the
144 * existing or the supplied font, and adds binding from panel to attached
145 * menus in embeddedPopup This removes all menu from menuBar and it is up to
146 * the caller to remove the now useless menuBar from the Frame if it is
152 * @param overrideFonts
153 * @param embeddedMenu
154 * if null, a new panel will be created and returned
155 * @param clickHandler
156 * - usually the instance of EmbmenuFrame that holds references to
157 * embeddedPopup and embeddedMenu
158 * @return the panel instance for convenience.
160 protected Panel makeEmbeddedPopupMenu(MenuBar menuBar, Font font,
161 boolean overrideFonts, Panel embeddedMenu,
162 MouseListener clickHandler)
166 Font mbf = menuBar.getFont();
172 if (embeddedMenu == null)
174 embeddedMenu = new Panel();
176 FlowLayout flowLayout1 = new FlowLayout();
177 embeddedMenu.setBackground(Color.lightGray);
178 embeddedMenu.setLayout(flowLayout1);
180 for (int mbi = 0, nMbi = menuBar.getMenuCount(); mbi < nMbi; mbi++)
182 Menu mi = menuBar.getMenu(mbi);
183 Label elab = new Label(mi.getLabel());
185 // add the menu entries
186 PopupMenu popup = new PopupMenu();
187 int m, mSize = mi.getItemCount();
188 for (m = 0; m < mSize; m++)
190 popup.add(mi.getItem(m));
194 embeddedPopup.put(elab, popup);
195 embeddedMenu.add(elab);
196 elab.addMouseListener(clickHandler);
198 flowLayout1.setAlignment(FlowLayout.LEFT);
199 flowLayout1.setHgap(2);
200 flowLayout1.setVgap(0);
204 public void mousePressed(MouseEvent evt)
206 PopupMenu popup = null;
207 Label source = (Label) evt.getSource();
208 popup = getPopupMenu(source);
211 embeddedMenu.add(popup);
212 popup.show(embeddedMenu, source.getBounds().x,
213 source.getBounds().y + source.getBounds().getSize().height);
218 * get the menu for source from the hash.
221 * what was clicked on.
223 PopupMenu getPopupMenu(Label source)
225 return embeddedPopup.get(source);
228 public void mouseClicked(MouseEvent evt)
232 public void mouseReleased(MouseEvent evt)
236 public void mouseEntered(MouseEvent evt)
240 public void mouseExited(MouseEvent evt)
245 * called to clear the GUI resources taken up for embedding and remove any
246 * self references so we can be garbage collected.
248 public void destroyMenus()
250 if (embeddedPopup != null)
252 for (Label lb : embeddedPopup.keySet())
254 lb.removeMouseListener(this);
256 embeddedPopup.clear();
258 if (embeddedMenu != null)
260 embeddedMenu.removeAll();
265 * calls destroyMenus()
267 public void finalize() throws Throwable
270 embeddedPopup = null;