com.alee.managers.tooltip

Interface ToolTipProvider<T extends javax.swing.JComponent>

All Known Implementing Classes:

AbstractToolTipProvider, ListToolTipProvider, TableToolTipProvider, TreeToolTipProvider

public interface ToolTipProvider<T extends javax.swing.JComponent>

WebLaF tooltip provider interface. It defines methods used across all components.

Method Summary

Modifier and Type	Method and Description
long	getDelay() Returns tooltip display delay.
java.awt.Rectangle	getSourceBounds(T component, java.lang.Object value, int index, int column, boolean isSelected) Returns custom WebLaF tooltip source bounds.
WebCustomTooltip	getToolTip(T component, java.lang.Object value, int index, int column, boolean isSelected) Return custom WebLaF tooltip for the specified cell.
void	hoverCellChanged(T component, int oldIndex, int oldColumn, int newIndex, int newColumn) Forces tooltip to update when hover cell changes.

Method Detail

getDelay

long getDelay()

Returns tooltip display delay. Any value below 1 will force tooltips to be displayed instantly.

Returns:

tooltip display delay

getSourceBounds

java.awt.Rectangle getSourceBounds(T component,
                                   java.lang.Object value,
                                   int index,
                                   int column,
                                   boolean isSelected)

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

Parameters:

component - 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

WebCustomTooltip getToolTip(T component,
                            java.lang.Object value,
                            int index,
                            int column,
                            boolean isSelected)

Return custom WebLaF tooltip for the specified cell.

Parameters:

component - component to provide tooltip for

value - cell value

index - cell index

column - cell column index

isSelected - whether the cell is selected or not

Returns:

cell tooltip

hoverCellChanged

void hoverCellChanged(T component,
                      int oldIndex,
                      int oldColumn,
                      int newIndex,
                      int newColumn)

Forces tooltip to update when hover cell changes.

Parameters:

component - component to provide tooltip for

oldIndex - old hover cell index

oldColumn - old hover cell column

newIndex - new hover cell index

newColumn - new hover cell column