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