libjava/classpath/javax/swing/JToolTip.java

   1 /* JToolTip.java --
   2    Copyright (C) 2002, 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing;
  40
  41 import java.awt.AWTEvent;
  42
  43 import javax.accessibility.Accessible;
  44 import javax.accessibility.AccessibleContext;
  45 import javax.accessibility.AccessibleRole;
  46 import javax.swing.plaf.ToolTipUI;
  47
  48 /**
  49  * This class is used to display ToolTips. ToolTips are small floating windows
  50  * that display text when the mouse comes to rest over a Component. ToolTips
  51  * are set for JComponents using JComponent.setToolTipText(String).
  52  */
  53 public class JToolTip extends JComponent implements Accessible
  54 {
  55   /** DOCUMENT ME! */
  56   private static final long serialVersionUID = -1138929898906751643L;
  57
  58   /**
  59    * DOCUMENT ME!
  60    */
  61   // FIXME: This inner class is a complete stub and must be implemented
  62   // properly.
  63   protected class AccessibleJToolTip extends AccessibleJComponent
  64   {
  65     private static final long serialVersionUID = -6222548177795408476L;
  66
  67     /**
  68      * Creates a new AccessibleJToolTip object.
  69      */
  70     protected AccessibleJToolTip()
  71     {
  72       // Nothing to do here.
  73     }
  74
  75     /**
  76      * DOCUMENT ME!
  77      *
  78      * @return DOCUMENT ME!
  79      */
  80     public String getAccessibleDescription()
  81     {
  82       return null;
  83     }
  84
  85     /**
  86      * DOCUMENT ME!
  87      *
  88      * @return DOCUMENT ME!
  89      */
  90     public AccessibleRole getAccessibleRole()
  91     {
  92       return null;
  93     }
  94   }
  95
  96   /** The text to display in the JToolTip. */
  97   String text;
  98
  99   /** The JComponent this JToolTip is used for. */
 100   JComponent component;
 101
 102   /**
 103    * Creates a new JToolTip object.
 104    */
 105   public JToolTip()
 106   {
 107     disableEvents(AWTEvent.MOUSE_EVENT_MASK);
 108     updateUI();
 109   }
 110
 111   /**
 112    * This method returns the text this JToolTip displays.
 113    *
 114    * @return The text that this JToolTip displays.
 115    */
 116   public String getTipText()
 117   {
 118     return text;
 119   }
 120
 121   /**
 122    * DOCUMENT ME!
 123    *
 124    * @return DOCUMENT ME!
 125    */
 126   public AccessibleContext getAccessibleContext()
 127   {
 128     return null;
 129   }
 130
 131   /**
 132    * This method returns the JComponent this JToolTip displays for.
 133    *
 134    * @return The JComponent this JToolTip displays for.
 135    */
 136   public JComponent getComponent()
 137   {
 138     return component;
 139   }
 140
 141   /**
 142    * This method returns the UI responsible for displaying this JToolTip.
 143    *
 144    * @return The UI responsible for displaying this JToolTip.
 145    */
 146   public ToolTipUI getUI()
 147   {
 148     return (ToolTipUI) ui;
 149   }
 150
 151   /**
 152    * This method returns the String identifier for the UI class.
 153    *
 154    * @return The String identifier for the UI class.
 155    */
 156   public String getUIClassID()
 157   {
 158     return "ToolTipUI";
 159   }
 160
 161   /**
 162    * This method returns a debugging String describing the JToolTip.
 163    *
 164    * @return A debugging String describing the JToolTip.
 165    */
 166   protected String paramString()
 167   {
 168     return "JToolTip";
 169   }
 170
 171   /**
 172    * This method sets the JComponent that the JToolTip displays for.
 173    *
 174    * @param c The JComponent that the JToolTip displays for.
 175    */
 176   public void setComponent(JComponent c)
 177   {
 178     component = c;
 179   }
 180
 181   /**
 182    * This method sets the text that the JToolTip displays.
 183    *
 184    * @param tipText The text that the JToolTip displays.
 185    */
 186   public void setTipText(String tipText)
 187   {
 188     text = tipText;
 189   }
 190
 191   /**
 192    * This method resets the UI used to the Look and Feel default.
 193    */
 194   public void updateUI()
 195   {
 196     setUI((ToolTipUI) UIManager.getUI(this));
 197     revalidate();
 198     repaint();
 199   }
 200 }