JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / appletgui / Tooltip.java
index 6766330..e16c594 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-\r
-package jalview.appletgui;\r
-\r
-import java.awt.*;\r
-import java.applet.*;\r
-import java.awt.event.*;\r
-import java.util.*;\r
-\r
-public class Tooltip extends Canvas implements MouseListener,\r
-    MouseMotionListener\r
-{\r
-        private String [] tip;\r
-        private String lastTip="";\r
-        private boolean setPosition = false;\r
-        protected Component owner;\r
-\r
-        private Container mainContainer;\r
-        private LayoutManager mainLayout;\r
-\r
-        private boolean shown;\r
-\r
-        private final int VERTICAL_OFFSET = 20;\r
-        private final int HORIZONTAL_ENLARGE = 10;\r
-\r
-        int fontHeight = 0;\r
-\r
-        Image linkImage;\r
-\r
-        FontMetrics fm;\r
-\r
-        public Tooltip(String tip, Component owner)\r
-        {\r
-          this.owner = owner;\r
-          owner.addMouseListener(this);\r
-          owner.addMouseMotionListener(this);\r
-          setBackground(new Color(255, 255, 220));\r
-          setTip(tip);\r
-          java.net.URL url = getClass().getResource("/images/link.gif");\r
-          if (url != null)\r
-          {\r
-            linkImage = java.awt.Toolkit.getDefaultToolkit().getImage(url);\r
-          }\r
-        }\r
-\r
-        public void paint(Graphics g)\r
-        {\r
-          int w = getSize().width;\r
-          int h = getSize().height;\r
-\r
-          g.drawRect(0, 0, w - 1, h - 1);\r
-          int lindex, x;\r
-          for (int i = 0; i < tip.length; i++)\r
-          {\r
-            x = 3;\r
-            lindex = tip[i].indexOf("%LINK%");\r
-            if (lindex != -1)\r
-            {\r
-              if (lindex > 0)\r
-              {\r
-                g.drawString(tip[i].substring(0, lindex), 3, (i + 1) * fontHeight - 3);\r
-                x += fm.stringWidth(tip[i].substring(0, lindex) + 3);\r
-              }\r
-              g.drawImage(linkImage, x, i * fontHeight + 1, this);\r
-              if (lindex + 6 < tip[i].length())\r
-              {\r
-                g.drawString(tip[i].substring(lindex + 6),\r
-                             x + linkImage.getWidth(this),\r
-                             (i + 1) * fontHeight - 3);\r
-              }\r
-            }\r
-            else\r
-            {\r
-              g.drawString(tip[i], 3, (i + 1) * fontHeight - 3);\r
-            }\r
-          }\r
-        }\r
-\r
-        synchronized void setTip(String tip)\r
-        {\r
-          if(tip==null)\r
-          {\r
-            setTip("");\r
-            return;\r
-          }\r
-\r
-          if(lastTip.equals(tip))\r
-            return;\r
-\r
-          lastTip = tip;\r
-          setPosition = true;\r
-\r
-          fm = getFontMetrics(owner.getFont());\r
-          fontHeight = fm.getHeight();\r
-\r
-          int longestLine = 0;\r
-          StringTokenizer st = new StringTokenizer(tip, "\n");\r
-          this.tip = new String[st.countTokens()];\r
-          int index = 0;\r
-          while(st.hasMoreElements())\r
-          {\r
-            this.tip[index] = st.nextToken();\r
-            if(fm.stringWidth(this.tip[index])>longestLine)\r
-              longestLine = fm.stringWidth(this.tip[index]);\r
-            index ++;\r
-          }\r
-\r
-          setSize(longestLine + HORIZONTAL_ENLARGE,\r
-                  fontHeight*this.tip.length);\r
-\r
-          repaint();\r
-\r
-        }\r
-\r
-        void setTipLocation(MouseEvent evt)\r
-        {\r
-          setLocation( (owner.getLocationOnScreen().x\r
-                        - mainContainer.getLocationOnScreen().x) + evt.getX(),\r
-                      (owner.getLocationOnScreen().y -\r
-                       mainContainer.getLocationOnScreen().y\r
-                       + VERTICAL_OFFSET) + evt.getY());\r
-\r
-        // correction, whole tool tip must be visible\r
-          if (mainContainer.getSize().width < (getLocation().x + getSize().width))\r
-          {\r
-            setLocation(mainContainer.getSize().width - getSize().width,\r
-                        getLocation().y);\r
-          }\r
-        }\r
-\r
-\r
-        private void removeToolTip() {\r
-                if (shown) {\r
-                        mainContainer.remove(0);\r
-                        mainContainer.setLayout(mainLayout);\r
-                        mainContainer.validate();\r
-                }\r
-                shown = false;\r
-        }\r
-\r
-        private void findMainContainer() {\r
-                Container parent = owner.getParent();\r
-                while (true) {\r
-                        if ((parent instanceof Applet) || (parent instanceof Frame)) {\r
-                                mainContainer = parent;\r
-                                break;\r
-                        } else {\r
-                                parent = parent.getParent();\r
-                        }\r
-                }\r
-                mainLayout = mainContainer.getLayout();\r
-        }\r
-\r
-        public void mouseEntered(MouseEvent me)\r
-        {\r
-          setTipLocation(me);\r
-        }\r
-\r
-        public void mouseExited(MouseEvent me)\r
-        {\r
-          removeToolTip();\r
-        }\r
-\r
-        public void mousePressed(MouseEvent me)\r
-        {\r
-          removeToolTip();\r
-        }\r
-\r
-        public void mouseReleased(MouseEvent me)\r
-        {}\r
-\r
-        public void mouseClicked(MouseEvent me)\r
-        {}\r
-\r
-        public void mouseMoved(MouseEvent me)\r
-        {\r
-         if(!shown)\r
-          {\r
-            findMainContainer();\r
-            mainContainer.setLayout(null);\r
-            mainContainer.add(this, 0);\r
-            mainContainer.validate();\r
-            shown = true;\r
-            setTipLocation(me);\r
-          }\r
-          else if (setPosition)\r
-          {\r
-            setTipLocation(me);\r
-            setPosition = false;\r
-          }\r
-        }\r
-\r
-        public void mouseDragged(MouseEvent me)\r
-        {}\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package jalview.appletgui;
+
+import java.applet.Applet;
+import java.awt.Canvas;
+import java.awt.Color;
+import java.awt.Component;
+import java.awt.Container;
+import java.awt.FontMetrics;
+import java.awt.Frame;
+import java.awt.Graphics;
+import java.awt.Image;
+import java.awt.LayoutManager;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.util.StringTokenizer;
+
+public class Tooltip extends Canvas implements MouseListener,
+        MouseMotionListener
+{
+  private String[] tip;
+
+  private String lastTip = "";
+
+  private boolean setPosition = false;
+
+  protected Component owner;
+
+  private Container mainContainer;
+
+  private LayoutManager mainLayout;
+
+  private boolean shown;
+
+  private final int VERTICAL_OFFSET = 20;
+
+  private final int HORIZONTAL_ENLARGE = 10;
+
+  int fontHeight = 0;
+
+  Image linkImage;
+
+  FontMetrics fm;
+
+  public Tooltip(String tip, Component owner)
+  {
+    this.owner = owner;
+    owner.addMouseListener(this);
+    owner.addMouseMotionListener(this);
+    setBackground(new Color(255, 255, 220));
+    setTip(tip);
+    java.net.URL url = getClass().getResource("/images/link.gif");
+    if (url != null)
+    {
+      linkImage = java.awt.Toolkit.getDefaultToolkit().getImage(url);
+    }
+  }
+
+  public void paint(Graphics g)
+  {
+    int w = getSize().width;
+    int h = getSize().height;
+
+    g.drawRect(0, 0, w - 1, h - 1);
+    int lindex, x;
+    for (int i = 0; i < tip.length; i++)
+    {
+      x = 3;
+      lindex = tip[i].indexOf("%LINK%");
+      if (lindex != -1)
+      {
+        if (lindex > 0)
+        {
+          g.drawString(tip[i].substring(0, lindex), 3, (i + 1) * fontHeight
+                  - 3);
+          x += fm.stringWidth(tip[i].substring(0, lindex) + 3);
+        }
+        g.drawImage(linkImage, x, i * fontHeight + 1, this);
+        if (lindex + 6 < tip[i].length())
+        {
+          g.drawString(tip[i].substring(lindex + 6),
+                  x + linkImage.getWidth(this), (i + 1) * fontHeight - 3);
+        }
+      }
+      else
+      {
+        g.drawString(tip[i], 3, (i + 1) * fontHeight - 3);
+      }
+    }
+  }
+
+  synchronized void setTip(String tip)
+  {
+    if (tip == null)
+    {
+      setTip("");
+      return;
+    }
+
+    if (lastTip.equals(tip))
+    {
+      return;
+    }
+
+    lastTip = tip;
+    setPosition = true;
+
+    fm = getFontMetrics(owner.getFont());
+    fontHeight = fm.getHeight();
+
+    int longestLine = 0;
+    StringTokenizer st = new StringTokenizer(tip, "\n");
+    this.tip = new String[st.countTokens()];
+    int index = 0;
+    while (st.hasMoreElements())
+    {
+      this.tip[index] = st.nextToken();
+      if (fm.stringWidth(this.tip[index]) > longestLine)
+      {
+        longestLine = fm.stringWidth(this.tip[index]);
+      }
+      index++;
+    }
+
+    setSize(longestLine + HORIZONTAL_ENLARGE, fontHeight * this.tip.length);
+
+    repaint();
+
+  }
+
+  void setTipLocation(MouseEvent evt)
+  {
+    if (mainContainer == null || owner == null)
+    {
+      return;
+    }
+    setLocation(
+            (owner.getLocationOnScreen().x - mainContainer.getLocationOnScreen().x)
+                    + evt.getX(),
+            (owner.getLocationOnScreen().y
+                    - mainContainer.getLocationOnScreen().y + VERTICAL_OFFSET)
+                    + evt.getY());
+
+    // correction, whole tool tip must be visible
+    if (mainContainer.getSize().width < (getLocation().x + getSize().width))
+    {
+      setLocation(mainContainer.getSize().width - getSize().width,
+              getLocation().y);
+    }
+  }
+
+  private void removeToolTip()
+  {
+    if (shown)
+    {
+      mainContainer.remove(0);
+      mainContainer.setLayout(mainLayout);
+      mainContainer.validate();
+    }
+    shown = false;
+  }
+
+  private void findMainContainer()
+  {
+    Container parent = owner.getParent();
+    while (true)
+    {
+      if ((parent instanceof Applet) || (parent instanceof Frame))
+      {
+        mainContainer = parent;
+        break;
+      }
+      else
+      {
+        parent = parent.getParent();
+      }
+    }
+    mainLayout = mainContainer.getLayout();
+  }
+
+  public void mouseEntered(MouseEvent me)
+  {
+    setTipLocation(me);
+  }
+
+  public void mouseExited(MouseEvent me)
+  {
+    removeToolTip();
+  }
+
+  public void mousePressed(MouseEvent me)
+  {
+    removeToolTip();
+  }
+
+  public void mouseReleased(MouseEvent me)
+  {
+  }
+
+  public void mouseClicked(MouseEvent me)
+  {
+  }
+
+  public void mouseMoved(MouseEvent me)
+  {
+    if (!shown)
+    {
+      findMainContainer();
+      mainContainer.setLayout(null);
+      mainContainer.add(this, 0);
+      mainContainer.validate();
+      shown = true;
+      setTipLocation(me);
+    }
+    else if (setPosition)
+    {
+      setTipLocation(me);
+      setPosition = false;
+    }
+  }
+
+  public void mouseDragged(MouseEvent me)
+  {
+  }
+}