X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FJvSwingUtils.java;h=a022c85aa5e9af30856bb6ec6212ed57d9244727;hb=d043ce47fc710d3eb2629ba926a8a7417bd67d8c;hp=ac455bb6972fff6c87de32b56a724070596d40ca;hpb=59d682209891099d46b960509907c79e3fb276fe;p=jalview.git diff --git a/src/jalview/gui/JvSwingUtils.java b/src/jalview/gui/JvSwingUtils.java index ac455bb..a022c85 100644 --- a/src/jalview/gui/JvSwingUtils.java +++ b/src/jalview/gui/JvSwingUtils.java @@ -1,35 +1,51 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8) - * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * * This file is part of Jalview. * * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. * * Jalview is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General Public License along with Jalview. If not, see . + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.gui; import java.awt.Color; +import java.awt.Component; +import java.awt.Container; import java.awt.Font; -import java.awt.Rectangle; import java.awt.event.ActionListener; +import java.awt.event.MouseAdapter; +import java.awt.event.MouseEvent; +import java.util.List; +import java.util.Objects; +import javax.swing.AbstractButton; +import javax.swing.BorderFactory; import javax.swing.JButton; +import javax.swing.JComboBox; import javax.swing.JComponent; import javax.swing.JLabel; import javax.swing.JMenu; import javax.swing.JMenuItem; import javax.swing.JPanel; -import javax.swing.JTextArea; +import javax.swing.JScrollBar; import javax.swing.SwingConstants; +import javax.swing.border.Border; +import javax.swing.border.TitledBorder; + +import jalview.util.MessageManager; +import jalview.util.Platform; /** * useful functions for building Swing GUIs @@ -39,26 +55,59 @@ import javax.swing.SwingConstants; */ public final class JvSwingUtils { + static final String HTML_PREFIX = (Platform.isJS() ? + "
" + : "
" + ); /** - * wrap a bare html safe string to around 60 characters per line using a - * - * - * field + * wrap a bare html safe string to around 60 characters per line using a CSS + * style class specifying word-wrap and break-word * + * @param enclose + * if true, add <html> wrapper tags (currently false for only + * two references -- both in Jws2Discoverer -- * @param ttext + * * @return */ - public static String wrapTooltip(String ttext) + public static String wrapTooltip(boolean enclose, String ttext) { - if (ttext.length() < 60) + Objects.requireNonNull(ttext, + "Tootip text to format must not be null!"); + ttext = ttext.trim().replaceAll("
", "
"); + boolean maxLengthExceeded = false; + + boolean isHTML = ttext.startsWith(""); + if (isHTML) { - return ttext; + ttext = ttext.substring(6); } - else + if (ttext.endsWith("")) + { + isHTML = true; + ttext = ttext.substring(0, ttext.length() - 7); + } + boolean hasBR = ttext.contains("
"); + enclose |= isHTML || hasBR; + if (hasBR) + { + int pt = -1, ptlast = -4; + while ((pt = ttext.indexOf("
", pt + 1)) >= 0) { + if (pt - ptlast - 4 > 60) { + maxLengthExceeded = true; + break; + } + } + } + else { - return "
" + ttext - + "
"; + maxLengthExceeded = ttext.length() > 60; } + + String ret = (!enclose ? ttext : maxLengthExceeded ? HTML_PREFIX + ttext + "
" : + "" + ttext + ""); + //System.out.println("JvSwUtil " + enclose + " " + maxLengthExceeded + " " + ret); + return ret; } public static JButton makeButton(String label, String tooltip, @@ -88,8 +137,8 @@ public final class JvSwingUtils for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++) { if (menu.getMenuComponent(i) instanceof JMenu - && ((JMenu) menu.getMenuComponent(i)).getText().equals( - submenu)) + && ((JMenu) menu.getMenuComponent(i)).getText() + .equals(submenu)) { submenuinstance = (JMenu) menu.getMenuComponent(i); } @@ -104,36 +153,26 @@ public final class JvSwingUtils } /** + * A convenience method that that adds a component with label to a container, + * sets a tooltip on both component and label, and optionally specifies layout + * constraints for the added component (but not the label) * - * @param panel + * @param container * @param tooltip * @param label - * @param valBox - * @return the GUI element created that was added to the layout so it's - * attributes can be changed. + * @param comp + * @param constraints */ - public static JPanel addtoLayout(JPanel panel, String tooltip, - JComponent label, JComponent valBox) - { - JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel(); - // laypanel.setSize(panel.getPreferredSize()); - // laypanel.setLayout(null); - labPanel.setBounds(new Rectangle(7, 7, 158, 23)); - valPanel.setBounds(new Rectangle(172, 7, 270, 23)); - // labPanel.setLayout(new GridLayout(1,1)); - // valPanel.setLayout(new GridLayout(1,1)); - labPanel.add(label); - valPanel.add(valBox); - laypanel.add(labPanel); - laypanel.add(valPanel); - valPanel.setToolTipText(tooltip); - labPanel.setToolTipText(tooltip); - valBox.setToolTipText(tooltip); - panel.add(laypanel); - panel.validate(); - return laypanel; + public static void addtoLayout(Container container, String tooltip, + JComponent label, JComponent comp, String constraints) + { + container.add(label); + container.add(comp, constraints); + comp.setToolTipText(tooltip); // this doesn't seem to show? + label.setToolTipText(tooltip); } + // From 2.11.2 merge public static void mgAddtoLayout(JPanel cpanel, String tooltip, JLabel jLabel, JComponent name) { @@ -169,8 +208,10 @@ public final class JvSwingUtils public static Font getLabelFont(boolean bold, boolean italic) { - return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN - : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11); + return new java.awt.Font("Verdana", + (!bold && !italic) ? Font.PLAIN + : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), + 11); } /** @@ -205,4 +246,138 @@ public final class JvSwingUtils } } + /** + * Returns the proportion of its range that a scrollbar's position represents, + * as a value between 0 and 1. For example if the whole range is from 0 to + * 200, then a position of 40 gives proportion = 0.2. + * + * @see http://www.javalobby.org/java/forums/t33050.html#91885334 + * + * @param scroll + * @return + */ + public static float getScrollBarProportion(JScrollBar scroll) + { + /* + * The extent (scroll handle width) deduction gives the true operating range + * of possible positions. + */ + int possibleRange = scroll.getMaximum() - scroll.getMinimum() + - scroll.getModel().getExtent(); + float valueInRange = scroll.getValue() + - (scroll.getModel().getExtent() / 2f); + float proportion = valueInRange / possibleRange; + return proportion; + } + + /** + * Returns the scroll bar position in its range that would match the given + * proportion (between 0 and 1) of the whole. For example if the whole range + * is from 0 to 200, then a proportion of 0.25 gives position 50. + * + * @param scrollbar + * @param proportion + * @return + */ + public static int getScrollValueForProportion(JScrollBar scrollbar, + float proportion) + { + /* + * The extent (scroll handle width) deduction gives the true operating range + * of possible positions. + */ + float fraction = proportion + * (scrollbar.getMaximum() - scrollbar.getMinimum() + - scrollbar.getModel().getExtent()) + + (scrollbar.getModel().getExtent() / 2f); + return Math.min(Math.round(fraction), scrollbar.getMaximum()); + } + + public static void jvInitComponent(AbstractButton comp, String i18nString) + { + setColorAndFont(comp); + if (i18nString != null && !i18nString.isEmpty()) + { + comp.setText(MessageManager.getString(i18nString)); + } + } + + public static void jvInitComponent(JComponent comp) + { + setColorAndFont(comp); + } + + private static void setColorAndFont(JComponent comp) + { + comp.setBackground(Color.white); + comp.setFont(JvSwingUtils.getLabelFont()); + } + + /** + * A helper method to build a drop-down choice of values, with tooltips for + * the entries + * + * @param entries + * @param tooltips + */ + public static JComboBox buildComboWithTooltips( + List entries, List tooltips) + { + JComboBox combo = new JComboBox<>(); + final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer(); + combo.setRenderer(renderer); + for (Object attName : entries) + { + combo.addItem(attName); + } + renderer.setTooltips(tooltips); + final MouseAdapter mouseListener = new MouseAdapter() + { + @Override + public void mouseEntered(MouseEvent e) + { + int j = combo.getSelectedIndex(); + if (j > -1) + { + combo.setToolTipText(tooltips.get(j)); + } + } + @Override + public void mouseExited(MouseEvent e) + { + combo.setToolTipText(null); + } + }; + for (Component c : combo.getComponents()) + { + c.addMouseListener(mouseListener); + } + return combo; + } + + /** + * Adds a titled border to the component in the default font and position (top + * left), optionally with italic text + * + * @param comp + * @param title + * @param italic + */ + public static TitledBorder createTitledBorder(JComponent comp, + String title, boolean italic) + { + Font font = comp.getFont(); + if (italic) + { + font = new Font(font.getName(), Font.ITALIC, font.getSize()); + } + Border border = BorderFactory.createTitledBorder(""); + TitledBorder titledBorder = BorderFactory.createTitledBorder(border, + title, TitledBorder.LEADING, TitledBorder.DEFAULT_POSITION, + font); + comp.setBorder(titledBorder); + + return titledBorder; + } + }