1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
/* * @(#)JToolTip.java 1.51 06/08/08 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing; import javax.swing.plaf.*; import javax.accessibility.*; import java.io.ObjectOutputStream; import java.io.ObjectInputStream; import java.io.IOException; /** * Used to display a "Tip" for a Component. Typically components provide api * to automate the process of using <code>ToolTip</code>s. * For example, any Swing component can use the <code>JComponent</code> * <code>setToolTipText</code> method to specify the text * for a standard tooltip. A component that wants to create a custom * <code>ToolTip</code> * display can override <code>JComponent</code>'s <code>createToolTip</code> * method and use a subclass of this class. * <p> * See <a href="http://java.sun.com/docs/books/tutorial/uiswing/components/tooltip.html">How to Use Tool Tips</a> * in <em>The Java Tutorial</em> * for further documentation. * <p> * <strong>Warning:</strong> Swing is not thread safe. For more * information see <a * href="package-summary.html#threading">Swing's Threading * Policy</a>. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. * * @see JComponent#setToolTipText * @see JComponent#createToolTip * @version 1.51 08/08/06 * @author Dave Moore * @author Rich Shiavi */ public class JToolTip extends JComponent implements Accessible { /** * @see #getUIClassID * @see #readObject */ private static final String uiClassID = "ToolTipUI"; String tipText; JComponent component; /** Creates a tool tip. */ public JToolTip() { setOpaque(true); updateUI(); } /** * Returns the L&F object that renders this component. * * @return the <code>ToolTipUI</code> object that renders this component */ public ToolTipUI getUI() { return (ToolTipUI)ui; } /** * Resets the UI property to a value from the current look and feel. * * @see JComponent#updateUI */ public void updateUI() { setUI((ToolTipUI)UIManager.getUI(this)); } /** * Returns the name of the L&F class that renders this component. * * @return the string "ToolTipUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI */ public String getUIClassID() { return uiClassID; } /** * Sets the text to show when the tool tip is displayed. * The string <code>tipText</code> may be <code>null</code>. * * @param tipText the <code>String</code> to display * @beaninfo * preferred: true * bound: true * description: Sets the text of the tooltip */ public void setTipText(String tipText) { String oldValue = this.tipText; this.tipText = tipText; firePropertyChange("tiptext", oldValue, tipText); } /** * Returns the text that is shown when the tool tip is displayed. * The returned value may be <code>null</code>. * * @return the <code>String</code> that is displayed */ public String getTipText() { return tipText; } /** * Specifies the component that the tooltip describes. * The component <code>c</code> may be <code>null</code> * and will have no effect. * <p> * This is a bound property. * * @param c the <code>JComponent</code> being described * @see JComponent#createToolTip * @beaninfo * bound: true * description: Sets the component that the tooltip describes. */ public void setComponent(JComponent c) { JComponent oldValue = this.component; component = c; firePropertyChange("component", oldValue, c); } /** * Returns the component the tooltip applies to. * The returned value may be <code>null</code>. * * @return the component that the tooltip describes * * @see JComponent#createToolTip */ public JComponent getComponent() { return component; } /** * Always returns true since tooltips, by definition, * should always be on top of all other windows. */ // package private boolean alwaysOnTop() { return true; } /** * See <code>readObject</code> and <code>writeObject</code> * in <code>JComponent</code> for more * information about serialization in Swing. */ private void writeObject(ObjectOutputStream s) throws IOException { s.defaultWriteObject(); if (getUIClassID().equals(uiClassID)) { byte count = JComponent.getWriteObjCounter(this); JComponent.setWriteObjCounter(this, --count); if (count == 0 && ui != null) { ui.installUI(this); } } } /** * Returns a string representation of this <code>JToolTip</code>. * This method * is intended to be used only for debugging purposes, and the * content and format of the returned string may vary between * implementations. The returned string may be empty but may not * be <code>null</code>. * * @return a string representation of this <code>JToolTip</code> */ protected String paramString() { String tipTextString = (tipText != null ? tipText : ""); return super.paramString() + ",tipText=" + tipTextString; } ///////////////// // Accessibility support //////////////// /** * Gets the AccessibleContext associated with this JToolTip. * For tool tips, the AccessibleContext takes the form of an * AccessibleJToolTip. * A new AccessibleJToolTip instance is created if necessary. * * @return an AccessibleJToolTip that serves as the * AccessibleContext of this JToolTip */ public AccessibleContext getAccessibleContext() { if (accessibleContext == null) { accessibleContext = new AccessibleJToolTip(); } return accessibleContext; } /** * This class implements accessibility support for the * <code>JToolTip</code> class. It provides an implementation of the * Java Accessibility API appropriate to tool tip user-interface elements. * <p> * <strong>Warning:</strong> * Serialized objects of this class will not be compatible with * future Swing releases. The current serialization support is * appropriate for short term storage or RMI between applications running * the same version of Swing. As of 1.4, support for long term storage * of all JavaBeans<sup><font size="-2">TM</font></sup> * has been added to the <code>java.beans</code> package. * Please see {@link java.beans.XMLEncoder}. */ protected class AccessibleJToolTip extends AccessibleJComponent { /** * Get the accessible description of this object. * * @return a localized String describing this object. */ public String getAccessibleDescription() { String description = accessibleDescription; // fallback to client property if (description == null) { description = (String)getClientProperty(AccessibleContext.ACCESSIBLE_DESCRIPTION_PROPERTY); } if (description == null) { description = getTipText(); } return description; } /** * Get the role of this object. * * @return an instance of AccessibleRole describing the role of the * object */ public AccessibleRole getAccessibleRole() { return AccessibleRole.TOOL_TIP; } } }