src/jalview/gui/JvSwingUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.gui;
  19
  20 import java.awt.Color;
  21 import java.awt.Font;
  22 import java.awt.Rectangle;
  23 import java.awt.event.ActionListener;
  24
  25 import javax.swing.JButton;
  26 import javax.swing.JComponent;
  27 import javax.swing.JLabel;
  28 import javax.swing.JMenu;
  29 import javax.swing.JMenuItem;
  30 import javax.swing.JPanel;
  31 import javax.swing.SwingConstants;
  32
  33 /**
  34  * useful functions for building Swing GUIs
  35  *
  36  * @author JimP
  37  *
  38  */
  39 public final class JvSwingUtils
  40 {
  41   /**
  42    * wrap a bare html safe string to around 60 characters per line using a
  43    * <table width=350>
  44    * <tr>
  45    * <td></td> field
  46    *
  47    * @param ttext
  48    * @return
  49    */
  50   public static String wrapTooltip(String ttext)
  51   {
  52     if (ttext.length() < 60)
  53     {
  54       return ttext;
  55     }
  56     else
  57     {
  58       return "<table width=350 border=0><tr><td>" + ttext
  59               + "</td></tr></table>";
  60     }
  61   }
  62
  63   public static JButton makeButton(String label, String tooltip,
  64           ActionListener action)
  65   {
  66     JButton button = new JButton();
  67     button.setText(label);
  68     // TODO: get the base font metrics for the Jalview gui from somewhere
  69     button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
  70     button.setForeground(Color.black);
  71     button.setHorizontalAlignment(SwingConstants.CENTER);
  72     button.setToolTipText(tooltip);
  73     button.addActionListener(action);
  74     return button;
  75   }
  76
  77   /**
  78    * find or add a submenu with the given title in the given menu
  79    *
  80    * @param menu
  81    * @param submenu
  82    * @return the new or existing submenu
  83    */
  84   public static JMenu findOrCreateMenu(JMenu menu, String submenu)
  85   {
  86     JMenu submenuinstance = null;
  87     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
  88     {
  89       if (menu.getMenuComponent(i) instanceof JMenu
  90               && ((JMenu) menu.getMenuComponent(i)).getText().equals(
  91                       submenu))
  92       {
  93         submenuinstance = (JMenu) menu.getMenuComponent(i);
  94       }
  95     }
  96     if (submenuinstance == null)
  97     {
  98       submenuinstance = new JMenu(submenu);
  99       menu.add(submenuinstance);
 100     }
 101     return submenuinstance;
 102
 103   }
 104
 105   /**
 106    *
 107    * @param panel
 108    * @param tooltip
 109    * @param label
 110    * @param valBox
 111    * @return the GUI element created that was added to the layout so it's
 112    *         attributes can be changed.
 113    */
 114   public static JPanel addtoLayout(JPanel panel, String tooltip,
 115           JComponent label, JComponent valBox)
 116   {
 117     JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
 118     // laypanel.setSize(panel.getPreferredSize());
 119     // laypanel.setLayout(null);
 120     labPanel.setBounds(new Rectangle(7, 7, 158, 23));
 121     valPanel.setBounds(new Rectangle(172, 7, 270, 23));
 122     // labPanel.setLayout(new GridLayout(1,1));
 123     // valPanel.setLayout(new GridLayout(1,1));
 124     labPanel.add(label);
 125     valPanel.add(valBox);
 126     laypanel.add(labPanel);
 127     laypanel.add(valPanel);
 128     valPanel.setToolTipText(tooltip);
 129     labPanel.setToolTipText(tooltip);
 130     valBox.setToolTipText(tooltip);
 131     panel.add(laypanel);
 132     panel.validate();
 133     return laypanel;
 134   }
 135
 136   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 137           JLabel jLabel, JComponent name)
 138   {
 139     mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
 140   }
 141
 142   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 143           JLabel jLabel, JComponent name, String params)
 144   {
 145     cpanel.add(jLabel);
 146     if (params == null)
 147     {
 148       cpanel.add(name);
 149     }
 150     else
 151     {
 152       cpanel.add(name, params);
 153     }
 154     name.setToolTipText(tooltip);
 155     jLabel.setToolTipText(tooltip);
 156   }
 157
 158   /**
 159    * standard font for labels and check boxes in dialog boxes
 160    *
 161    * @return
 162    */
 163
 164   public static Font getLabelFont()
 165   {
 166     return getLabelFont(false, false);
 167   }
 168
 169   public static Font getLabelFont(boolean bold, boolean italic)
 170   {
 171     return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
 172             : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
 173   }
 174
 175   /**
 176    * standard font for editable text areas
 177    *
 178    * @return
 179    */
 180   public static Font getTextAreaFont()
 181   {
 182     return getLabelFont(false, false);
 183   }
 184
 185   /**
 186    * clean up a swing menu. Removes any empty submenus without selection
 187    * listeners.
 188    *
 189    * @param webService
 190    */
 191   public static void cleanMenu(JMenu webService)
 192   {
 193     for (int i = 0; i < webService.getItemCount();)
 194     {
 195       JMenuItem item = webService.getItem(i);
 196       if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
 197       {
 198         webService.remove(i);
 199       }
 200       else
 201       {
 202         i++;
 203       }
 204     }
 205   }
 206
 207 }