com.alee.laf.tree

Class TreeToolTipProvider<E extends javax.swing.tree.DefaultMutableTreeNode>

java.lang.Object

com.alee.managers.tooltip.AbstractToolTipProvider<WebTree<E>>

com.alee.laf.tree.TreeToolTipProvider<E>

All Implemented Interfaces:

ToolTipProvider<WebTree<E>>

public abstract class TreeToolTipProvider<E extends javax.swing.tree.DefaultMutableTreeNode>
extends AbstractToolTipProvider<WebTree<E>>

Abstract WebLaF tooltip provider for WebTree component.

Constructor Summary

Constructors

Constructor and Description
TreeToolTipProvider()

Method Summary

Modifier and Type	Method and Description
java.awt.Rectangle	getSourceBounds(WebTree tree, java.lang.Object value, int index, int column, boolean isSelected) Returns custom WebLaF tooltip source bounds.
WebCustomTooltip	getToolTip(WebTree<E> tree, E node, int row, boolean isSelected) Return custom WebLaF tooltip for the specified tree node.
WebCustomTooltip	getToolTip(WebTree<E> tree, java.lang.Object value, int row, int depth, boolean isSelected) Return custom WebLaF tooltip for the specified cell.
abstract java.lang.String	getToolTipText(WebTree<E> tree, E node, int row, boolean isSelected) Returns custom node tooltip text based on the node.
java.lang.String	getToolTipText(WebTree<E> tree, java.lang.Object value, int row, int depth, boolean isSelected) Returns custom cell tooltip text based on cell value.
protected java.lang.Object	getValue(WebTree tree, int index, int column) Returns component cell value under the specified index and column.
protected boolean	isSelected(WebTree tree, int index, int column) Returns whether or not component cell is selected.

Methods inherited from class com.alee.managers.tooltip.AbstractToolTipProvider

getDelay, getDirection, hoverCellChanged, showTooltip

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeToolTipProvider

public TreeToolTipProvider()

Method Detail

getSourceBounds

public java.awt.Rectangle getSourceBounds(WebTree tree,
                                          java.lang.Object value,
                                          int index,
                                          int column,
                                          boolean isSelected)

Description copied from interface: ToolTipProvider

Returns custom WebLaF tooltip source bounds. Tooltip will be displayed relative to these bounds using provided TooltipWay.

Parameters:

tree - component to provide tooltip for

value - cell value

index - cell index

column - cell column index

isSelected - whether the cell is selected or not

Returns:

custom WebLaF tooltip source bounds

getToolTip

public final WebCustomTooltip getToolTip(WebTree<E> tree,
                                         java.lang.Object value,
                                         int row,
                                         int depth,
                                         boolean isSelected)

Description copied from interface: ToolTipProvider

Return custom WebLaF tooltip for the specified cell.

Specified by:

getToolTip in interface ToolTipProvider<WebTree<E extends javax.swing.tree.DefaultMutableTreeNode>>

Overrides:

getToolTip in class AbstractToolTipProvider<WebTree<E extends javax.swing.tree.DefaultMutableTreeNode>>

Parameters:

tree - component to provide tooltip for

value - cell value

row - cell index

depth - cell column index

isSelected - whether the cell is selected or not

Returns:

cell tooltip

getToolTipText

public final java.lang.String getToolTipText(WebTree<E> tree,
                                             java.lang.Object value,
                                             int row,
                                             int depth,
                                             boolean isSelected)

Description copied from class: AbstractToolTipProvider

Returns custom cell tooltip text based on cell value.

Specified by:

getToolTipText in class AbstractToolTipProvider<WebTree<E extends javax.swing.tree.DefaultMutableTreeNode>>

Parameters:

tree - component to provide tooltip for

value - cell value

row - cell index

depth - cell column index

isSelected - whether the cell is selected or not

Returns:

custom cell tooltip text based on cell value

getToolTip

public WebCustomTooltip getToolTip(WebTree<E> tree,
                                   E node,
                                   int row,
                                   boolean isSelected)

Return custom WebLaF tooltip for the specified tree node.

Parameters:

tree - tree to provide tooltip for

node - node

row - node row

isSelected - whether the cell is selected or not

Returns:

node tooltip

getToolTipText

public abstract java.lang.String getToolTipText(WebTree<E> tree,
                                                E node,
                                                int row,
                                                boolean isSelected)

Returns custom node tooltip text based on the node.

Parameters:

tree - tree to provide tooltip for

node - node

row - node row

isSelected - whether node is selected or not

Returns:

custom node tooltip text based on the node

getValue

protected java.lang.Object getValue(WebTree tree,
                                    int index,
                                    int column)

Description copied from class: AbstractToolTipProvider

Returns component cell value under the specified index and column.

Specified by:

getValue in class AbstractToolTipProvider<WebTree<E extends javax.swing.tree.DefaultMutableTreeNode>>

Parameters:

tree - component to retrieve cell value for

index - cell index

column - cell column index

Returns:

component cell value under the specified index and column

isSelected

protected boolean isSelected(WebTree tree,
                             int index,
                             int column)

Description copied from class: AbstractToolTipProvider

Returns whether or not component cell is selected.

Specified by:

isSelected in class AbstractToolTipProvider<WebTree<E extends javax.swing.tree.DefaultMutableTreeNode>>

Parameters:

tree - component to retrieve cell selection state for

index - cell index

column - cell column index

Returns:

true if component cell is selected, false otherwise