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   public static JButton makeButton(String label, String tooltip,
  63           ActionListener action)
  64   {
  65     JButton button = new JButton();
  66     button.setText(label);
  67     // TODO: get the base font metrics for the Jalview gui from somewhere
  68     button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
  69     button.setForeground(Color.black);
  70     button.setHorizontalAlignment(SwingConstants.CENTER);
  71     button.setToolTipText(tooltip);
  72     button.addActionListener(action);
  73     return button;
  74   }
  75
  76   /**
  77    * find or add a submenu with the given title in the given menu
  78    *
  79    * @param menu
  80    * @param submenu
  81    * @return the new or existing submenu
  82    */
  83   public static JMenu findOrCreateMenu(JMenu menu, String submenu)
  84   {
  85     JMenu submenuinstance = null;
  86     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
  87     {
  88       if (menu.getMenuComponent(i) instanceof JMenu
  89               && ((JMenu) menu.getMenuComponent(i)).getText().equals(
  90                       submenu))
  91       {
  92         submenuinstance = (JMenu) menu.getMenuComponent(i);
  93       }
  94     }
  95     if (submenuinstance == null)
  96     {
  97       submenuinstance = new JMenu(submenu);
  98       menu.add(submenuinstance);
  99     }
 100     return submenuinstance;
 101
 102   }
 103
 104   /**
 105    *
 106    * @param panel
 107    * @param tooltip
 108    * @param label
 109    * @param valBox
 110    * @return the GUI element created that was added to the layout so it's
 111    *         attributes can be changed.
 112    */
 113   public static JPanel addtoLayout(JPanel panel, String tooltip,
 114           JComponent label, JComponent valBox)
 115   {
 116     JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
 117     // laypanel.setSize(panel.getPreferredSize());
 118     // laypanel.setLayout(null);
 119     labPanel.setBounds(new Rectangle(7, 7, 158, 23));
 120     valPanel.setBounds(new Rectangle(172, 7, 270, 23));
 121     // labPanel.setLayout(new GridLayout(1,1));
 122     // valPanel.setLayout(new GridLayout(1,1));
 123     labPanel.add(label);
 124     valPanel.add(valBox);
 125     laypanel.add(labPanel);
 126     laypanel.add(valPanel);
 127     valPanel.setToolTipText(tooltip);
 128     labPanel.setToolTipText(tooltip);
 129     valBox.setToolTipText(tooltip);
 130     panel.add(laypanel);
 131     panel.validate();
 132     return laypanel;
 133   }
 134
 135   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 136           JLabel jLabel, JComponent name)
 137   {
 138     mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
 139   }
 140
 141   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 142           JLabel jLabel, JComponent name, String params)
 143   {
 144     cpanel.add(jLabel);
 145     if (params == null)
 146     {
 147       cpanel.add(name);
 148     }
 149     else
 150     {
 151       cpanel.add(name, params);
 152     }
 153     name.setToolTipText(tooltip);
 154     jLabel.setToolTipText(tooltip);
 155   }
 156
 157   /**
 158    * standard font for labels and check boxes in dialog boxes
 159    *
 160    * @return
 161    */
 162
 163   public static Font getLabelFont()
 164   {
 165     return getLabelFont(false, false);
 166   }
 167
 168   public static Font getLabelFont(boolean bold, boolean italic)
 169   {
 170     return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
 171             : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
 172   }
 173
 174   /**
 175    * standard font for editable text areas
 176    *
 177    * @return
 178    */
 179   public static Font getTextAreaFont()
 180   {
 181     return getLabelFont(false, false);
 182   }
 183
 184   /**
 185    * clean up a swing menu. Removes any empty submenus without selection
 186    * listeners.
 187    *
 188    * @param webService
 189    */
 190   public static void cleanMenu(JMenu webService)
 191   {
 192     for (int i = 0; i < webService.getItemCount();)
 193     {
 194       JMenuItem item = webService.getItem(i);
 195       if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
 196       {
 197         webService.remove(i);
 198       }
 199       else
 200       {
 201         i++;
 202       }
 203     }
 204   }
 205
 206 }