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
59 static final String HTML_PREFIX = "<html><div style=\"width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;\">";
62 * wrap a bare html safe string to around 60 characters per line using a CSS
63 * style class specifying word-wrap and break-word
66 * if true, add <html> wrapper tags (currently false for only
67 * two references -- both in Jws2Discoverer --
72 public static String wrapTooltip(boolean enclose, String ttext)
74 Objects.requireNonNull(ttext,
75 "Tootip text to format must not be null!");
77 boolean maxLengthExceeded = false;
78 boolean isHTML = ttext.startsWith("<html>");
81 ttext = ttext.substring(6);
83 if (ttext.endsWith("</html>"))
86 ttext = ttext.substring(0, ttext.length() - 7);
88 boolean hasBR = ttext.contains("<br>");
89 enclose |= isHTML || hasBR;
92 String[] htmllines = ttext.split("<br>");
93 for (String line : htmllines)
95 maxLengthExceeded = line.length() > 60;
96 if (maxLengthExceeded)
104 maxLengthExceeded = ttext.length() > 60;
107 if (!maxLengthExceeded)
109 return enclose ? "<html>" + ttext + "</html>" : ttext;
112 return (enclose ? HTML_PREFIX + ttext + "</div></html>" : ttext);
116 public static JButton makeButton(String label, String tooltip,
117 ActionListener action)
119 JButton button = new JButton();
120 button.setText(label);
121 // TODO: get the base font metrics for the Jalview gui from somewhere
122 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
123 button.setForeground(Color.black);
124 button.setHorizontalAlignment(SwingConstants.CENTER);
125 button.setToolTipText(tooltip);
126 button.addActionListener(action);
131 * find or add a submenu with the given title in the given menu
135 * @return the new or existing submenu
137 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
139 JMenu submenuinstance = null;
140 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
142 if (menu.getMenuComponent(i) instanceof JMenu
143 && ((JMenu) menu.getMenuComponent(i)).getText()
146 submenuinstance = (JMenu) menu.getMenuComponent(i);
149 if (submenuinstance == null)
151 submenuinstance = new JMenu(submenu);
152 menu.add(submenuinstance);
154 return submenuinstance;
164 * @return the GUI element created that was added to the layout so it's
165 * attributes can be changed.
167 public static JPanel addtoLayout(JPanel panel, String tooltip,
168 JComponent label, JComponent valBox)
170 JPanel laypanel = new JPanel(new GridLayout(1, 2));
171 JPanel labPanel = new JPanel(new BorderLayout());
172 JPanel valPanel = new JPanel();
173 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
174 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
175 labPanel.add(label, BorderLayout.WEST);
176 valPanel.add(valBox);
177 laypanel.add(labPanel);
178 laypanel.add(valPanel);
179 valPanel.setToolTipText(tooltip);
180 labPanel.setToolTipText(tooltip);
181 valBox.setToolTipText(tooltip);
187 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
188 JLabel jLabel, JComponent name)
190 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
193 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
194 JLabel jLabel, JComponent name, String params)
203 cpanel.add(name, params);
205 name.setToolTipText(tooltip);
206 jLabel.setToolTipText(tooltip);
210 * standard font for labels and check boxes in dialog boxes
215 public static Font getLabelFont()
217 return getLabelFont(false, false);
220 public static Font getLabelFont(boolean bold, boolean italic)
222 return new java.awt.Font("Verdana",
223 (!bold && !italic) ? Font.PLAIN
224 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
229 * standard font for editable text areas
233 public static Font getTextAreaFont()
235 return getLabelFont(false, false);
239 * clean up a swing menu. Removes any empty submenus without selection
244 public static void cleanMenu(JMenu webService)
246 for (int i = 0; i < webService.getItemCount();)
248 JMenuItem item = webService.getItem(i);
249 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
251 webService.remove(i);
261 * Returns the proportion of its range that a scrollbar's position represents,
262 * as a value between 0 and 1. For example if the whole range is from 0 to
263 * 200, then a position of 40 gives proportion = 0.2.
265 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
270 public static float getScrollBarProportion(JScrollBar scroll)
273 * The extent (scroll handle width) deduction gives the true operating range
274 * of possible positions.
276 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
277 - scroll.getModel().getExtent();
278 float valueInRange = scroll.getValue()
279 - (scroll.getModel().getExtent() / 2f);
280 float proportion = valueInRange / possibleRange;
285 * Returns the scroll bar position in its range that would match the given
286 * proportion (between 0 and 1) of the whole. For example if the whole range
287 * is from 0 to 200, then a proportion of 0.25 gives position 50.
293 public static int getScrollValueForProportion(JScrollBar scrollbar,
297 * The extent (scroll handle width) deduction gives the true operating range
298 * of possible positions.
300 float fraction = proportion
301 * (scrollbar.getMaximum() - scrollbar.getMinimum()
302 - scrollbar.getModel().getExtent())
303 + (scrollbar.getModel().getExtent() / 2f);
304 return Math.min(Math.round(fraction), scrollbar.getMaximum());
307 public static void jvInitComponent(AbstractButton comp, String i18nString)
309 setColorAndFont(comp);
310 if (i18nString != null && !i18nString.isEmpty())
312 comp.setText(MessageManager.getString(i18nString));
316 public static void jvInitComponent(JComponent comp)
318 setColorAndFont(comp);
321 private static void setColorAndFont(JComponent comp)
323 comp.setBackground(Color.white);
324 comp.setFont(JvSwingUtils.getLabelFont());
328 * A helper method to build a drop-down choice of values, with tooltips for
334 public static JComboBox<String> buildComboWithTooltips(
335 List<String> entries, List<String> tooltips)
337 JComboBox<String> combo = new JComboBox<>();
338 final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer();
339 combo.setRenderer(renderer);
340 for (String attName : entries)
342 combo.addItem(attName);
344 renderer.setTooltips(tooltips);
345 final MouseAdapter mouseListener = new MouseAdapter()
348 public void mouseEntered(MouseEvent e)
350 int j = combo.getSelectedIndex();
353 combo.setToolTipText(tooltips.get(j));
358 public void mouseExited(MouseEvent e)
360 combo.setToolTipText(null);
363 for (Component c : combo.getComponents())
365 c.addMouseListener(mouseListener);
371 * Adds a titled border to the component in the default font and position (top
372 * left), optionally witht italic text
378 public static TitledBorder createTitledBorder(JComponent comp,
379 String title, boolean italic)
381 Font font = comp.getFont();
384 font = new Font(font.getName(), Font.ITALIC, font.getSize());
386 Border border = BorderFactory.createTitledBorder("");
387 TitledBorder titledBorder = BorderFactory.createTitledBorder(border,
388 title, TitledBorder.LEADING, TitledBorder.DEFAULT_POSITION,
390 comp.setBorder(titledBorder);