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 jalview.util.MessageManager;
25 import java.awt.BorderLayout;
26 import java.awt.Color;
28 import java.awt.GridLayout;
29 import java.awt.Rectangle;
30 import java.awt.event.ActionListener;
32 import javax.swing.AbstractButton;
33 import javax.swing.JButton;
34 import javax.swing.JComponent;
35 import javax.swing.JLabel;
36 import javax.swing.JMenu;
37 import javax.swing.JMenuItem;
38 import javax.swing.JPanel;
39 import javax.swing.JScrollBar;
40 import javax.swing.SwingConstants;
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 if (ttext.length() < 60)
65 return enclose ? "<html>" + ttext + "</html>" : ttext;
69 return (enclose ? "<html>" : "")
70 + "<table width=350 border=0><tr><td>" + ttext
71 + "</td></tr></table>" + ((enclose ? "</html>" : ""));
75 public static JButton makeButton(String label, String tooltip,
76 ActionListener action)
78 JButton button = new JButton();
79 button.setText(label);
80 // TODO: get the base font metrics for the Jalview gui from somewhere
81 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
82 button.setForeground(Color.black);
83 button.setHorizontalAlignment(SwingConstants.CENTER);
84 button.setToolTipText(tooltip);
85 button.addActionListener(action);
90 * find or add a submenu with the given title in the given menu
94 * @return the new or existing submenu
96 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
98 JMenu submenuinstance = null;
99 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
101 if (menu.getMenuComponent(i) instanceof JMenu
102 && ((JMenu) menu.getMenuComponent(i)).getText().equals(
105 submenuinstance = (JMenu) menu.getMenuComponent(i);
108 if (submenuinstance == null)
110 submenuinstance = new JMenu(submenu);
111 menu.add(submenuinstance);
113 return submenuinstance;
123 * @return the GUI element created that was added to the layout so it's
124 * attributes can be changed.
126 public static JPanel addtoLayout(JPanel panel, String tooltip,
127 JComponent label, JComponent valBox)
129 JPanel laypanel = new JPanel(new GridLayout(1, 2));
130 JPanel labPanel = new JPanel(new BorderLayout());
131 JPanel valPanel = new JPanel();
132 // laypanel.setSize(panel.getPreferredSize());
133 // laypanel.setLayout(null);
134 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
135 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
136 // labPanel.setLayout(new GridLayout(1,1));
137 // valPanel.setLayout(new GridLayout(1,1));
138 labPanel.add(label, BorderLayout.WEST);
139 valPanel.add(valBox);
140 laypanel.add(labPanel);
141 laypanel.add(valPanel);
142 valPanel.setToolTipText(tooltip);
143 labPanel.setToolTipText(tooltip);
144 valBox.setToolTipText(tooltip);
150 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
151 JLabel jLabel, JComponent name)
153 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
156 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
157 JLabel jLabel, JComponent name, String params)
166 cpanel.add(name, params);
168 name.setToolTipText(tooltip);
169 jLabel.setToolTipText(tooltip);
173 * standard font for labels and check boxes in dialog boxes
178 public static Font getLabelFont()
180 return getLabelFont(false, false);
183 public static Font getLabelFont(boolean bold, boolean italic)
185 return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
186 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
190 * standard font for editable text areas
194 public static Font getTextAreaFont()
196 return getLabelFont(false, false);
200 * clean up a swing menu. Removes any empty submenus without selection
205 public static void cleanMenu(JMenu webService)
207 for (int i = 0; i < webService.getItemCount();)
209 JMenuItem item = webService.getItem(i);
210 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
212 webService.remove(i);
222 * Returns the proportion of its range that a scrollbar's position represents,
223 * as a value between 0 and 1. For example if the whole range is from 0 to
224 * 200, then a position of 40 gives proportion = 0.2.
226 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
231 public static float getScrollBarProportion(JScrollBar scroll)
234 * The extent (scroll handle width) deduction gives the true operating range
235 * of possible positions.
237 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
238 - scroll.getModel().getExtent();
239 float valueInRange = scroll.getValue()
240 - (scroll.getModel().getExtent() / 2f);
241 float proportion = valueInRange / possibleRange;
246 * Returns the scroll bar position in its range that would match the given
247 * proportion (between 0 and 1) of the whole. For example if the whole range
248 * is from 0 to 200, then a proportion of 0.25 gives position 50.
254 public static int getScrollValueForProportion(JScrollBar scrollbar,
258 * The extent (scroll handle width) deduction gives the true operating range
259 * of possible positions.
261 float fraction = proportion
262 * (scrollbar.getMaximum() - scrollbar.getMinimum() - scrollbar
263 .getModel().getExtent())
264 + (scrollbar.getModel().getExtent() / 2f);
265 return Math.min(Math.round(fraction), scrollbar.getMaximum());
268 public static void jvInitComponent(AbstractButton comp, String i18nString)
270 setColorAndFont(comp);
271 if (i18nString != null && !i18nString.isEmpty())
273 comp.setText(MessageManager.getString(i18nString));
277 public static void jvInitComponent(JComponent comp)
279 setColorAndFont(comp);
282 private static void setColorAndFont(JComponent comp)
284 comp.setBackground(Color.white);
285 comp.setFont(JvSwingUtils.getLabelFont());