2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
21 import java.awt.Color;
23 import java.awt.Rectangle;
24 import java.awt.event.ActionListener;
26 import javax.swing.JButton;
27 import javax.swing.JComponent;
28 import javax.swing.JLabel;
29 import javax.swing.JMenu;
30 import javax.swing.JMenuItem;
31 import javax.swing.JPanel;
32 import javax.swing.SwingConstants;
35 * useful functions for building Swing GUIs
40 public final class JvSwingUtils
43 * wrap a bare html safe string to around 60 characters per line using a
51 public static String wrapTooltip(String ttext)
53 if (ttext.length() < 60)
59 return "<table width=350 border=0><tr><td>" + ttext
60 + "</td></tr></table>";
63 public static JButton makeButton(String label, String tooltip,
64 ActionListener action)
66 JButton button = new JButton();
67 button.setText(label);
68 // TODO: get the base font metrics for the Jalview gui from somewhere
69 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
70 button.setForeground(Color.black);
71 button.setHorizontalAlignment(SwingConstants.CENTER);
72 button.setToolTipText(tooltip);
73 button.addActionListener(action);
78 * find or add a submenu with the given title in the given menu
82 * @return the new or existing submenu
84 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
86 JMenu submenuinstance = null;
87 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
89 if (menu.getMenuComponent(i) instanceof JMenu
90 && ((JMenu) menu.getMenuComponent(i)).getText().equals(
93 submenuinstance = (JMenu) menu.getMenuComponent(i);
96 if (submenuinstance == null)
98 submenuinstance = new JMenu(submenu);
99 menu.add(submenuinstance);
101 return submenuinstance;
111 * @return the GUI element created that was added to the layout so it's
112 * attributes can be changed.
114 public static JPanel addtoLayout(JPanel panel, String tooltip,
115 JComponent label, JComponent valBox)
117 JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
118 // laypanel.setSize(panel.getPreferredSize());
119 // laypanel.setLayout(null);
120 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
121 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
122 // labPanel.setLayout(new GridLayout(1,1));
123 // valPanel.setLayout(new GridLayout(1,1));
125 valPanel.add(valBox);
126 laypanel.add(labPanel);
127 laypanel.add(valPanel);
128 valPanel.setToolTipText(tooltip);
129 labPanel.setToolTipText(tooltip);
130 valBox.setToolTipText(tooltip);
136 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
137 JLabel jLabel, JComponent name)
139 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
142 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
143 JLabel jLabel, JComponent name, String params)
152 cpanel.add(name, params);
154 name.setToolTipText(tooltip);
155 jLabel.setToolTipText(tooltip);
159 * standard font for labels and check boxes in dialog boxes
164 public static Font getLabelFont()
166 return getLabelFont(false, false);
169 public static Font getLabelFont(boolean bold, boolean italic)
171 return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
172 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
176 * standard font for editable text areas
180 public static Font getTextAreaFont()
182 return getLabelFont(false, false);
186 * clean up a swing menu. Removes any empty submenus without selection
191 public static void cleanMenu(JMenu webService)
193 for (int i = 0; i < webService.getItemCount();)
195 JMenuItem item = webService.getItem(i);
196 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
198 webService.remove(i);