com.yworks.yfiles.view.input

Class ItemHoverInputMode

java.lang.Object

com.yworks.yfiles.view.input.ItemHoverInputMode

All Implemented Interfaces:

IInputMode

public class ItemHoverInputMode
extends Object
implements IInputMode

An input mode for use in a GraphControl that fires events when the mouse enters or leaves the visualization of a graph item.

This mode can be used to determine when the mouse is being moved from one item to the next.

This mode is Exclusive by default.

Constructor Summary

Constructors

Constructor and Description
ItemHoverInputMode() Initializes a new instance of the ItemHoverInputMode class.

Method Summary

Modifier and Type	Method and Description
void	addHoveredItemChangedListener(IEventHandler<HoveredItemChangedEventArgs> hoveredItemChangedEvent) Adds the given listener for the HoveredItemChanged event that occurs when the item that is being hovered over with the mouse changes.
void	cancel() Called by the client to unconditionally cancel all editing.
protected ConcurrencyController	getController() Returns the installed Controller.
IModelItem	getCurrentHoverItem() Gets the current item the mouse is hovering over.
protected Iterable<IModelItem>	getHitItemsAt(PointD location) Gets the items that have been hit at the given location.
Cursor	getHoverCursor() Gets the cursor to use when the mouse is hovering over a isValidHoverItem(IModelItem) valid hover item.
GraphItemTypes	getHoverItems() Gets which graph items are considered by this input mode.
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.
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	isInvalidItemsDiscardingEnabled() Determines whether items that have been hit at the current location that are not valid items should be ignored or reported as null.
protected boolean	isValidHoverItem(IModelItem item) Determines whether the given item is a valid item to be considered for hovering.
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	onHoveredItemChanged(HoveredItemChangedEventArgs hoveredItemChangedEventArgs) Raises the HoveredItemChanged event.
protected void	onStopped() Called after stop() has been called.
void	removeHoveredItemChangedListener(IEventHandler<HoveredItemChangedEventArgs> hoveredItemChangedEvent) Removes the given listener for the HoveredItemChanged event that occurs when the item that is being hovered over with the mouse changes.
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	setHoverCursor(Cursor value) Sets the cursor to use when the mouse is hovering over a isValidHoverItem(IModelItem) valid hover item.
void	setHoverItems(GraphItemTypes value) Sets which graph items are considered by this input mode.
void	setInvalidItemsDiscardingEnabled(boolean value) Determines whether items that have been hit at the current location that are not valid items should be ignored or reported as null.
void	setPriority(int value) The priority of this input mode.
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.
void	updateHover() Forces a reevaluation of the item that the mouse is currently hovering over or at a specific location.
void	updateHover(PointD location) Forces a reevaluation of the item that the mouse is currently hovering over or at a specific location.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemHoverInputMode

public ItemHoverInputMode()

Initializes a new instance of the ItemHoverInputMode class.

Method Detail

addHoveredItemChangedListener

public final void addHoveredItemChangedListener(IEventHandler<HoveredItemChangedEventArgs> hoveredItemChangedEvent)

Adds the given listener for the HoveredItemChanged event that occurs when the item that is being hovered over with the mouse changes.

This event is also fired when the mouse pointer leaves an item.

Parameters:

hoveredItemChangedEvent - The listener to add.

See Also:

removeHoveredItemChangedListener(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

getController

protected final ConcurrencyController getController()

Returns the installed Controller.

Returns:

The Controller.

getCurrentHoverItem

public final IModelItem getCurrentHoverItem()

Gets the current item the mouse is hovering over.

Returns:

The current item or null if the mouse is not hovering over a valid item.

getHitItemsAt

protected Iterable<IModelItem> getHitItemsAt(PointD location)

Gets the items that have been hit at the given location.

Parameters:

location - The location in world coordinates to query.

Returns:

An enumerable over all items that have been hit at the given location.

getHoverCursor

public final Cursor getHoverCursor()

Gets the cursor to use when the mouse is hovering over a isValidHoverItem(IModelItem) valid hover item.

Returns:

The hover cursor or null (the default).

See Also:

setHoverCursor(Cursor)

getHoverItems

public final GraphItemTypes getHoverItems()

Gets which graph items are considered by this input mode.

The default is GraphItemTypes.ALL.

Returns:

The HoverItems.

See Also:

setHoverItems(GraphItemTypes)

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.

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)

isInvalidItemsDiscardingEnabled

public final boolean isInvalidItemsDiscardingEnabled()

Determines whether items that have been hit at the current location that are not valid items should be ignored or reported as null.

Returns:

true if invalid items should be reported as null; otherwise, false, in which case the hit test enumeration continues to find the next valid item. The default is true.

See Also:

isValidHoverItem(IModelItem), setInvalidItemsDiscardingEnabled(boolean)

isValidHoverItem

protected boolean isValidHoverItem(IModelItem item)

Determines whether the given item is a valid item to be considered for hovering.

This implementation checks whether the item is covered by the HoverItems set, only.

Parameters:

item - The item to check.

Returns:

true if it is valid to report a hover over the specified item; false otherwise.

See Also:

isInvalidItemsDiscardingEnabled()

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.

onHoveredItemChanged

protected void onHoveredItemChanged(HoveredItemChangedEventArgs hoveredItemChangedEventArgs)

Raises the HoveredItemChanged event.

Parameters:

hoveredItemChangedEventArgs - The HoveredItemChangedEventArgs instance containing the event data.

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.

removeHoveredItemChangedListener

public final void removeHoveredItemChangedListener(IEventHandler<HoveredItemChangedEventArgs> hoveredItemChangedEvent)

Removes the given listener for the HoveredItemChanged event that occurs when the item that is being hovered over with the mouse changes.

This event is also fired when the mouse pointer leaves an item.

Parameters:

hoveredItemChangedEvent - The listener to remove.

See Also:

addHoveredItemChangedListener(IEventHandler)

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()

setHoverCursor

public final void setHoverCursor(Cursor value)

Sets the cursor to use when the mouse is hovering over a isValidHoverItem(IModelItem) valid hover item.

Parameters:

value - The hover cursor or null (the default).

See Also:

getHoverCursor()

setHoverItems

public final void setHoverItems(GraphItemTypes value)

Sets which graph items are considered by this input mode.

The default is GraphItemTypes.ALL.

Parameters:

value - The HoverItems to set.

See Also:

getHoverItems()

setInvalidItemsDiscardingEnabled

public final void setInvalidItemsDiscardingEnabled(boolean value)

Determines whether items that have been hit at the current location that are not valid items should be ignored or reported as null.

Parameters:

value - true if invalid items should be reported as null; otherwise, false, in which case the hit test enumeration continues to find the next valid item. The default is true.

See Also:

isValidHoverItem(IModelItem), isInvalidItemsDiscardingEnabled()

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()

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.

updateHover

public final void updateHover()

Forces a reevaluation of the item that the mouse is currently hovering over or at a specific location.

This method may be called by code that is aware of the fact that the visualization has changed, but the mouse may not have been moved. By default this implementation will only re-query the items at the mouse location when the mouse has moved. This method can be called to force a reevaluation in other cases.

updateHover

public final void updateHover(PointD location)

Forces a reevaluation of the item that the mouse is currently hovering over or at a specific location.

This method may be called by code that is aware of the fact that the visualization has changed, but the mouse may not have been moved. By default this implementation will only re-query the items at the mouse location when the mouse has moved. This method can be called to force a reevaluation in other cases.

Parameters:

location - The query location.