JAL-1683 replace year/version strings with tokens in source
[jalview.git] / src / jalview / gui / JvSwingUtils.java
index b921a81..c5dd7b6 100644 (file)
@@ -1,34 +1,39 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
+import jalview.util.MessageManager;
+
 import java.awt.Color;
 import java.awt.Font;
 import java.awt.Rectangle;
 import java.awt.event.ActionListener;
 
+import javax.swing.AbstractButton;
 import javax.swing.JButton;
 import javax.swing.JComponent;
 import javax.swing.JLabel;
 import javax.swing.JMenu;
 import javax.swing.JMenuItem;
 import javax.swing.JPanel;
-import javax.swing.JTextArea;
 import javax.swing.SwingConstants;
 
 /**
@@ -44,20 +49,22 @@ public final class JvSwingUtils
    * <table width=350>
    * <tr>
    * <td></td> field
+ * @param enclose TODO
+ * @param ttext
    * 
-   * @param ttext
    * @return
    */
-  public static String wrapTooltip(String ttext)
+  public static String wrapTooltip(boolean enclose, String ttext)
   {
     if (ttext.length() < 60)
     {
-      return ttext;
+      return enclose ? "<html>" + ttext + "</html>" : ttext;
     }
     else
     {
-      return "<table width=350 border=0><tr><td>" + ttext
-              + "</td></tr></table>";
+      return (enclose ? "<html>" : "")
+              + "<table width=350 border=0><tr><td>" + ttext
+              + "</td></tr></table>" + ((enclose ? "</html>" : ""));
     }
   }
 
@@ -100,7 +107,7 @@ public final class JvSwingUtils
       menu.add(submenuinstance);
     }
     return submenuinstance;
-  
+
   }
 
   /**
@@ -109,17 +116,19 @@ public final class JvSwingUtils
    * @param tooltip
    * @param label
    * @param valBox
-   * @return the GUI element created that was added to the layout so it's attributes can be changed.
+   * @return the GUI element created that was added to the layout so it's
+   *         attributes can be changed.
    */
-  public static JPanel addtoLayout(JPanel panel, String tooltip, JComponent label, JComponent valBox)
+  public static JPanel addtoLayout(JPanel panel, String tooltip,
+          JComponent label, JComponent valBox)
   {
-    JPanel laypanel = new JPanel(),labPanel=new JPanel(), valPanel=new JPanel();
+    JPanel laypanel = new JPanel(), labPanel = new JPanel(), valPanel = new JPanel();
     // laypanel.setSize(panel.getPreferredSize());
     // laypanel.setLayout(null);
     labPanel.setBounds(new Rectangle(7, 7, 158, 23));
-    valPanel.setBounds(new Rectangle(172, 7, 270,23));
-    //labPanel.setLayout(new GridLayout(1,1));
-    //valPanel.setLayout(new GridLayout(1,1));
+    valPanel.setBounds(new Rectangle(172, 7, 270, 23));
+    // labPanel.setLayout(new GridLayout(1,1));
+    // valPanel.setLayout(new GridLayout(1,1));
     labPanel.add(label);
     valPanel.add(valBox);
     laypanel.add(labPanel);
@@ -135,60 +144,92 @@ public final class JvSwingUtils
   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
           JLabel jLabel, JComponent name)
   {
-    mgAddtoLayout(cpanel, tooltip, jLabel, name,null);
+    mgAddtoLayout(cpanel, tooltip, jLabel, name, null);
   }
+
   public static void mgAddtoLayout(JPanel cpanel, String tooltip,
           JLabel jLabel, JComponent name, String params)
   {
     cpanel.add(jLabel);
-    if (params==null) {
+    if (params == null)
+    {
       cpanel.add(name);
-    } else {cpanel.add(name, params);
+    }
+    else
+    {
+      cpanel.add(name, params);
     }
     name.setToolTipText(tooltip);
     jLabel.setToolTipText(tooltip);
   }
 
   /**
-   * standard font for labels and check boxes in dialog boxes 
+   * standard font for labels and check boxes in dialog boxes
+   * 
    * @return
    */
 
   public static Font getLabelFont()
   {
-    return getLabelFont(false,false);
+    return getLabelFont(false, false);
   }
+
   public static Font getLabelFont(boolean bold, boolean italic)
   {
-    return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
+    return new java.awt.Font("Verdana", (!bold && !italic) ? Font.PLAIN
+            : (bold ? Font.BOLD : 0) + (italic ? Font.ITALIC : 0), 11);
   }
 
   /**
    * standard font for editable text areas
+   * 
    * @return
    */
   public static Font getTextAreaFont()
   {
-    return getLabelFont(false,false);
+    return getLabelFont(false, false);
   }
 
   /**
-   * clean up a swing menu. 
-   * Removes any empty submenus without selection listeners.
+   * clean up a swing menu. Removes any empty submenus without selection
+   * listeners.
+   * 
    * @param webService
    */
   public static void cleanMenu(JMenu webService)
   {
-    for (int i=0;i<webService.getItemCount(); )
+    for (int i = 0; i < webService.getItemCount();)
     {
       JMenuItem item = webService.getItem(i);
-      if (item instanceof JMenu && ((JMenu)item).getItemCount()==0)
+      if (item instanceof JMenu && ((JMenu) item).getItemCount() == 0)
       {
         webService.remove(i);
-      } else {
+      }
+      else
+      {
         i++;
       }
     }
   }
 
+  public static void jvInitComponent(AbstractButton comp, String i18nString)
+  {
+    setColorAndFont(comp);
+    if (i18nString != null && !i18nString.isEmpty())
+    {
+      comp.setText(MessageManager.getString(i18nString));
+    }
+  }
+
+  public static void jvInitComponent(JComponent comp)
+  {
+    setColorAndFont(comp);
+  }
+
+  private static void setColorAndFont(JComponent comp)
+  {
+    comp.setBackground(Color.white);
+    comp.setFont(JvSwingUtils.getLabelFont());
+  }
+
 }