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