com.yworks.yfiles.view.input

Class MouseHoverInputMode

java.lang.Object

com.yworks.yfiles.view.input.MouseHoverInputMode

All Implemented Interfaces:

IInputMode

public class MouseHoverInputMode
extends Object
implements IInputMode

An IInputMode that detects when the mouse hovers over the CanvasControl.

This implementation will show a getToolTip(PointD) ToolTip}. In order to make use of this instance one has to register with the QueryToolTip event. Setting a custom ValidHoverLocationHitTestable will restrict the area where a tool tip can be shown.

This mode is Exclusive by default.

Constructor Summary

Constructors

Constructor and Description
MouseHoverInputMode() Creates a new instance with default values.
MouseHoverInputMode(IEventHandler<ToolTipQueryEventArgs> textProvider) Creates a new instance using the provided ToolTip and query callback.

Method Summary

Modifier and Type	Method and Description
void	addQueryToolTipListener(IEventHandler<ToolTipQueryEventArgs> queryToolTipEvent) Adds the given listener for the QueryToolTip event that occurs when this mode queries the tool tip for a certain query location.
void	cancel() Called by the client to unconditionally cancel all editing.
protected IInputModeContext	createHoverInputModeContext() Creates an IInputModeContext for use with the QueryToolTip event for the upcoming text query operation.
protected ConcurrencyController	getController() Returns the installed Controller.
Duration	getDelay() Gets the duration the mouse has to hover in one place to show a tool tip.
Duration	getDuration() Gets the duration to show the tool tip.
IInputModeContext	getInputModeContext() Returns the context instance this mode is currently installed in or null if this instance is not installed.
int	getPriority() The priority of this input mode.
protected Tooltip	getToolTip(PointD location) Callback method that provides a text for the given location or null.
protected PointD	getToolTipLocation(PointD location) Finds the position in canvas view coordinates to display the tool tip at for the given world coordinates.
PointD	getToolTipLocationOffset() Gets the tool tip location offset in view coordinates.
IHitTestable	getValidHoverLocationHitTestable() Gets an IHitTestable that determines where the mouse may hover and a tool tip can be shown.
void	hide() Immediately hides the tool tip.
void	install(IInputModeContext context, ConcurrencyController controller) Installs this mode into the given context that is provided by the canvas.
boolean	isEnabled() Gets the enabled state of this input mode.
boolean	isExclusive() Gets a value indicating whether this mode will be the only one running when it has the mutex.
boolean	isShowing() Determines whether the tool tip is currently showing.
protected void	onCanceled() Called after cancel() has been called.
protected void	onConcurrencyControllerActivated() Called after the Active property of the installed ConcurrencyController has been set to true.
protected void	onConcurrencyControllerDeactivated() Called after the Active property of the installed ConcurrencyController has been set to false.
protected void	onHide() Called when the tooltip should be hidden.
protected void	onQueryToolTip(ToolTipQueryEventArgs args) Raises the QueryToolTip event.
protected void	onShow(PointD location) Triggered when the mouse hovers over the given coordinates.
protected void	onStopped() Called after stop() has been called.
void	removeQueryToolTipListener(IEventHandler<ToolTipQueryEventArgs> queryToolTipEvent) Removes the given listener for the QueryToolTip event that occurs when this mode queries the tool tip for a certain query location.
void	setDelay(Duration value) Sets the duration the mouse has to hover in one place to show a tool tip.
void	setDuration(Duration value) Sets the duration to show the tool tip.
void	setEnabled(boolean value) Sets the enabled state of this input mode.
void	setExclusive(boolean value) Sets a value indicating whether this mode will be the only one running when it has the mutex.
void	setPriority(int value) The priority of this input mode.
void	setShowing(boolean value) Determines whether the tool tip is currently showing.
void	setToolTipLocationOffset(PointD value) Sets the tool tip location offset in view coordinates.
void	setValidHoverLocationHitTestable(IHitTestable value) Sets an IHitTestable that determines where the mouse may hover and a tool tip can be shown.
void	show(PointD location) Immediately shows the tool tip at the given location.
boolean	stop() Overridden to only return true if this instance does not currently have the input mutex.
void	uninstall(IInputModeContext context) Uninstalls this mode from the given context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseHoverInputMode

public MouseHoverInputMode()

Creates a new instance with default values.

MouseHoverInputMode

public MouseHoverInputMode(IEventHandler<ToolTipQueryEventArgs> textProvider)

Creates a new instance using the provided ToolTip and query callback.

Method Detail

addQueryToolTipListener

public final void addQueryToolTipListener(IEventHandler<ToolTipQueryEventArgs> queryToolTipEvent)

Adds the given listener for the QueryToolTip event that occurs when this mode queries the tool tip for a certain query location.

Handlers should set the ToolTip property or set/respect the Handled property accordingly.

Parameters:

queryToolTipEvent - The listener to add.

See Also:

removeQueryToolTipListener(IEventHandler)

cancel

public void cancel()

Description copied from interface: IInputMode

Called by the client to unconditionally cancel all editing.

This will be called prior to the uninstalling of this instance.

In order to stop an active input mode manually, client code should use the following idiom:

Specified by:

cancel in interface IInputMode

createHoverInputModeContext

protected IInputModeContext createHoverInputModeContext()

Creates an IInputModeContext for use with the QueryToolTip event for the upcoming text query operation.

Returns:

An instance of IInputModeContext.

getController

protected final ConcurrencyController getController()

Returns the installed Controller.

Returns:

The Controller.

getDelay

public final Duration getDelay()

Gets the duration the mouse has to hover in one place to show a tool tip.

The default is

 1
 

second.

Returns:

The Delay.

See Also:

setDelay(Duration)

getDuration

public final Duration getDuration()

Gets the duration to show the tool tip.

The default value is 3 seconds.

Returns:

The Duration.

See Also:

setDuration(Duration)

getInputModeContext

public final IInputModeContext getInputModeContext()

Description copied from interface: IInputMode

Returns the context instance this mode is currently installed in or null if this instance is not installed.

Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the ParentInputMode should be used.

Specified by:

getInputModeContext in interface IInputMode

Returns:

The InputModeContext.

getPriority

public final int getPriority()

Description copied from interface: IInputMode

The priority of this input mode.

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Specified by:

getPriority in interface IInputMode

Returns:

The Priority.

getToolTip

protected Tooltip getToolTip(PointD location)

Callback method that provides a text for the given location or null.

Parameters:

location - The location to find a text for.

Returns:

A string or null to indicate that no tool tip should be shown.

See Also:

addQueryToolTipListener(IEventHandler), createHoverInputModeContext()

getToolTipLocation

protected PointD getToolTipLocation(PointD location)

Finds the position in canvas view coordinates to display the tool tip at for the given world coordinates.

This method adds the ToolTipLocationOffset after converting the given location to view coordinates.

Parameters:

location - The position in world coordinates.

Returns:

The position in view coordinates.

See Also:

getToolTipLocationOffset()

getToolTipLocationOffset

public final PointD getToolTipLocationOffset()

Gets the tool tip location offset in view coordinates.

The value of this property is used by getToolTipLocation(PointD) in order to move the tool tip away from the mouse pointer. The default value is (0,0).

Returns:

The ToolTipLocationOffset.

See Also:

getToolTipLocation(PointD), setToolTipLocationOffset(PointD)

getValidHoverLocationHitTestable

public final IHitTestable getValidHoverLocationHitTestable()

Gets an IHitTestable that determines where the mouse may hover and a tool tip can be shown.

The default value of this property is IHitTestable.ALWAYS

Returns:

The ValidHoverLocationHitTestable.

See Also:

setValidHoverLocationHitTestable(IHitTestable)

hide

public void hide()

Immediately hides the tool tip.

install

public void install(IInputModeContext context,
                    ConcurrencyController controller)

Installs this mode into the given context that is provided by the canvas.

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation, first.

Specified by:

install in interface IInputMode

Parameters:

context - The context that this instance shall be installed into. The same instance will be passed to this instance during IInputMode.uninstall(IInputModeContext). A reference to the context may be kept and queried during the time the mode is installed.

controller - The Controller for this mode.

See Also:

IInputMode.uninstall(IInputModeContext)

isEnabled

public boolean isEnabled()

Gets the enabled state of this input mode.

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.

Returns:

The Enabled.

See Also:

setEnabled(boolean)

isExclusive

public final boolean isExclusive()

Gets a value indicating whether this mode will be the only one running when it has the mutex.

The value of this property will be delegated to the Exclusive property of the Controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.

Returns:

The Exclusive.

See Also:

setExclusive(boolean)

isShowing

public final boolean isShowing()

Determines whether the tool tip is currently showing.

Returns:

The Showing.

See Also:

setShowing(boolean)

onCanceled

protected void onCanceled()

Called after cancel() has been called.

Can be overridden in subclasses to perform additional actions after the mode has been canceled.

This implementation does nothing.

onConcurrencyControllerActivated

protected void onConcurrencyControllerActivated()

Called after the Active property of the installed ConcurrencyController has been set to true.

Can be overridden in subclasses to perform additional actions after the mode has been activated.

Overriding implementations should call the base implementation.

onConcurrencyControllerDeactivated

protected void onConcurrencyControllerDeactivated()

Called after the Active property of the installed ConcurrencyController has been set to false.

Can be overridden in subclasses to perform additional actions after the mode has been deactivated.

Overriding implementations should call the base implementation.

onHide

protected void onHide()

Called when the tooltip should be hidden.

onQueryToolTip

protected void onQueryToolTip(ToolTipQueryEventArgs args)

Raises the QueryToolTip event.

Parameters:

args - The ToolTipQueryEventArgs instance containing the event data.

onShow

protected void onShow(PointD location)

Triggered when the mouse hovers over the given coordinates.

This method will call getToolTip(PointD) to query tooltip to display at the location returned by getToolTipLocation(PointD) if the content is not null.

onStopped

protected void onStopped()

Called after stop() has been called.

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

removeQueryToolTipListener

public final void removeQueryToolTipListener(IEventHandler<ToolTipQueryEventArgs> queryToolTipEvent)

Removes the given listener for the QueryToolTip event that occurs when this mode queries the tool tip for a certain query location.

Handlers should set the ToolTip property or set/respect the Handled property accordingly.

Parameters:

queryToolTipEvent - The listener to remove.

See Also:

addQueryToolTipListener(IEventHandler)

setDelay

public final void setDelay(Duration value)

Sets the duration the mouse has to hover in one place to show a tool tip.

The default is

 1
 

second.

Parameters:

value - The Delay to set.

See Also:

getDelay()

setDuration

public final void setDuration(Duration value)

Sets the duration to show the tool tip.

The default value is 3 seconds.

Parameters:

value - The Duration to set.

See Also:

getDuration()

setEnabled

public void setEnabled(boolean value)

Sets the enabled state of this input mode.

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.

Parameters:

value - The Enabled to set.

See Also:

isEnabled()

setExclusive

public final void setExclusive(boolean value)

Sets a value indicating whether this mode will be the only one running when it has the mutex.

The value of this property will be delegated to the Exclusive property of the Controller.

If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.

Parameters:

value - The Exclusive to set.

See Also:

isExclusive()

setPriority

public final void setPriority(int value)

The priority of this input mode.

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Parameters:

value - The Priority to set.

See Also:

getPriority()

setShowing

public final void setShowing(boolean value)

Determines whether the tool tip is currently showing.

Parameters:

value - The Showing to set.

See Also:

isShowing()

setToolTipLocationOffset

public final void setToolTipLocationOffset(PointD value)

Sets the tool tip location offset in view coordinates.

The value of this property is used by getToolTipLocation(PointD) in order to move the tool tip away from the mouse pointer. The default value is (0,0).

Parameters:

value - The ToolTipLocationOffset to set.

See Also:

getToolTipLocation(PointD), getToolTipLocationOffset()

setValidHoverLocationHitTestable

public final void setValidHoverLocationHitTestable(IHitTestable value)

Sets an IHitTestable that determines where the mouse may hover and a tool tip can be shown.

The default value of this property is IHitTestable.ALWAYS

Parameters:

value - The ValidHoverLocationHitTestable to set.

See Also:

getValidHoverLocationHitTestable()

show

public void show(PointD location)

Immediately shows the tool tip at the given location.

Parameters:

location - The location in the world coordinate system.

stop

public boolean stop()

Overridden to only return true if this instance does not currently have the input mutex.

Specified by:

stop in interface IInputMode

Returns:

true iff this instance does not own the mutex.

See Also:

IInputMode.cancel()

uninstall

public void uninstall(IInputModeContext context)

Uninstalls this mode from the given context.

This code should clean up all changes made to the canvas in the IInputMode.install(IInputModeContext, ConcurrencyController) method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

Specified by:

uninstall in interface IInputMode

Parameters:

context - The context to deregister from. This is the same instance that had been passed to IInputMode.install(IInputModeContext, ConcurrencyController) during installation.