ilog.views.swing
Class IlvToolTipManager

java.lang.Object
  ilog.views.swing.IlvToolTipManager

All Implemented Interfaces:

SwingConstants

public class IlvToolTipManager
extends Object
implements SwingConstants

This class enables Swing tooltips in a manager view.

Each graphic object contained in the manager associated with the view can have its own tooltip text, which must be set using the method IlvGraphic.setToolTipText(java.lang.String).

To enable tooltips in a view, call the static method registerView(ilog.views.IlvManagerView). To disable tooltips, call unregisterView(ilog.views.IlvManagerView).

Since:

JViews 3.5

See Also:

IlvGraphic, IlvManagerView

Field Summary

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Method Summary

static String	createMultiLineToolTipText(String[] lines, int alignment) Deprecated. Beginning with ILOG JViews 8.1, please use the method IlvSwingUtil.createMultiLineToolTipText(java.lang.String[], int) instead.
static ToolTipManager	getToolTipManager() Returns the underlying Swing tool tip manager.
static void	registerView(IlvManagerView view) Enables the tooltips in a manager view.
static void	unregisterView(IlvManagerView view) Disables the tooltips in a manager view.

Methods inherited from class java.lang.Object

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

Method Detail

registerView

public static void registerView(IlvManagerView view)

Enables the tooltips in a manager view.

Parameters:

view - The manager view.

See Also:

IlvGraphic.setToolTipText(java.lang.String).

unregisterView

public static void unregisterView(IlvManagerView view)

Disables the tooltips in a manager view.

Parameters:

view - The manager view.

createMultiLineToolTipText

public static String createMultiLineToolTipText(String[] lines,
                                                int alignment)

Deprecated. Beginning with ILOG JViews 8.1, please use the method IlvSwingUtil.createMultiLineToolTipText(java.lang.String[], int) instead.

Creates an HTML text string that will render lines as a multiline tooltip.

Parameters:

lines - The array of text strings. Each string will be formatted as a separate HTML paragraph. Each string should be valid HTML; if you want to show a simple line of text, some characters need to be escaped, see IlvSwingUtil.escapeForHTMLElement(java.lang.String, boolean).

alignment - The horizontal alignment of the text. It must be one of the constants: LEFT, RIGHT, or CENTER defined in javax.swing.SwingConstants.

getToolTipManager

public static ToolTipManager getToolTipManager()

Returns the underlying Swing tool tip manager. The JViews tool tip manager delegates the display of tool tips to the Swing tool tip manager. Parameters such as the initial delay or the dismiss delay can be set on the Swing tool tip manager.

Since:

JViews 8.0

See Also:

ToolTipManager.setInitialDelay(int), ToolTipManager.setDismissDelay(int), ToolTipManager.setReshowDelay(int)