GNU Classpath (0.18) | ||
Frames | No Frames |
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: protected class AccessibleJToolTip extends AccessibleJComponent 62: { 63: private static final long serialVersionUID = -6222548177795408476L; 64: 65: /** 66: * Creates a new AccessibleJToolTip object. 67: */ 68: protected AccessibleJToolTip() 69: { 70: } 71: 72: /** 73: * DOCUMENT ME! 74: * 75: * @return DOCUMENT ME! 76: */ 77: public String getAccessibleDescription() 78: { 79: return null; 80: } 81: 82: /** 83: * DOCUMENT ME! 84: * 85: * @return DOCUMENT ME! 86: */ 87: public AccessibleRole getAccessibleRole() 88: { 89: return null; 90: } 91: } 92: 93: /** The text to display in the JToolTip. */ 94: String text; 95: 96: /** The JComponent this JToolTip is used for. */ 97: JComponent component; 98: 99: /** 100: * Creates a new JToolTip object. 101: */ 102: public JToolTip() 103: { 104: disableEvents(AWTEvent.MOUSE_EVENT_MASK); 105: updateUI(); 106: } 107: 108: /** 109: * This method returns the text this JToolTip displays. 110: * 111: * @return The text that this JToolTip displays. 112: */ 113: public String getTipText() 114: { 115: return text; 116: } 117: 118: /** 119: * DOCUMENT ME! 120: * 121: * @return DOCUMENT ME! 122: */ 123: public AccessibleContext getAccessibleContext() 124: { 125: return null; 126: } 127: 128: /** 129: * This method returns the JComponent this JToolTip displays for. 130: * 131: * @return The JComponent this JToolTip displays for. 132: */ 133: public JComponent getComponent() 134: { 135: return component; 136: } 137: 138: /** 139: * This method returns the UI responsible for displaying this JToolTip. 140: * 141: * @return The UI responsible for displaying this JToolTip. 142: */ 143: public ToolTipUI getUI() 144: { 145: return (ToolTipUI) ui; 146: } 147: 148: /** 149: * This method returns the String identifier for the UI class. 150: * 151: * @return The String identifier for the UI class. 152: */ 153: public String getUIClassID() 154: { 155: return "ToolTipUI"; 156: } 157: 158: /** 159: * This method returns a debugging String describing the JToolTip. 160: * 161: * @return A debugging String describing the JToolTip. 162: */ 163: protected String paramString() 164: { 165: return "JToolTip"; 166: } 167: 168: /** 169: * This method sets the JComponent that the JToolTip displays for. 170: * 171: * @param c The JComponent that the JToolTip displays for. 172: */ 173: public void setComponent(JComponent c) 174: { 175: component = c; 176: } 177: 178: /** 179: * This method sets the text that the JToolTip displays. 180: * 181: * @param tipText The text that the JToolTip displays. 182: */ 183: public void setTipText(String tipText) 184: { 185: text = tipText; 186: } 187: 188: /** 189: * This method resets the UI used to the Look and Feel default. 190: */ 191: public void updateUI() 192: { 193: setUI((ToolTipUI) UIManager.getUI(this)); 194: revalidate(); 195: repaint(); 196: } 197: }
GNU Classpath (0.18) |