com.ibm.tivoli.maximo.skd.applet.widget

Class Tooltips

java.lang.Object

com.ibm.tivoli.maximo.skd.applet.widget.Tooltips

public class Tooltips
extends java.lang.Object

Tooltip Manager for handling Tooltips across all components. While this class is a complete implementation, another applet could override this class and set itself as the single shared instance for tooltips.

Author:

sls

Field Summary

Fields

Modifier and Type	Field and Description
static net.java.balloontip.styles.BalloonTipStyle	DefaultBalloonTipStyle

Constructor Summary

Constructors

Constructor and Description
Tooltips()

Method Summary

Methods

Modifier and Type	Method and Description
void	configureSimpleTooltipWithText(javax.swing.JComponent attach, java.lang.String text) Configures a simple tooltip attached to a component with the given static text
void	configureTooltip(java.awt.Component attach) Configure the tooltips for the given component.
void	configureTooltipForChart(ilog.views.gantt.IlvHierarchyChart chart) Convenience method that configures both the Table and GanttSheet tooltips for the given Chart.
void	configureTooltipsForChildren(java.awt.Container container) Given the Container, iterate ove the children and configure tooltips for each child.
float	getDefaultOpactiy() Returns the default opacity when we are showing transparent tooltips
net.java.balloontip.BalloonTip	getTooltipInstance() Return the current tooltip instance, or null if there isn't a tooltip set
void	hideTooltip() Hide the tooltip, if there is a tooltip set.
void	initialize()
boolean	isEnabled()
boolean	isTooltipVisible() return true if the tooltip is set and visible
void	setEnabled(boolean enabled)
static void	setSharedInstance(Tooltips tips) Set the single shared instance for this Tooltips manager.
void	setTooltipInstance(net.java.balloontip.BalloonTip tip) Sets and shows the single tooltip instance into this manager.
static Tooltips	sharedInstance() Returns the single, shared instance, of this tooltip manager.
void	showTooltip(javax.swing.JComponent attach, int x, int y, java.lang.String text) Shows a tooltip at the given offset.
void	showTooltip(javax.swing.JComponent attach, int x, int y, java.lang.String text, float defOpactiy) Shows a tooltip immediately.

Methods inherited from class java.lang.Object

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

Field Detail

DefaultBalloonTipStyle

public static net.java.balloontip.styles.BalloonTipStyle DefaultBalloonTipStyle

Constructor Detail

Tooltips

public Tooltips()

Method Detail

sharedInstance

public static Tooltips sharedInstance()

Returns the single, shared instance, of this tooltip manager.

Returns:

setSharedInstance

public static void setSharedInstance(Tooltips tips)

Set the single shared instance for this Tooltips manager.

Parameters:

tips -

initialize

public void initialize()

configureTooltipsForChildren

public void configureTooltipsForChildren(java.awt.Container container)

Given the Container, iterate ove the children and configure tooltips for each child. This useful when you pass in a JToolBar or another container, and you want to attach tooltips to each child.

Parameters:

container -

configureTooltip

public void configureTooltip(java.awt.Component attach)

Configure the tooltips for the given component. The logic in this implemetation, is that depending on the attach component, ie, JTable, JTabbedPane, etc, this method will dispatch to the specific confgure method for that given type. The default handler will be the configureSimpleTooltip method.

Parameters:

attach - attach component for the tooltip

configureSimpleTooltipWithText

public void configureSimpleTooltipWithText(javax.swing.JComponent attach,
                                  java.lang.String text)

Configures a simple tooltip attached to a component with the given static text

Parameters:

attach -

text -

configureTooltipForChart

public void configureTooltipForChart(ilog.views.gantt.IlvHierarchyChart chart)

Convenience method that configures both the Table and GanttSheet tooltips for the given Chart.

Parameters:

chart -

setTooltipInstance

public void setTooltipInstance(net.java.balloontip.BalloonTip tip)

Sets and shows the single tooltip instance into this manager.

Parameters:

tip -

getTooltipInstance

public net.java.balloontip.BalloonTip getTooltipInstance()

Return the current tooltip instance, or null if there isn't a tooltip set

Returns:

showTooltip

public void showTooltip(javax.swing.JComponent attach,
               int x,
               int y,
               java.lang.String text)

Shows a tooltip at the given offset.

Parameters:

attach -

x -

y -

text -

hideTooltip

public void hideTooltip()

Hide the tooltip, if there is a tooltip set.

isTooltipVisible

public boolean isTooltipVisible()

return true if the tooltip is set and visible

Returns:

getDefaultOpactiy

public float getDefaultOpactiy()

Returns the default opacity when we are showing transparent tooltips

Returns:

showTooltip

public void showTooltip(javax.swing.JComponent attach,
               int x,
               int y,
               java.lang.String text,
               float defOpactiy)

Shows a tooltip immediately. Note this tooltip is not manages by a time controller, so another caller must be responsible for hiding it.

Parameters:

attach -

x -

y -

text -

defOpactiy -

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)