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;
27 import java.awt.Component;
29 import java.awt.GridLayout;
30 import java.awt.Rectangle;
31 import java.awt.event.ActionListener;
32 import java.awt.event.MouseAdapter;
33 import java.awt.event.MouseEvent;
34 import java.util.List;
35 import java.util.Objects;
37 import javax.swing.AbstractButton;
38 import javax.swing.BorderFactory;
39 import javax.swing.JButton;
40 import javax.swing.JComboBox;
41 import javax.swing.JComponent;
42 import javax.swing.JLabel;
43 import javax.swing.JMenu;
44 import javax.swing.JMenuItem;
45 import javax.swing.JPanel;
46 import javax.swing.JScrollBar;
47 import javax.swing.SwingConstants;
48 import javax.swing.border.Border;
49 import javax.swing.border.TitledBorder;
52 * useful functions for building Swing GUIs
57 public final class JvSwingUtils
60 * wrap a bare html safe string to around 60 characters per line using a CSS
61 * style class specifying word-wrap and break-word
64 * if true, add <html> wrapper tags
69 public static String wrapTooltip(boolean enclose, String ttext)
71 Objects.requireNonNull(ttext,
72 "Tootip text to format must not be null!");
74 boolean maxLengthExceeded = false;
76 if (ttext.contains("<br>"))
78 String[] htmllines = ttext.split("<br>");
79 for (String line : htmllines)
81 maxLengthExceeded = line.length() > 60;
82 if (maxLengthExceeded)
90 maxLengthExceeded = ttext.length() > 60;
93 if (!maxLengthExceeded)
95 return enclose ? "<html>" + ttext + "</html>" : ttext;
98 return (enclose ? "<html>" : "")
102 + "<style> div.ttip {width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;}</style><div class=\"ttip\">"
104 // + "<style> p.ttip {width:350px;margin:-14px 0px -14px 0px;padding:2px;overflow-wrap:break-word;}"
105 // + "</style><p class=\"ttip\">"
111 + ((enclose ? "</html>" : ""));
115 public static JButton makeButton(String label, String tooltip,
116 ActionListener action)
118 JButton button = new JButton();
119 button.setText(label);
120 // TODO: get the base font metrics for the Jalview gui from somewhere
121 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
122 button.setForeground(Color.black);
123 button.setHorizontalAlignment(SwingConstants.CENTER);
124 button.setToolTipText(tooltip);
125 button.addActionListener(action);
130 * find or add a submenu with the given title in the given menu
134 * @return the new or existing submenu
136 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
138 JMenu submenuinstance = null;
139 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
141 if (menu.getMenuComponent(i) instanceof JMenu
142 && ((JMenu) menu.getMenuComponent(i)).getText()
145 submenuinstance = (JMenu) menu.getMenuComponent(i);
148 if (submenuinstance == null)
150 submenuinstance = new JMenu(submenu);
151 menu.add(submenuinstance);
153 return submenuinstance;
163 * @return the GUI element created that was added to the layout so it's
164 * attributes can be changed.
166 public static JPanel addtoLayout(JPanel panel, String tooltip,
167 JComponent label, JComponent valBox)
169 JPanel laypanel = new JPanel(new GridLayout(1, 2));
170 JPanel labPanel = new JPanel(new BorderLayout());
171 JPanel valPanel = new JPanel();
172 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
173 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
174 labPanel.add(label, BorderLayout.WEST);
175 valPanel.add(valBox);
176 laypanel.add(labPanel);
177 laypanel.add(valPanel);
178 valPanel.setToolTipText(tooltip);
179 labPanel.setToolTipText(tooltip);
180 valBox.setToolTipText(tooltip);
186 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
187 JLabel jLabel, JComponent name)
189 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
192 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
193 JLabel jLabel, JComponent name, String params)
202 cpanel.add(name, params);
204 name.setToolTipText(tooltip);
205 jLabel.setToolTipText(tooltip);
209 * standard font for labels and check boxes in dialog boxes
214 public static Font getLabelFont()
216 return getLabelFont(false, false);
219 public static Font getLabelFont(boolean bold, boolean italic)
221 return new java.awt.Font("Verdana",
222 (!bold && !italic) ? Font.PLAIN
223 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
228 * standard font for editable text areas
232 public static Font getTextAreaFont()
234 return getLabelFont(false, false);
238 * clean up a swing menu. Removes any empty submenus without selection
243 public static void cleanMenu(JMenu webService)
245 for (int i = 0; i < webService.getItemCount();)
247 JMenuItem item = webService.getItem(i);
248 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
250 webService.remove(i);
260 * Returns the proportion of its range that a scrollbar's position represents,
261 * as a value between 0 and 1. For example if the whole range is from 0 to
262 * 200, then a position of 40 gives proportion = 0.2.
264 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
269 public static float getScrollBarProportion(JScrollBar scroll)
272 * The extent (scroll handle width) deduction gives the true operating range
273 * of possible positions.
275 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
276 - scroll.getModel().getExtent();
277 float valueInRange = scroll.getValue()
278 - (scroll.getModel().getExtent() / 2f);
279 float proportion = valueInRange / possibleRange;
284 * Returns the scroll bar position in its range that would match the given
285 * proportion (between 0 and 1) of the whole. For example if the whole range
286 * is from 0 to 200, then a proportion of 0.25 gives position 50.
292 public static int getScrollValueForProportion(JScrollBar scrollbar,
296 * The extent (scroll handle width) deduction gives the true operating range
297 * of possible positions.
299 float fraction = proportion
300 * (scrollbar.getMaximum() - scrollbar.getMinimum()
301 - scrollbar.getModel().getExtent())
302 + (scrollbar.getModel().getExtent() / 2f);
303 return Math.min(Math.round(fraction), scrollbar.getMaximum());
306 public static void jvInitComponent(AbstractButton comp, String i18nString)
308 setColorAndFont(comp);
309 if (i18nString != null && !i18nString.isEmpty())
311 comp.setText(MessageManager.getString(i18nString));
315 public static void jvInitComponent(JComponent comp)
317 setColorAndFont(comp);
320 private static void setColorAndFont(JComponent comp)
322 comp.setBackground(Color.white);
323 comp.setFont(JvSwingUtils.getLabelFont());
327 * A helper method to build a drop-down choice of values, with tooltips for
333 public static JComboBox<String> buildComboWithTooltips(
334 List<String> entries, List<String> tooltips)
336 JComboBox<String> combo = new JComboBox<>();
337 final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer();
338 combo.setRenderer(renderer);
339 for (String attName : entries)
341 combo.addItem(attName);
343 renderer.setTooltips(tooltips);
344 final MouseAdapter mouseListener = new MouseAdapter()
347 public void mouseEntered(MouseEvent e)
349 int j = combo.getSelectedIndex();
352 combo.setToolTipText(tooltips.get(j));
356 public void mouseExited(MouseEvent e)
358 combo.setToolTipText(null);
361 for (Component c : combo.getComponents())
363 c.addMouseListener(mouseListener);
369 * Adds a titled border to the component in the default font and position (top
370 * left), optionally witht italic text
376 public static TitledBorder createTitledBorder(JComponent comp,
377 String title, boolean italic)
379 Font font = comp.getFont();
382 font = new Font(font.getName(), Font.ITALIC, font.getSize());
384 Border border = BorderFactory.createTitledBorder("");
385 TitledBorder titledBorder = BorderFactory.createTitledBorder(border,
386 title, TitledBorder.LEADING, TitledBorder.DEFAULT_POSITION,
388 comp.setBorder(titledBorder);