src/jalview/gui/JvSwingUtils.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.BorderLayout;
  24 import java.awt.Color;
  25 import java.awt.Component;
  26 import java.awt.Font;
  27 import java.awt.GridLayout;
  28 import java.awt.Rectangle;
  29 import java.awt.event.ActionListener;
  30 import java.awt.event.MouseAdapter;
  31 import java.awt.event.MouseEvent;
  32 import java.util.List;
  33 import java.util.Objects;
  34
  35 import javax.swing.AbstractButton;
  36 import javax.swing.BorderFactory;
  37 import javax.swing.JButton;
  38 import javax.swing.JComboBox;
  39 import javax.swing.JComponent;
  40 import javax.swing.JLabel;
  41 import javax.swing.JMenu;
  42 import javax.swing.JMenuItem;
  43 import javax.swing.JPanel;
  44 import javax.swing.JScrollBar;
  45 import javax.swing.SwingConstants;
  46 import javax.swing.border.Border;
  47 import javax.swing.border.TitledBorder;
  48
  49 import jalview.util.MessageManager;
  50
  51 /**
  52  * useful functions for building Swing GUIs
  53  *
  54  * @author JimP
  55  *
  56  */
  57 public final class JvSwingUtils
  58 {
  59   /**
  60    * wrap a bare html safe string to around 60 characters per line using a CSS
  61    * style class specifying word-wrap and break-word
  62    *
  63    * @param enclose
  64    *          if true, add &lt;html&gt; wrapper tags
  65    * @param ttext
  66    *
  67    * @return
  68    */
  69   public static String wrapTooltip(boolean enclose, String ttext)
  70   {
  71     Objects.requireNonNull(ttext,
  72             "Tootip text to format must not be null!");
  73     ttext = ttext.trim();
  74     boolean maxLengthExceeded = false;
  75
  76     if (ttext.contains("<br>"))
  77     {
  78       String[] htmllines = ttext.split("<br>");
  79       for (String line : htmllines)
  80       {
  81         maxLengthExceeded = line.length() > 60;
  82         if (maxLengthExceeded)
  83         {
  84           break;
  85         }
  86       }
  87     }
  88     else
  89     {
  90       maxLengthExceeded = ttext.length() > 60;
  91     }
  92
  93     if (!maxLengthExceeded)
  94     {
  95       return enclose ? "<html>" + ttext + "</html>" : ttext;
  96     }
  97
  98     return (enclose ? "<html>" : "")
  99             // BH 2018
 100             + "<style> div.ttip {width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;}</style><div class=\"ttip\">"
 101             // + "<style> p.ttip {width:350px;margin:-14px 0px -14px
 102             // 0px;padding:2px;overflow-wrap:break-word;}"
 103             // + "</style><p class=\"ttip\">"
 104             + ttext + " </div>"
 105             // + "</p>"
 106             + ((enclose ? "</html>" : ""));
 107   }
 108
 109   public static JButton makeButton(String label, String tooltip,
 110           ActionListener action)
 111   {
 112     JButton button = new JButton();
 113     button.setText(label);
 114     // TODO: get the base font metrics for the Jalview gui from somewhere
 115     button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
 116     button.setForeground(Color.black);
 117     button.setHorizontalAlignment(SwingConstants.CENTER);
 118     button.setToolTipText(tooltip);
 119     button.addActionListener(action);
 120     return button;
 121   }
 122
 123   /**
 124    * find or add a submenu with the given title in the given menu
 125    *
 126    * @param menu
 127    * @param submenu
 128    * @return the new or existing submenu
 129    */
 130   public static JMenu findOrCreateMenu(JMenu menu, String submenu)
 131   {
 132     JMenu submenuinstance = null;
 133     for (int i = 0, iSize = menu.getMenuComponentCount(); i < iSize; i++)
 134     {
 135       if (menu.getMenuComponent(i) instanceof JMenu
 136               && ((JMenu) menu.getMenuComponent(i)).getText()
 137                       .equals(submenu))
 138       {
 139         submenuinstance = (JMenu) menu.getMenuComponent(i);
 140       }
 141     }
 142     if (submenuinstance == null)
 143     {
 144       submenuinstance = new JMenu(submenu);
 145       menu.add(submenuinstance);
 146     }
 147     return submenuinstance;
 148
 149   }
 150
 151   /**
 152    *
 153    * @param panel
 154    * @param tooltip
 155    * @param label
 156    * @param valBox
 157    * @return the GUI element created that was added to the layout so it's
 158    *         attributes can be changed.
 159    */
 160   public static JPanel addtoLayout(JPanel panel, String tooltip,
 161           JComponent label, JComponent valBox)
 162   {
 163     JPanel laypanel = new JPanel(new GridLayout(1, 2));
 164     JPanel labPanel = new JPanel(new BorderLayout());
 165     JPanel valPanel = new JPanel();
 166     labPanel.setBounds(new Rectangle(7, 7, 158, 23));
 167     valPanel.setBounds(new Rectangle(172, 7, 270, 23));
 168     labPanel.add(label, BorderLayout.WEST);
 169     valPanel.add(valBox);
 170     laypanel.add(labPanel);
 171     laypanel.add(valPanel);
 172     valPanel.setToolTipText(tooltip);
 173     labPanel.setToolTipText(tooltip);
 174     valBox.setToolTipText(tooltip);
 175     panel.add(laypanel);
 176     panel.validate();
 177     return laypanel;
 178   }
 179
 180   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 181           JLabel jLabel, JComponent name)
 182   {
 183     mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
 184   }
 185
 186   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
 187           JLabel jLabel, JComponent name, String params)
 188   {
 189     cpanel.add(jLabel);
 190     if (params == null)
 191     {
 192       cpanel.add(name);
 193     }
 194     else
 195     {
 196       cpanel.add(name, params);
 197     }
 198     name.setToolTipText(tooltip);
 199     jLabel.setToolTipText(tooltip);
 200   }
 201
 202   /**
 203    * standard font for labels and check boxes in dialog boxes
 204    *
 205    * @return
 206    */
 207
 208   public static Font getLabelFont()
 209   {
 210     return getLabelFont(false, false);
 211   }
 212
 213   public static Font getLabelFont(boolean bold, boolean italic)
 214   {
 215     return new java.awt.Font("Verdana",
 216             (!bold && !italic) ? Font.PLAIN
 217                     : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0),
 218             11);
 219   }
 220
 221   /**
 222    * standard font for editable text areas
 223    *
 224    * @return
 225    */
 226   public static Font getTextAreaFont()
 227   {
 228     return getLabelFont(false, false);
 229   }
 230
 231   /**
 232    * clean up a swing menu. Removes any empty submenus without selection
 233    * listeners.
 234    *
 235    * @param webService
 236    */
 237   public static void cleanMenu(JMenu webService)
 238   {
 239     for (int i = 0; i < webService.getItemCount();)
 240     {
 241       JMenuItem item = webService.getItem(i);
 242       if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
 243       {
 244         webService.remove(i);
 245       }
 246       else
 247       {
 248         i++;
 249       }
 250     }
 251   }
 252
 253   /**
 254    * Returns the proportion of its range that a scrollbar's position represents,
 255    * as a value between 0 and 1. For example if the whole range is from 0 to
 256    * 200, then a position of 40 gives proportion = 0.2.
 257    *
 258    * @see http://www.javalobby.org/java/forums/t33050.html#91885334
 259    *
 260    * @param scroll
 261    * @return
 262    */
 263   public static float getScrollBarProportion(JScrollBar scroll)
 264   {
 265     /*
 266      * The extent (scroll handle width) deduction gives the true operating range
 267      * of possible positions.
 268      */
 269     int possibleRange = scroll.getMaximum() - scroll.getMinimum()
 270             - scroll.getModel().getExtent();
 271     float valueInRange = scroll.getValue()
 272             - (scroll.getModel().getExtent() / 2f);
 273     float proportion = valueInRange / possibleRange;
 274     return proportion;
 275   }
 276
 277   /**
 278    * Returns the scroll bar position in its range that would match the given
 279    * proportion (between 0 and 1) of the whole. For example if the whole range
 280    * is from 0 to 200, then a proportion of 0.25 gives position 50.
 281    *
 282    * @param scrollbar
 283    * @param proportion
 284    * @return
 285    */
 286   public static int getScrollValueForProportion(JScrollBar scrollbar,
 287           float proportion)
 288   {
 289     /*
 290      * The extent (scroll handle width) deduction gives the true operating range
 291      * of possible positions.
 292      */
 293     float fraction = proportion
 294             * (scrollbar.getMaximum() - scrollbar.getMinimum()
 295                     - scrollbar.getModel().getExtent())
 296             + (scrollbar.getModel().getExtent() / 2f);
 297     return Math.min(Math.round(fraction), scrollbar.getMaximum());
 298   }
 299
 300   public static void jvInitComponent(AbstractButton comp, String i18nString)
 301   {
 302     setColorAndFont(comp);
 303     if (i18nString != null && !i18nString.isEmpty())
 304     {
 305       comp.setText(MessageManager.getString(i18nString));
 306     }
 307   }
 308
 309   public static void jvInitComponent(JComponent comp)
 310   {
 311     setColorAndFont(comp);
 312   }
 313
 314   private static void setColorAndFont(JComponent comp)
 315   {
 316     comp.setBackground(Color.white);
 317     comp.setFont(JvSwingUtils.getLabelFont());
 318   }
 319
 320   /**
 321    * A helper method to build a drop-down choice of values, with tooltips for
 322    * the entries
 323    *
 324    * @param entries
 325    * @param tooltips
 326    */
 327   public static JComboBox<Object> buildComboWithTooltips(
 328           List<Object> entries, List<String> tooltips)
 329   {
 330     JComboBox<Object> combo = new JComboBox<>();
 331     final ComboBoxTooltipRenderer renderer = new ComboBoxTooltipRenderer();
 332     combo.setRenderer(renderer);
 333     for (Object attName : entries)
 334     {
 335       combo.addItem(attName);
 336     }
 337     renderer.setTooltips(tooltips);
 338     final MouseAdapter mouseListener = new MouseAdapter()
 339     {
 340       @Override
 341       public void mouseEntered(MouseEvent e)
 342       {
 343         int j = combo.getSelectedIndex();
 344         if (j > -1)
 345         {
 346           combo.setToolTipText(tooltips.get(j));
 347         }
 348       }
 349
 350       @Override
 351       public void mouseExited(MouseEvent e)
 352       {
 353         combo.setToolTipText(null);
 354       }
 355     };
 356     for (Component c : combo.getComponents())
 357     {
 358       c.addMouseListener(mouseListener);
 359     }
 360     return combo;
 361   }
 362
 363   /**
 364    * Adds a titled border to the component in the default font and position (top
 365    * left), optionally witht italic text
 366    *
 367    * @param comp
 368    * @param title
 369    * @param italic
 370    */
 371   public static TitledBorder createTitledBorder(JComponent comp,
 372           String title, boolean italic)
 373   {
 374     Font font = comp.getFont();
 375     if (italic)
 376     {
 377       font = new Font(font.getName(), Font.ITALIC, font.getSize());
 378     }
 379     Border border = BorderFactory.createTitledBorder("");
 380     TitledBorder titledBorder = BorderFactory.createTitledBorder(border,
 381             title, TitledBorder.LEADING, TitledBorder.DEFAULT_POSITION,
 382             font);
 383     comp.setBorder(titledBorder);
 384
 385     return titledBorder;
 386   }
 387
 388 }