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 java.awt.BorderLayout;
24 import java.awt.Color;
26 import java.awt.GridLayout;
27 import java.awt.Rectangle;
28 import java.awt.event.ActionListener;
30 import javax.swing.AbstractButton;
31 import javax.swing.JButton;
32 import javax.swing.JComponent;
33 import javax.swing.JLabel;
34 import javax.swing.JMenu;
35 import javax.swing.JMenuItem;
36 import javax.swing.JPanel;
37 import javax.swing.JScrollBar;
38 import javax.swing.SwingConstants;
40 import jalview.util.MessageManager;
43 * useful functions for building Swing GUIs
48 public final class JvSwingUtils
51 * wrap a bare html safe string to around 60 characters per line using a
60 public static String wrapTooltip(boolean enclose, String ttext)
63 boolean maxLenghtExceeded = false;
65 if (ttext.contains("<br>"))
67 String[] htmllines = ttext.split("<br>");
68 for (String line : htmllines)
70 maxLenghtExceeded = line.length() > 60;
71 if (maxLenghtExceeded)
79 maxLenghtExceeded = ttext.length() > 60;
82 if (!maxLenghtExceeded)
84 return enclose ? "<html>" + ttext + "</html>" : ttext;
88 return (enclose ? "<html><table width=350 border=0><tr><td align=justify>"
90 + ttext + ((enclose ? "</td></tr></table></html>" : ""));
94 public static JButton makeButton(String label, String tooltip,
95 ActionListener action)
97 JButton button = new JButton();
98 button.setText(label);
99 // TODO: get the base font metrics for the Jalview gui from somewhere
100 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
101 button.setForeground(Color.black);
102 button.setHorizontalAlignment(SwingConstants.CENTER);
103 button.setToolTipText(tooltip);
104 button.addActionListener(action);
109 * find or add a submenu with the given title in the given menu
113 * @return the new or existing submenu
115 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
117 JMenu submenuinstance = null;
118 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
120 if (menu.getMenuComponent(i) instanceof JMenu
121 && ((JMenu) menu.getMenuComponent(i)).getText().equals(
124 submenuinstance = (JMenu) menu.getMenuComponent(i);
127 if (submenuinstance == null)
129 submenuinstance = new JMenu(submenu);
130 menu.add(submenuinstance);
132 return submenuinstance;
142 * @return the GUI element created that was added to the layout so it's
143 * attributes can be changed.
145 public static JPanel addtoLayout(JPanel panel, String tooltip,
146 JComponent label, JComponent valBox)
148 JPanel laypanel = new JPanel(new GridLayout(1, 2));
149 JPanel labPanel = new JPanel(new BorderLayout());
150 JPanel valPanel = new JPanel();
151 // laypanel.setSize(panel.getPreferredSize());
152 // laypanel.setLayout(null);
153 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
154 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
155 // labPanel.setLayout(new GridLayout(1,1));
156 // valPanel.setLayout(new GridLayout(1,1));
157 labPanel.add(label, BorderLayout.WEST);
158 valPanel.add(valBox);
159 laypanel.add(labPanel);
160 laypanel.add(valPanel);
161 valPanel.setToolTipText(tooltip);
162 labPanel.setToolTipText(tooltip);
163 valBox.setToolTipText(tooltip);
169 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
170 JLabel jLabel, JComponent name)
172 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
175 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
176 JLabel jLabel, JComponent name, String params)
185 cpanel.add(name, params);
187 name.setToolTipText(tooltip);
188 jLabel.setToolTipText(tooltip);
192 * standard font for labels and check boxes in dialog boxes
197 public static Font getLabelFont()
199 return getLabelFont(false, false);
202 public static Font getLabelFont(boolean bold, boolean italic)
204 return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
205 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
209 * standard font for editable text areas
213 public static Font getTextAreaFont()
215 return getLabelFont(false, false);
219 * clean up a swing menu. Removes any empty submenus without selection
224 public static void cleanMenu(JMenu webService)
226 for (int i = 0; i < webService.getItemCount();)
228 JMenuItem item = webService.getItem(i);
229 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
231 webService.remove(i);
241 * Returns the proportion of its range that a scrollbar's position represents,
242 * as a value between 0 and 1. For example if the whole range is from 0 to
243 * 200, then a position of 40 gives proportion = 0.2.
245 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
250 public static float getScrollBarProportion(JScrollBar scroll)
253 * The extent (scroll handle width) deduction gives the true operating range
254 * of possible positions.
256 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
257 - scroll.getModel().getExtent();
258 float valueInRange = scroll.getValue()
259 - (scroll.getModel().getExtent() / 2f);
260 float proportion = valueInRange / possibleRange;
265 * Returns the scroll bar position in its range that would match the given
266 * proportion (between 0 and 1) of the whole. For example if the whole range
267 * is from 0 to 200, then a proportion of 0.25 gives position 50.
273 public static int getScrollValueForProportion(JScrollBar scrollbar,
277 * The extent (scroll handle width) deduction gives the true operating range
278 * of possible positions.
280 float fraction = proportion
281 * (scrollbar.getMaximum() - scrollbar.getMinimum() - scrollbar
282 .getModel().getExtent())
283 + (scrollbar.getModel().getExtent() / 2f);
284 return Math.min(Math.round(fraction), scrollbar.getMaximum());
287 public static void jvInitComponent(AbstractButton comp, String i18nString)
289 setColorAndFont(comp);
290 if (i18nString != null && !i18nString.isEmpty())
292 comp.setText(MessageManager.getString(i18nString));
296 public static void jvInitComponent(JComponent comp)
298 setColorAndFont(comp);
301 private static void setColorAndFont(JComponent comp)
303 comp.setBackground(Color.white);
304 comp.setFont(JvSwingUtils.getLabelFont());