org.fife.ui.rtextarea.ToolTipSupplier Maven / Gradle / Ivy
/*
* 02/05/2009
*
* ToolTipSupplier.java - Can provide tool tips to RTextAreas without the need
* for subclassing.
*
* This library is distributed under a modified BSD license. See the included
* LICENSE file for details.
*/
package org.fife.ui.rtextarea;
import java.awt.event.MouseEvent;
/**
* A ToolTipSupplier can create tool tip text for an RTextArea
* on its behalf. A text area will check its ToolTipSupplier for a
* tool tip before calling the super class's implementation of
* {@link RTextArea#getToolTipText()}. This allows
* applications to intercept tool tip events and provide the text for a tool
* tip without subclassing RTextArea.
*
* @author Robert Futrell
* @version 1.0
*/
public interface ToolTipSupplier {
/**
* Returns the tool tip text to display for a given mouse event.
*
* @param textArea The text area.
* @param e The mouse event.
* @return The tool tip, or null if none.
*/
String getToolTipText(RTextArea textArea, MouseEvent e);
}