X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FJvSwingUtils.java;h=0a765cbb27c21e46eaec86e611420d80b204042e;hb=3d0101179759ef157b088ea135423cd909512d9f;hp=2650eaef6b765338c2a67c1f101e9f1ec964b183;hpb=3bb3bf052916ca69a915a48324a122b0e3f20651;p=jalview.git diff --git a/src/jalview/gui/JvSwingUtils.java b/src/jalview/gui/JvSwingUtils.java index 2650eae..0a765cb 100644 --- a/src/jalview/gui/JvSwingUtils.java +++ b/src/jalview/gui/JvSwingUtils.java @@ -1,33 +1,43 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) - * Copyright (C) 2010 J Procter, AM Waterhouse, 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 jalview.util.MessageManager; + +import java.awt.BorderLayout; import java.awt.Color; import java.awt.Font; +import java.awt.GridLayout; import java.awt.Rectangle; import java.awt.event.ActionListener; +import java.util.Objects; +import javax.swing.AbstractButton; import javax.swing.JButton; 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; /** @@ -39,25 +49,48 @@ import javax.swing.SwingConstants; public final class JvSwingUtils { /** - * 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 * @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(); + boolean maxLengthExceeded = false; + + if (ttext.contains("
")) { - return ttext; + String[] htmllines = ttext.split("
"); + for (String line : htmllines) + { + maxLengthExceeded = line.length() > 60; + if (maxLengthExceeded) + { + break; + } + } } else { - return "
" + ttext - + "
"; + maxLengthExceeded = ttext.length() > 60; } + + if (!maxLengthExceeded) + { + return enclose ? "" + ttext + "" : ttext; + } + + return (enclose ? "" : "") + + "

" + + ttext + "

" + ((enclose ? "" : "")); + } public static JButton makeButton(String label, String tooltip, @@ -87,8 +120,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); } @@ -99,7 +132,7 @@ public final class JvSwingUtils menu.add(submenuinstance); } return submenuinstance; - + } /** @@ -108,18 +141,18 @@ public final class JvSwingUtils * @param tooltip * @param label * @param valBox - * @return the GUI element created that was added to the layout so it's attributes can be changed. + * @return the GUI element created that was added to the layout so it's + * attributes can be changed. */ - public static JPanel addtoLayout(JPanel panel, String tooltip, JComponent label, JComponent valBox) + 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); + JPanel laypanel = new JPanel(new GridLayout(1, 2)); + JPanel labPanel = new JPanel(new BorderLayout()); + JPanel valPanel = new JPanel(); 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.setBounds(new Rectangle(172, 7, 270, 23)); + labPanel.add(label, BorderLayout.WEST); valPanel.add(valBox); laypanel.add(labPanel); laypanel.add(valPanel); @@ -134,41 +167,141 @@ public final class JvSwingUtils public static void mgAddtoLayout(JPanel cpanel, String tooltip, JLabel jLabel, JComponent name) { - mgAddtoLayout(cpanel, tooltip, jLabel, name,null); + mgAddtoLayout(cpanel, tooltip, jLabel, name, null); } + public static void mgAddtoLayout(JPanel cpanel, String tooltip, JLabel jLabel, JComponent name, String params) { cpanel.add(jLabel); - if (params==null) { + if (params == null) + { cpanel.add(name); - } else {cpanel.add(name, params); + } + else + { + cpanel.add(name, params); } name.setToolTipText(tooltip); jLabel.setToolTipText(tooltip); } /** - * standard font for labels and check boxes in dialog boxes + * standard font for labels and check boxes in dialog boxes + * * @return */ public static Font getLabelFont() { - return getLabelFont(false,false); + return getLabelFont(false, false); } + 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); } /** * standard font for editable text areas + * * @return */ public static Font getTextAreaFont() { - return getLabelFont(false,false); + return getLabelFont(false, false); + } + + /** + * clean up a swing menu. Removes any empty submenus without selection + * listeners. + * + * @param webService + */ + public static void cleanMenu(JMenu webService) + { + for (int i = 0; i < webService.getItemCount();) + { + JMenuItem item = webService.getItem(i); + if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0) + { + webService.remove(i); + } + else + { + i++; + } + } + } + + /** + * 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()); } }