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

Modifier and Type	Method and Description
static String	createMultiLineToolTipText(String[] lines, int alignment) Deprecated. Beginning with Rogue Wave JViews 8.1, please use the method IlvSwingUtil.createMultiLineToolTipText(java.lang.String[], int) instead.
static int	getToolTipChangeDelay() Returns the tooltip change delay.
static ToolTipManager	getToolTipManager() Returns the underlying Swing tooltip manager.
static boolean	isAdvancedBidiOnForTooltips() Returns whether advanced bidi in enabled for tooltips.
static void	registerView(IlvManagerView view) Enables the tooltips in a manager view.
static void	setAdvancedBidiOnForTooltips(boolean enable) Sets whether advanced bidi in enabled for tooltips.
static void	setToolTipChangeDelay(int delay) Sets the tooltip change delay.
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

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

Deprecated. Beginning with Rogue Wave 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 tooltip manager. The JViews tooltip manager delegates the display of tooltips to the Swing tooltip manager. Parameters such as the initial delay or the dismiss delay can be set on the Swing tooltip manager.

Since:

JViews 8.0

See Also:

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

setToolTipChangeDelay

public static void setToolTipChangeDelay(int delay)

Sets the tooltip change delay.

If the tooltip change delay is 0, the tooltip is calculated immediately when the mouse pointer is moved. When the tooltip is already visible, it is updated immediately when the object under the mouse changes. This can slow down the mouse movements considerably, when a large number of nonzoomable objects are shown in a manager view.

If the tooltip change delay is larger than 0, the tooltips are not immediately calculated: When a tooltip appears and you move the mouse pointer, the tooltip manager will wait until the tooltip change delay elapsed before hiding the tooltip and calculating and displaying the new tooltip. This allows faster mouse movements and improves the overall performance of the system.

The tooltip change delay has an effect if the manager view is contained in a IlvJScrollManagerView or IlvJManagerViewPanel. Otherwise, the delay has no effect and the tooltips are always calculated immediately.

The default delay is 20 milliseconds. Additional delays may occur if IlvManager.getObject(IlvPoint, IlvManagerView, boolean) takes a lot of time.

Parameters:

delay - The delay in milliseconds.

Since:

JViews 8.6

See Also:

getToolTipChangeDelay()

getToolTipChangeDelay

public static int getToolTipChangeDelay()

Returns the tooltip change delay.

Since:

JViews 8.6

See Also:

setToolTipChangeDelay(int)

setAdvancedBidiOnForTooltips

public static void setAdvancedBidiOnForTooltips(boolean enable)

Sets whether advanced bidi in enabled for tooltips. It is enabled by default. If tooltip text is specified by HTML declarations, the HTML specification must be parsed and converted. Since the tooltip HTML is typically very simple, the HTML parser used here is very simple and quick, however it cannot handle full HTML. If you use complex HTML specifications for tooltips that are not supported by the HTML parser for tooltips, you can switch off the advanced bidi for tooltips. In that case, you need to specify the base text direction in your html declaration yourself, since IlvGraphic.getToolTipBaseTextDirection() is ignored in this case.

Since:

JViews 8.8

isAdvancedBidiOnForTooltips

public static boolean isAdvancedBidiOnForTooltips()

Returns whether advanced bidi in enabled for tooltips.

Since:

JViews 8.8