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;
25 import java.awt.Component;
27 import java.awt.GridLayout;
28 import java.awt.Rectangle;
29 import java.awt.event.ActionListener;
30 import java.awt.event.MouseAdapter;
31 import java.awt.event.MouseEvent;
32 import java.util.List;
33 import java.util.Objects;
35 import javax.swing.AbstractButton;
36 import javax.swing.BorderFactory;
37 import javax.swing.JButton;
38 import javax.swing.JComboBox;
39 import javax.swing.JComponent;
40 import javax.swing.JLabel;
41 import javax.swing.JMenu;
42 import javax.swing.JMenuItem;
43 import javax.swing.JPanel;
44 import javax.swing.JScrollBar;
45 import javax.swing.SwingConstants;
46 import javax.swing.border.Border;
47 import javax.swing.border.TitledBorder;
49 import jalview.util.MessageManager;
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!");
77 boolean maxLengthExceeded = false;
79 boolean hasBr = false;
80 for (String br : new String[] { "<br>", "<br/>" })
82 if (ttext.contains(br))
85 String[] htmllines = ttext.split(br);
86 StringBuilder sb = new StringBuilder();
87 for (String line : htmllines)
91 line = line.replaceAll("\\s+", " ");
94 if (line.length() == 0 || line.equals(" "))
98 String linetext = line.replaceAll("<[^>]+>", "");
99 maxLengthExceeded = linetext.length() > 60;
106 ttext = sb.toString();
111 ttext = ttext.replaceAll("\\s+", " ");
112 ttext = ttext.trim();
116 maxLengthExceeded = ttext.length() > 60;
119 if (!maxLengthExceeded)
121 return enclose ? "<html>" + ttext + "</html>" : ttext;
124 return (enclose ? "<html>" : "")
126 + "<style> div.ttip {width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;}</style><div class=\"ttip\">"
127 // + "<style> p.ttip {width:350px;margin:-14px 0px -14px
128 // 0px;padding:2px;overflow-wrap:break-word;}"
129 // + "</style><p class=\"ttip\">"
132 + ((enclose ? "</html>" : ""));
135 public static JButton makeButton(String label, String tooltip,
136 ActionListener action)
138 JButton button = new JButton();
139 button.setText(label);
140 // TODO: get the base font metrics for the Jalview gui from somewhere
141 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
142 button.setForeground(Color.black);
143 button.setHorizontalAlignment(SwingConstants.CENTER);
144 button.setToolTipText(tooltip);
145 button.addActionListener(action);
150 * find or add a submenu with the given title in the given menu
154 * @return the new or existing submenu
156 public static JMenu findOrCreateMenu(JMenu menu, String submenu)
158 JMenu submenuinstance = null;
159 for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
161 if (menu.getMenuComponent(i) instanceof JMenu
162 && ((JMenu) menu.getMenuComponent(i)).getText()
165 submenuinstance = (JMenu) menu.getMenuComponent(i);
168 if (submenuinstance == null)
170 submenuinstance = new JMenu(submenu);
171 menu.add(submenuinstance);
173 return submenuinstance;
183 * @return the GUI element created that was added to the layout so it's
184 * attributes can be changed.
186 public static JPanel addtoLayout(JPanel panel, String tooltip,
187 JComponent label, JComponent valBox)
189 JPanel laypanel = new JPanel(new GridLayout(1, 2));
190 JPanel labPanel = new JPanel(new BorderLayout());
191 JPanel valPanel = new JPanel();
192 labPanel.setBounds(new Rectangle(7, 7, 158, 23));
193 valPanel.setBounds(new Rectangle(172, 7, 270, 23));
194 labPanel.add(label, BorderLayout.WEST);
195 valPanel.add(valBox);
196 laypanel.add(labPanel);
197 laypanel.add(valPanel);
198 valPanel.setToolTipText(tooltip);
199 labPanel.setToolTipText(tooltip);
200 valBox.setToolTipText(tooltip);
206 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
207 JLabel jLabel, JComponent name)
209 mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
212 public static void mgAddtoLayout(JPanel cpanel, String tooltip,
213 JLabel jLabel, JComponent name, String params)
222 cpanel.add(name, params);
224 name.setToolTipText(tooltip);
225 jLabel.setToolTipText(tooltip);
229 * standard font for labels and check boxes in dialog boxes
234 public static Font getLabelFont()
236 return getLabelFont(false, false);
239 public static Font getLabelFont(boolean bold, boolean italic)
241 return new java.awt.Font("Verdana",
242 (!bold && !italic) ? Font.PLAIN
243 : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
248 * standard font for editable text areas
252 public static Font getTextAreaFont()
254 return getLabelFont(false, false);
258 * clean up a swing menu. Removes any empty submenus without selection
263 public static void cleanMenu(JMenu webService)
265 for (int i = 0; i < webService.getItemCount();)
267 JMenuItem item = webService.getItem(i);
268 if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
270 webService.remove(i);
280 * Returns the proportion of its range that a scrollbar's position represents,
281 * as a value between 0 and 1. For example if the whole range is from 0 to
282 * 200, then a position of 40 gives proportion = 0.2.
284 * @see http://www.javalobby.org/java/forums/t33050.html#91885334
289 public static float getScrollBarProportion(JScrollBar scroll)
292 * The extent (scroll handle width) deduction gives the true operating range
293 * of possible positions.
295 int possibleRange = scroll.getMaximum() - scroll.getMinimum()
296 - scroll.getModel().getExtent();
297 float valueInRange = scroll.getValue()
298 - (scroll.getModel().getExtent() / 2f);
299 float proportion = valueInRange / possibleRange;
304 * Returns the scroll bar position in its range that would match the given
305 * proportion (between 0 and 1) of the whole. For example if the whole range
306 * is from 0 to 200, then a proportion of 0.25 gives position 50.
312 public static int getScrollValueForProportion(JScrollBar scrollbar,
316 * The extent (scroll handle width) deduction gives the true operating range
317 * of possible positions.
319 float fraction = proportion
320 * (scrollbar.getMaximum() - scrollbar.getMinimum()
321 - scrollbar.getModel().getExtent())
322 + (scrollbar.getModel().getExtent() / 2f);
323 return Math.min(Math.round(fraction), scrollbar.getMaximum());
326 public static void jvInitComponent(AbstractButton comp, String i18nString)
328 setColorAndFont(comp);
329 if (i18nString != null && !i18nString.isEmpty())
331 comp.setText(MessageManager.getString(i18nString));
335 public static void jvInitComponent(JComponent comp)
337 setColorAndFont(comp);
340 private static void setColorAndFont(JComponent comp)
342 comp.setBackground(Color.white);
343 comp.setFont(JvSwingUtils.getLabelFont());
347 * A helper method to build a drop-down choice of values, with tooltips for
353 public static JComboBox<Object> buildComboWithTooltips(
354 List<Object> entries, List<String> tooltips)
356 JComboBox<Object> combo = new JComboBox<>();
357 final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer();
358 combo.setRenderer(renderer);
359 for (Object attName : entries)
361 combo.addItem(attName);
363 renderer.setTooltips(tooltips);
364 final MouseAdapter mouseListener = new MouseAdapter()
367 public void mouseEntered(MouseEvent e)
369 int j = combo.getSelectedIndex();
372 combo.setToolTipText(tooltips.get(j));
377 public void mouseExited(MouseEvent e)
379 combo.setToolTipText(null);
382 for (Component c : combo.getComponents())
384 c.addMouseListener(mouseListener);
390 * Adds a titled border to the component in the default font and position (top
391 * left), optionally witht italic text
397 public static TitledBorder createTitledBorder(JComponent comp,
398 String title, boolean italic)
400 Font font = comp.getFont();
403 font = new Font(font.getName(), Font.ITALIC, font.getSize());
405 Border border = BorderFactory.createTitledBorder("");
406 TitledBorder titledBorder = BorderFactory.createTitledBorder(border,
407 title, TitledBorder.LEADING, TitledBorder.DEFAULT_POSITION,
409 comp.setBorder(titledBorder);