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 jalview.util.MessageManager;
25 import java.awt.Color;
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;
41 * useful functions for building Swing GUIs
46 public final class JvSwingUtils
49 * wrap a bare html safe string to around 60 characters per line using a
58 public static String wrapTooltip(boolean enclose, String ttext)
60 if (ttext.length() < 60)
62 return enclose ? "<html>" + ttext + "</html>" : ttext;
66 return (enclose ? "<html>" : "")
67 + "<table width=350 border=0><tr><td>" + ttext
68 + "</td></tr></table>" + ((enclose ? "</html>" : ""));
72 public static JButton makeButton(String label, String tooltip,
73 ActionListener action)
75 JButton button = new JButton();
76 button.setText(label);
77 // TODO: get the base font metrics for the Jalview gui from somewhere
78 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
79 button.setForeground(Color.black);
80 button.setHorizontalAlignment(SwingConstants.CENTER);
81 button.setToolTipText(tooltip);
82 button.addActionListener(action);
87 * find or add a submenu with the given title in the given menu
91 * @return the new or existing submenu
93 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
95 JMenu submenuinstance = null;
96 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
98 if (menu.getMenuComponent(i) instanceof JMenu
99 && ((JMenu) menu.getMenuComponent(i)).getText().equals(
102 submenuinstance = (JMenu) menu.getMenuComponent(i);
105 if (submenuinstance == null)
107 submenuinstance = new JMenu(submenu);
108 menu.add(submenuinstance);
110 return submenuinstance;
120 * @return the GUI element created that was added to the layout so it's
121 * attributes can be changed.
123 public static JPanel addtoLayout(JPanel panel, String tooltip,
124 JComponent label, JComponent valBox)
126 JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
127 // laypanel.setSize(panel.getPreferredSize());
128 // laypanel.setLayout(null);
129 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
130 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
131 // labPanel.setLayout(new GridLayout(1,1));
132 // valPanel.setLayout(new GridLayout(1,1));
134 valPanel.add(valBox);
135 laypanel.add(labPanel);
136 laypanel.add(valPanel);
137 valPanel.setToolTipText(tooltip);
138 labPanel.setToolTipText(tooltip);
139 valBox.setToolTipText(tooltip);
145 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
146 JLabel jLabel, JComponent name)
148 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
151 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
152 JLabel jLabel, JComponent name, String params)
161 cpanel.add(name, params);
163 name.setToolTipText(tooltip);
164 jLabel.setToolTipText(tooltip);
168 * standard font for labels and check boxes in dialog boxes
173 public static Font getLabelFont()
175 return getLabelFont(false, false);
178 public static Font getLabelFont(boolean bold, boolean italic)
180 return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
181 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
185 * standard font for editable text areas
189 public static Font getTextAreaFont()
191 return getLabelFont(false, false);
195 * clean up a swing menu. Removes any empty submenus without selection
200 public static void cleanMenu(JMenu webService)
202 for (int i = 0; i < webService.getItemCount();)
204 JMenuItem item = webService.getItem(i);
205 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
207 webService.remove(i);
217 * Returns the proportion of its range that a scrollbar's position represents,
218 * as a value between 0 and 1. For example if the whole range is from 0 to
219 * 200, then a position of 40 gives proportion = 0.2.
221 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
226 public static float getScrollBarProportion(JScrollBar scroll)
229 * The extent (scroll handle width) deduction gives the true operating range
230 * of possible positions.
232 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
233 - scroll.getModel().getExtent();
234 float valueInRange = scroll.getValue()
235 - (scroll.getModel().getExtent() / 2f);
236 float proportion = valueInRange / possibleRange;
241 * Returns the scroll bar position in its range that would match the given
242 * proportion (between 0 and 1) of the whole. For example if the whole range
243 * is from 0 to 200, then a proportion of 0.25 gives position 50.
249 public static int getScrollValueForProportion(JScrollBar scrollbar,
253 * The extent (scroll handle width) deduction gives the true operating range
254 * of possible positions.
256 float fraction = proportion
257 * (scrollbar.getMaximum() - scrollbar.getMinimum() - scrollbar
258 .getModel().getExtent())
259 + (scrollbar.getModel().getExtent() / 2f);
260 return Math.min(Math.round(fraction), scrollbar.getMaximum());
263 public static void jvInitComponent(AbstractButton comp, String i18nString)
265 setColorAndFont(comp);
266 if (i18nString != null && !i18nString.isEmpty())
268 comp.setText(MessageManager.getString(i18nString));
272 public static void jvInitComponent(JComponent comp)
274 setColorAndFont(comp);
277 private static void setColorAndFont(JComponent comp)
279 comp.setBackground(Color.white);
280 comp.setFont(JvSwingUtils.getLabelFont());