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