com.levigo.util.swing.flextree
Class ToolTipFeature

java.lang.Object
  com.levigo.util.swing.flextree.ToolTipFeature

public class ToolTipFeature
extends Object

A flextree feature used to activate tooltips for a FlexibleTree. It is used in conjunction with TreeModules implementing TreeTipProvider.

Method Summary

static ToolTipFeature	install(FlexibleTree flextree) Install this feature on the given flextree.
void	setTreeTooltip(String tooltipText) Sets the tooltip text to be displayed for this tree.
void	uninstall() Uninstall the feature from the flextree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

install

@CallOnEDT
public static ToolTipFeature install(FlexibleTree flextree)

Install this feature on the given flextree. You may uninstall it lateron by calling uninstall() on the returned instance.

Parameters:

flextree - the FlexibleTree on which this feature will be installed

Returns:

the ToolTipFeature which is created and installed

setTreeTooltip

@CallOnEDT
public void setTreeTooltip(String tooltipText)

Sets the tooltip text to be displayed for this tree. This is not to be confused with tooltip texts for single nodes in the tree. These are supplied by instances of TreeTipProvider.

Parameters:

tooltipText - The text to be displayed when hovering over the tree.

See Also:

TreeTipProvider

uninstall

@CallOnEDT
public void uninstall()

Uninstall the feature from the flextree.