com.yworks.yfiles.view.input

Class ToolTipQueryEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.ToolTipQueryEventArgs

All Implemented Interfaces:

IEventArgs

Direct Known Subclasses:

QueryItemToolTipEventArgs

public class ToolTipQueryEventArgs
extends InputModeEventArgs

Event argument that can be used to query the text to display when the mouse hovers over the given point in world coordinate space.

See Also:

MouseHoverInputMode

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
ToolTipQueryEventArgs(IInputModeContext context, PointD queryLocation) Initializes a new instance of the ToolTipQueryEventArgs class.

Method Summary

Modifier and Type	Method and Description
PointD	getQueryLocation() Gets the query location in world coordinates.
Tooltip	getToolTip() Gets the tool tip to use.
boolean	isHandled() Gets a value indicating whether this ToolTipQueryEventArgs has been handled.
void	setHandled(boolean value) Sets a value indicating whether this ToolTipQueryEventArgs has been handled.
void	setToolTip(Tooltip value) Sets the tool tip to use.

Methods inherited from class com.yworks.yfiles.view.input.InputModeEventArgs

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolTipQueryEventArgs

public ToolTipQueryEventArgs(IInputModeContext context,
                             PointD queryLocation)

Initializes a new instance of the ToolTipQueryEventArgs class.

Parameters:

context - The context of the query.

queryLocation - The query location.

Method Detail

getQueryLocation

public final PointD getQueryLocation()

Gets the query location in world coordinates.

Returns:

The query location.

getToolTip

public final Tooltip getToolTip()

Gets the tool tip to use.

Setting this property will set the Handled property to true.

Returns:

The tool tip.

See Also:

setToolTip(javafx.scene.control.Tooltip)

isHandled

public final boolean isHandled()

Gets a value indicating whether this ToolTipQueryEventArgs has been handled.

This property is automatically set to true if ToolTip property has been assigned a value. Marking this event as handled tells the issuer of the query whether the ToolTip property should be used or whether additional logic should be used to determine whether to show the menu.

Returns:

true if handled; false otherwise.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets a value indicating whether this ToolTipQueryEventArgs has been handled.

This property is automatically set to true if ToolTip property has been assigned a value. Marking this event as handled tells the issuer of the query whether the ToolTip property should be used or whether additional logic should be used to determine whether to show the menu.

Parameters:

value - true if handled; false otherwise.

See Also:

isHandled()

setToolTip

public final void setToolTip(Tooltip value)

Sets the tool tip to use.

Setting this property will set the Handled property to true.

Parameters:

value - The tool tip.

See Also:

getToolTip()