src/jalview/gui/JvSwingUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.util.MessageManager;
  24
  25 import java.awt.BorderLayout;
  26 import java.awt.Color;
  27 import java.awt.Font;
  28 import java.awt.GridLayout;
  29 import java.awt.Rectangle;
  30 import java.awt.event.ActionListener;
  31 import java.util.Objects;
  32
  33 import javax.swing.AbstractButton;
  34 import javax.swing.JButton;
  35 import javax.swing.JComponent;
  36 import javax.swing.JLabel;
  37 import javax.swing.JMenu;
  38 import javax.swing.JMenuItem;
  39 import javax.swing.JPanel;
  40 import javax.swing.JScrollBar;
  41 import javax.swing.SwingConstants;
  42
  43 /**
  44  * useful functions for building Swing GUIs
  45  *
  46  * @author JimP
  47  *
  48  */
  49 public final class JvSwingUtils
  50 {
  51   /**
  52    * wrap a bare html safe string to around 60 characters per line using a CSS
  53    * style class specifying word-wrap and break-word
  54    *
  55    * @param enclose
  56    *          if true, add &lt;html&gt; wrapper tags
  57    * @param ttext
  58    *
  59    * @return
  60    */
  61   public static String wrapTooltip(boolean enclose, String ttext)
  62   {
  63     Objects.requireNonNull(ttext,
  64             "Tootip text to format must not be null!");
  65     ttext = ttext.trim();
  66     boolean maxLengthExceeded = false;
  67
  68     if (ttext.contains("<br>"))
  69     {
  70       String[] htmllines = ttext.split("<br>");
  71       for (String line : htmllines)
  72       {
  73         maxLengthExceeded = line.length() > 60;
  74         if (maxLengthExceeded)
  75         {
  76           break;
  77         }
  78       }
  79     }
  80     else
  81     {
  82       maxLengthExceeded = ttext.length() > 60;
  83     }
  84
  85     if (!maxLengthExceeded)
  86     {
  87       return enclose ? "<html>" + ttext + "</html>" : ttext;
  88     }
  89
  90     return (enclose ? "<html>" : "")
  91             + "<style> p.ttip {width: 350; text-align: justify; word-wrap: break-word;}</style><p class=\"ttip\">"
  92             + ttext + "</p>" + ((enclose ? "</html>" : ""));
  93
  94   }
  95
  96   public static JButton makeButton(String label, String tooltip,
  97           ActionListener action)
  98   {
  99     JButton button = new JButton();
 100     button.setText(label);
 101     // TODO: get the base font metrics for the Jalview gui from somewhere
 102     button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
 103     button.setForeground(Color.black);
 104     button.setHorizontalAlignment(SwingConstants.CENTER);
 105     button.setToolTipText(tooltip);
 106     button.addActionListener(action);
 107     return button;
 108   }
 109
 110   /**
 111    * find or add a submenu with the given title in the given menu
 112    *
 113    * @param menu
 114    * @param submenu
 115    * @return the new or existing submenu
 116    */
 117   public static JMenu findOrCreateMenu(JMenu menu, String submenu)
 118   {
 119     JMenu submenuinstance = null;
 120     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
 121     {
 122       if (menu.getMenuComponent(i) instanceof JMenu
 123               && ((JMenu) menu.getMenuComponent(i)).getText()
 124                       .equals(submenu))
 125       {
 126         submenuinstance = (JMenu) menu.getMenuComponent(i);
 127       }
 128     }
 129     if (submenuinstance == null)
 130     {
 131       submenuinstance = new JMenu(submenu);
 132       menu.add(submenuinstance);
 133     }
 134     return submenuinstance;
 135
 136   }
 137
 138   /**
 139    *
 140    * @param panel
 141    * @param tooltip
 142    * @param label
 143    * @param valBox
 144    * @return the GUI element created that was added to the layout so it's
 145    *         attributes can be changed.
 146    */
 147   public static JPanel addtoLayout(JPanel panel, String tooltip,
 148           JComponent label, JComponent valBox)
 149   {
 150     JPanel laypanel = new JPanel(new GridLayout(1, 2));
 151     JPanel labPanel = new JPanel(new BorderLayout());
 152     JPanel valPanel = new JPanel();
 153     labPanel.setBounds(new Rectangle(7, 7, 158, 23));
 154     valPanel.setBounds(new Rectangle(172, 7, 270, 23));
 155     labPanel.add(label, BorderLayout.WEST);
 156     valPanel.add(valBox);
 157     laypanel.add(labPanel);
 158     laypanel.add(valPanel);
 159     valPanel.setToolTipText(tooltip);
 160     labPanel.setToolTipText(tooltip);
 161     valBox.setToolTipText(tooltip);
 162     panel.add(laypanel);
 163     panel.validate();
 164     return laypanel;
 165   }
 166
 167   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 168           JLabel jLabel, JComponent name)
 169   {
 170     mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
 171   }
 172
 173   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 174           JLabel jLabel, JComponent name, String params)
 175   {
 176     cpanel.add(jLabel);
 177     if (params == null)
 178     {
 179       cpanel.add(name);
 180     }
 181     else
 182     {
 183       cpanel.add(name, params);
 184     }
 185     name.setToolTipText(tooltip);
 186     jLabel.setToolTipText(tooltip);
 187   }
 188
 189   /**
 190    * standard font for labels and check boxes in dialog boxes
 191    *
 192    * @return
 193    */
 194
 195   public static Font getLabelFont()
 196   {
 197     return getLabelFont(false, false);
 198   }
 199
 200   public static Font getLabelFont(boolean bold, boolean italic)
 201   {
 202     return new java.awt.Font("Verdana",
 203             (!bold && !italic) ? Font.PLAIN
 204                     : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
 205             11);
 206   }
 207
 208   /**
 209    * standard font for editable text areas
 210    *
 211    * @return
 212    */
 213   public static Font getTextAreaFont()
 214   {
 215     return getLabelFont(false, false);
 216   }
 217
 218   /**
 219    * clean up a swing menu. Removes any empty submenus without selection
 220    * listeners.
 221    *
 222    * @param webService
 223    */
 224   public static void cleanMenu(JMenu webService)
 225   {
 226     for (int i = 0; i < webService.getItemCount();)
 227     {
 228       JMenuItem item = webService.getItem(i);
 229       if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
 230       {
 231         webService.remove(i);
 232       }
 233       else
 234       {
 235         i++;
 236       }
 237     }
 238   }
 239
 240   /**
 241    * Returns the proportion of its range that a scrollbar's position represents,
 242    * as a value between 0 and 1. For example if the whole range is from 0 to
 243    * 200, then a position of 40 gives proportion = 0.2.
 244    *
 245    * @see http://www.javalobby.org/java/forums/t33050.html#91885334
 246    *
 247    * @param scroll
 248    * @return
 249    */
 250   public static float getScrollBarProportion(JScrollBar scroll)
 251   {
 252     /*
 253      * The extent (scroll handle width) deduction gives the true operating range
 254      * of possible positions.
 255      */
 256     int possibleRange = scroll.getMaximum() - scroll.getMinimum()
 257             - scroll.getModel().getExtent();
 258     float valueInRange = scroll.getValue()
 259             - (scroll.getModel().getExtent() / 2f);
 260     float proportion = valueInRange / possibleRange;
 261     return proportion;
 262   }
 263
 264   /**
 265    * Returns the scroll bar position in its range that would match the given
 266    * proportion (between 0 and 1) of the whole. For example if the whole range
 267    * is from 0 to 200, then a proportion of 0.25 gives position 50.
 268    *
 269    * @param scrollbar
 270    * @param proportion
 271    * @return
 272    */
 273   public static int getScrollValueForProportion(JScrollBar scrollbar,
 274           float proportion)
 275   {
 276     /*
 277      * The extent (scroll handle width) deduction gives the true operating range
 278      * of possible positions.
 279      */
 280     float fraction = proportion
 281             * (scrollbar.getMaximum() - scrollbar.getMinimum()
 282                     - scrollbar.getModel().getExtent())
 283             + (scrollbar.getModel().getExtent() / 2f);
 284     return Math.min(Math.round(fraction), scrollbar.getMaximum());
 285   }
 286
 287   public static void jvInitComponent(AbstractButton comp, String i18nString)
 288   {
 289     setColorAndFont(comp);
 290     if (i18nString != null && !i18nString.isEmpty())
 291     {
 292       comp.setText(MessageManager.getString(i18nString));
 293     }
 294   }
 295
 296   public static void jvInitComponent(JComponent comp)
 297   {
 298     setColorAndFont(comp);
 299   }
 300
 301   private static void setColorAndFont(JComponent comp)
 302   {
 303     comp.setBackground(Color.white);
 304     comp.setFont(JvSwingUtils.getLabelFont());
 305   }
 306
 307 }