src/jalview/gui/JvSwingUtils.java

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