ilog.cpl.graphic
Class IlpToolTipManager

java.lang.Object
  ilog.cpl.graphic.IlpToolTipManager

public class IlpToolTipManager
extends Object

This class manages all tooltips used in the application.

Since:

JTGO 3.0

See Also:

IlpGraphicView

Constructor Summary

protected

IlpToolTipManager(IlpGraphicView v) IlpToolTipManagers are only created by the library.

Method Summary

static IlpToolTipManager	AddToolTipSupport(IlpGraphicView view) Adds tooltip support to an IlpGraphicView object.
Container	getContainer() Returns the container associated to this manager, if there is one.
int	getDismissDelay() Returns the delay before a tooltip disappears.
int	getInitialDelay() Returns the initial delay before a tooltip appears.
int	getReshowDelay() Returns the reshow delay value.
static IlpToolTipManager	GetToolTipManager(IlpGraphicView view) Returns the IlpToolTipManager instance associated with a view, or null if tooltip support for the view has not been added.
IlpGraphicView	getView() Returns the graphic view associated to this manager, if there is one.
static boolean	HasToolTipSupport(IlpGraphicView view) Returns true if the graphic view has tooltip support.
boolean	isDismissOnMove() Returns true if moving the mouse makes a tooltip disappear.
boolean	isEnabled() Returns true if this IlpToolTipManager instance is enabled.
static void	RemoveToolTipSupport(IlpGraphicView view) Removes tooltip support from an IlpGraphicView object.
void	setDismissDelay(int milliSeconds) Sets the delay before a tooltip disappears.
void	setDismissOnMove(boolean dismiss) Sets the boolean value that determines whether moving the mouse makes a tooltip disappear.
void	setEnabled(boolean flag) Allows or disallows this IlpToolTipManager to create tooltips.
void	setInitialDelay(int milliSeconds) Sets the initial delay before a tooltip appears.
void	setReshowDelay(int milliseconds) Specifies the time to delay before reshowing the tooltip.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpToolTipManager

protected IlpToolTipManager(IlpGraphicView v)

IlpToolTipManagers are only created by the library.

Method Detail

AddToolTipSupport

public static IlpToolTipManager AddToolTipSupport(IlpGraphicView view)

Adds tooltip support to an IlpGraphicView object.

RemoveToolTipSupport

public static void RemoveToolTipSupport(IlpGraphicView view)

Removes tooltip support from an IlpGraphicView object.

HasToolTipSupport

public static boolean HasToolTipSupport(IlpGraphicView view)

Returns true if the graphic view has tooltip support.

GetToolTipManager

public static IlpToolTipManager GetToolTipManager(IlpGraphicView view)

Returns the IlpToolTipManager instance associated with a view, or null if tooltip support for the view has not been added.

getView

public IlpGraphicView getView()

Returns the graphic view associated to this manager, if there is one. Otherwise, returns null.

getContainer

public Container getContainer()

Returns the container associated to this manager, if there is one. Otherwise, returns null.

setEnabled

public void setEnabled(boolean flag)

Allows or disallows this IlpToolTipManager to create tooltips.

isEnabled

public boolean isEnabled()

Returns true if this IlpToolTipManager instance is enabled.

setInitialDelay

public void setInitialDelay(int milliSeconds)

Sets the initial delay before a tooltip appears.

getInitialDelay

public int getInitialDelay()

Returns the initial delay before a tooltip appears.

setDismissDelay

public void setDismissDelay(int milliSeconds)

Sets the delay before a tooltip disappears.

getDismissDelay

public int getDismissDelay()

Returns the delay before a tooltip disappears.

setReshowDelay

public void setReshowDelay(int milliseconds)

Specifies the time to delay before reshowing the tooltip.

Parameters:

milliseconds - The time in milliseconds to delay before reshowing the tooltip if the cursor stops again.

See Also:

getReshowDelay()

getReshowDelay

public int getReshowDelay()

Returns the reshow delay value.

Returns:

An integer representing the reshow delay value.

See Also:

setReshowDelay(int)

isDismissOnMove

public boolean isDismissOnMove()

Returns true if moving the mouse makes a tooltip disappear.

setDismissOnMove

public void setDismissOnMove(boolean dismiss)

Sets the boolean value that determines whether moving the mouse makes a tooltip disappear.