src/jalview/gui/JvSwingUtils.java

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