com.alee.managers.tooltip
Class AbstractToolTipProvider<T extends javax.swing.JComponent>

java.lang.Object
  extended by com.alee.managers.tooltip.AbstractToolTipProvider<T>
All Implemented Interfaces:
ToolTipProvider<T>
Direct Known Subclasses:
ListToolTipProvider, TableToolTipProvider, TreeToolTipProvider

public abstract class AbstractToolTipProvider<T extends javax.swing.JComponent>
extends java.lang.Object
implements ToolTipProvider<T>

Abstract WebLaF tooltip provider which defines base methods used across all components.

Author:
Mikle Garin

Constructor Summary
AbstractToolTipProvider()
           
 
Method Summary
 long getDelay()
          Returns tooltip display delay.
 TooltipWay getDirection(T component, java.lang.Object value, int index, int column, boolean isSelected)
          Returns custom tooltip direction based on cell value.
 WebCustomTooltip getToolTip(T component, java.lang.Object value, int index, int column, boolean isSelected)
          Return custom WebLaF tooltip for the specified cell.
abstract  java.lang.String getToolTipText(T component, java.lang.Object value, int index, int column, boolean isSelected)
          Returns custom cell tooltip text based on cell value.
protected abstract  java.lang.Object getValue(T component, int index, int column)
          Returns component cell value under the specified index and column.
protected abstract  boolean isSelected(T component, int index, int column)
          Returns whether or not component cell is selected.
 void rolloverCellChanged(T component, int oldIndex, int oldColumn, int newIndex, int newColumn)
          Forces tooltip to update when rollover cell changes.
protected  void showTooltip(T component, int index, int column)
          Displays custom tooltip for the specified component cell.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.alee.managers.tooltip.ToolTipProvider
getSourceBounds
 

Constructor Detail

AbstractToolTipProvider

public AbstractToolTipProvider()
Method Detail

getDelay

public long getDelay()
Description copied from interface: ToolTipProvider
Returns tooltip display delay. Any value below 1 will force tooltips to be displayed instantly.

Specified by:
getDelay in interface ToolTipProvider<T extends javax.swing.JComponent>
Returns:
tooltip display delay

getToolTip

public WebCustomTooltip getToolTip(T component,
                                   java.lang.Object value,
                                   int index,
                                   int column,
                                   boolean isSelected)
Description copied from interface: ToolTipProvider
Return custom WebLaF tooltip for the specified cell.

Specified by:
getToolTip in interface ToolTipProvider<T extends javax.swing.JComponent>
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

getDirection

public TooltipWay getDirection(T component,
                               java.lang.Object value,
                               int index,
                               int column,
                               boolean isSelected)
Returns custom tooltip direction based on cell value.

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 tooltip direction based on cell value

getToolTipText

public abstract java.lang.String getToolTipText(T component,
                                                java.lang.Object value,
                                                int index,
                                                int column,
                                                boolean isSelected)
Returns custom cell tooltip text based on cell value.

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 cell tooltip text based on cell value

rolloverCellChanged

public void rolloverCellChanged(T component,
                                int oldIndex,
                                int oldColumn,
                                int newIndex,
                                int newColumn)
Description copied from interface: ToolTipProvider
Forces tooltip to update when rollover cell changes.

Specified by:
rolloverCellChanged in interface ToolTipProvider<T extends javax.swing.JComponent>
Parameters:
component - component to provide tooltip for
oldIndex - old rollover cell index
oldColumn - old rollover cell column
newIndex - new rollover cell index
newColumn - new rollover cell column

showTooltip

protected void showTooltip(T component,
                           int index,
                           int column)
Displays custom tooltip for the specified component cell.

Parameters:
component - component to display tooltip for
index - cell index
column - cell column index

getValue

protected abstract java.lang.Object getValue(T component,
                                             int index,
                                             int column)
Returns component cell value under the specified index and column.

Parameters:
component - 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 abstract boolean isSelected(T component,
                                      int index,
                                      int column)
Returns whether or not component cell is selected.

Parameters:
component - component to retrieve cell selection state for
index - cell index
column - cell column index
Returns:
true if component cell is selected, false otherwise