2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 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 java.awt.Color;
25 import java.awt.Rectangle;
26 import java.awt.event.ActionListener;
28 import javax.swing.JButton;
29 import javax.swing.JComponent;
30 import javax.swing.JLabel;
31 import javax.swing.JMenu;
32 import javax.swing.JMenuItem;
33 import javax.swing.JPanel;
34 import javax.swing.SwingConstants;
37 * useful functions for building Swing GUIs
42 public final class JvSwingUtils
45 * wrap a bare html safe string to around 60 characters per line using a
53 public static String wrapTooltip(String ttext)
55 if (ttext.length() < 60)
61 return "<table width=350 border=0><tr><td>" + ttext
62 + "</td></tr></table>";
66 public static JButton makeButton(String label, String tooltip,
67 ActionListener action)
69 JButton button = new JButton();
70 button.setText(label);
71 // TODO: get the base font metrics for the Jalview gui from somewhere
72 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
73 button.setForeground(Color.black);
74 button.setHorizontalAlignment(SwingConstants.CENTER);
75 button.setToolTipText(tooltip);
76 button.addActionListener(action);
81 * find or add a submenu with the given title in the given menu
85 * @return the new or existing submenu
87 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
89 JMenu submenuinstance = null;
90 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
92 if (menu.getMenuComponent(i) instanceof JMenu
93 && ((JMenu) menu.getMenuComponent(i)).getText().equals(
96 submenuinstance = (JMenu) menu.getMenuComponent(i);
99 if (submenuinstance == null)
101 submenuinstance = new JMenu(submenu);
102 menu.add(submenuinstance);
104 return submenuinstance;
114 * @return the GUI element created that was added to the layout so it's
115 * attributes can be changed.
117 public static JPanel addtoLayout(JPanel panel, String tooltip,
118 JComponent label, JComponent valBox)
120 JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
121 // laypanel.setSize(panel.getPreferredSize());
122 // laypanel.setLayout(null);
123 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
124 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
125 // labPanel.setLayout(new GridLayout(1,1));
126 // valPanel.setLayout(new GridLayout(1,1));
128 valPanel.add(valBox);
129 laypanel.add(labPanel);
130 laypanel.add(valPanel);
131 valPanel.setToolTipText(tooltip);
132 labPanel.setToolTipText(tooltip);
133 valBox.setToolTipText(tooltip);
139 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
140 JLabel jLabel, JComponent name)
142 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
145 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
146 JLabel jLabel, JComponent name, String params)
155 cpanel.add(name, params);
157 name.setToolTipText(tooltip);
158 jLabel.setToolTipText(tooltip);
162 * standard font for labels and check boxes in dialog boxes
167 public static Font getLabelFont()
169 return getLabelFont(false, false);
172 public static Font getLabelFont(boolean bold, boolean italic)
174 return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
175 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
179 * standard font for editable text areas
183 public static Font getTextAreaFont()
185 return getLabelFont(false, false);
189 * clean up a swing menu. Removes any empty submenus without selection
194 public static void cleanMenu(JMenu webService)
196 for (int i = 0; i < webService.getItemCount();)
198 JMenuItem item = webService.getItem(i);
199 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
201 webService.remove(i);