com.sharkysoft.fig.core

Interface ToolTip

All Known Implementing Classes:

BatikDoodle, CompoundDoodle, ExcitableFigure, ExcitableShapeDoodle, Figure, FlatDoodle, ImageDoodle, ShapeDoodle, SvgDoodle, SwingFigureViewDelegate, SwtFigureViewDelegate, TextDoodle, WmfDoodle

public interface ToolTip

Component supporting tool tips.

Details: ToolTip is a generic interface for any component that implements tool tip support. In particular, this interface is intended for use with Doodle implementations. The figure drawer should recognize components that implement this interface and render tool tips accordingly.

Author:

Sharky

Method Summary

Methods

Modifier and Type	Method and Description
String	getToolTip() Retrieves tool tip text.
void	setToolTip(String iToolTip) Sets tool tip text.

Method Detail

setToolTip

void setToolTip(String iToolTip)

Sets tool tip text.

Details: setToolTip sets the tool tip text for this component. To turn off tool tips for this object, set the tool tip to null.

Parameters:

iToolTip - the new tool tip text

getToolTip

String getToolTip()

Retrieves tool tip text.

Details: getToolTip returns the tool tip text for this component. If the return value is null, then no tool tip is available for this component.

Returns:

the tool tip text