source: other-projects/rsyntax-textarea/src/java/org/fife/ui/rtextarea/ToolTipSupplier.java@ 25584

Last change on this file since 25584 was 25584, checked in by davidb, 12 years ago

Initial cut an a text edit area for GLI that supports color syntax highlighting

File size: 1.1 KB
Line 
1/*
2 * 02/05/2009
3 *
4 * ToolTipSupplier.java - Can provide tool tips to RTextAreas without the need
5 * for subclassing.
6 *
7 * This library is distributed under a modified BSD license. See the included
8 * RSyntaxTextArea.License.txt file for details.
9 */
10package org.fife.ui.rtextarea;
11
12import java.awt.event.MouseEvent;
13
14
15/**
16 * A <tt>ToolTipSupplier</tt> can create tool tip text for an <tt>RTextArea</tt>
17 * on its behalf. A text area will check its <tt>ToolTipSupplier</tt> for a
18 * tool tip before calling the super class's implementation of
19 * {@link RTextArea#getToolTipText()}. This allows
20 * applications to intercept tool tip events and provide the text for a tool
21 * tip without subclassing <tt>RTextArea</tt>.
22 *
23 * @author Robert Futrell
24 * @version 1.0
25 */
26public interface ToolTipSupplier {
27
28
29 /**
30 * Returns the tool tip text to display for a given mouse event.
31 *
32 * @param textArea The text area.
33 * @param e The mouse event.
34 * @return The tool tip, or <code>null</code> if none.
35 */
36 public String getToolTipText(RTextArea textArea, MouseEvent e);
37
38
39}
Note: See TracBrowser for help on using the repository browser.