com.yworks.yfiles.view.input

Class ConcurrencyController

java.lang.Object

com.yworks.yfiles.view.input.ConcurrencyController

public final class ConcurrencyController
extends Object

A controller class that manages a single IInputMode implementation.

The controller will be passed to its associated IInputMode in the input mode's IInputMode.install(IInputModeContext, ConcurrencyController) method. The associated mode can request an input mutex to deactivate other modes added to the same MultiplexingInputMode and using Exclusive controllers. Releasing the mutex will reactivate the controller of other modes.

See Also:

IInputMode, MultiplexingInputMode

Constructor Summary

Constructors

Constructor and Description
ConcurrencyController(IInputMode mode) Creates an instance that can be used to IInputMode.install(com.yworks.yfiles.view.input.IInputModeContext, ConcurrencyController) the given mode.

Method Summary

Modifier and Type	Method and Description
void	addActiveChangedListener(IEventHandler<IEventArgs> activeChangedEvent) Adds the given listener for the ActiveChanged event that occurs the Active property changes.
void	addMutexObtainedListener(IEventHandler<IEventArgs> mutexObtainedEvent) Adds the given listener for the MutexObtained event that occurs when the mutex has been successfully obtained.
void	addMutexReleasedListener(IEventHandler<IEventArgs> mutexReleasedEvent) Adds the given listener for the MutexReleased event that occurs when the mutex has been released.
void	addPreferredCursorChangedListener(IEventHandler<IEventArgs> preferredCursorChangedEvent) Adds the given listener for the PreferredCursorChanged event that occurs when the PreferredCursor property changes.
void	addPriorityChangedListener(IEventHandler<IEventArgs> priorityChangedEvent) Adds the given listener for the PriorityChanged event that occurs when onPriorityChanged() is called by the associated mode.
boolean	canRequestMutex() Determines if the mutex can be successfully requested currently.
IInputMode	getMutexOwner() Gets the current owner of the input mutex or null if no mode currently owns the mutex.
Cursor	getPreferredCursor() Returns the cursor the associated mode of this controller would like to have displayed in the CanvasControl.
boolean	hasMutex() Determines whether this instance owns the input mutex.
boolean	isActive() Returns if this controller is active.
boolean	isEnabled() Gets if this controller is enabled.
boolean	isExclusive() Gets a value indicating whether this controller will be the only one running when it has the mutex.
void	onPriorityChanged() Triggers a PriorityChanged event with IEventArgs.EMPTY.
void	releaseMutex() Releases the input mutex.
void	removeActiveChangedListener(IEventHandler<IEventArgs> activeChangedEvent) Removes the given listener for the ActiveChanged event that occurs the Active property changes.
void	removeMutexObtainedListener(IEventHandler<IEventArgs> mutexObtainedEvent) Removes the given listener for the MutexObtained event that occurs when the mutex has been successfully obtained.
void	removeMutexReleasedListener(IEventHandler<IEventArgs> mutexReleasedEvent) Removes the given listener for the MutexReleased event that occurs when the mutex has been released.
void	removePreferredCursorChangedListener(IEventHandler<IEventArgs> preferredCursorChangedEvent) Removes the given listener for the PreferredCursorChanged event that occurs when the PreferredCursor property changes.
void	removePriorityChangedListener(IEventHandler<IEventArgs> priorityChangedEvent) Removes the given listener for the PriorityChanged event that occurs when onPriorityChanged() is called by the associated mode.
void	requestMutex() Can be called to request an input mutex for the input mode.
void	setEnabled(boolean value) Sets if this controller is enabled.
void	setExclusive(boolean value) Sets a value indicating whether this controller will be the only one running when it has the mutex.
void	setPreferredCursor(Cursor value) Returns the cursor the associated mode of this controller would like to have displayed in the CanvasControl.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrencyController

public ConcurrencyController(IInputMode mode)

Creates an instance that can be used to IInputMode.install(com.yworks.yfiles.view.input.IInputModeContext, ConcurrencyController) the given mode.

The returned ConcurrencyController is not synchronized with any other one so the mode will effectively run in a non-exclusive mode.

Parameters:

mode - The mode, the ConcurrencyController shall be created for.

Method Detail

addActiveChangedListener

public final void addActiveChangedListener(IEventHandler<IEventArgs> activeChangedEvent)

Adds the given listener for the ActiveChanged event that occurs the Active property changes.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

activeChangedEvent - The listener to add.

See Also:

removeActiveChangedListener(IEventHandler)

addMutexObtainedListener

public final void addMutexObtainedListener(IEventHandler<IEventArgs> mutexObtainedEvent)

Adds the given listener for the MutexObtained event that occurs when the mutex has been successfully obtained.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

mutexObtainedEvent - The listener to add.

See Also:

removeMutexObtainedListener(IEventHandler)

addMutexReleasedListener

public final void addMutexReleasedListener(IEventHandler<IEventArgs> mutexReleasedEvent)

Adds the given listener for the MutexReleased event that occurs when the mutex has been released.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

mutexReleasedEvent - The listener to add.

See Also:

removeMutexReleasedListener(IEventHandler)

addPreferredCursorChangedListener

public final void addPreferredCursorChangedListener(IEventHandler<IEventArgs> preferredCursorChangedEvent)

Adds the given listener for the PreferredCursorChanged event that occurs when the PreferredCursor property changes.

MultiplexingInputMode listens to property changes of the controller of its sub modes. properties. This event is invoked with IEventArgs.EMPTY per default.

Parameters:

preferredCursorChangedEvent - The listener to add.

See Also:

removePreferredCursorChangedListener(IEventHandler)

addPriorityChangedListener

public final void addPriorityChangedListener(IEventHandler<IEventArgs> priorityChangedEvent)

Adds the given listener for the PriorityChanged event that occurs when onPriorityChanged() is called by the associated mode.

MultiplexingInputMode listens to priority changes of the controller of its sub modes.

Parameters:

priorityChangedEvent - The listener to add.

See Also:

removePriorityChangedListener(IEventHandler)

canRequestMutex

public final boolean canRequestMutex()

Determines if the mutex can be successfully requested currently.

This will return true, iff this instance is Active and doesn't hold the mutex.

Returns:

Whether a call to requestMutex() would currently succeed.

getMutexOwner

public final IInputMode getMutexOwner()

Gets the current owner of the input mutex or null if no mode currently owns the mutex.

Returns:

The MutexOwner.

getPreferredCursor

public final Cursor getPreferredCursor()

Returns the cursor the associated mode of this controller would like to have displayed in the CanvasControl.

To indicate that the mode does not have any preferences the property should be set to null.

Returns:

The PreferredCursor.

See Also:

setPreferredCursor(Cursor)

hasMutex

public final boolean hasMutex()

Determines whether this instance owns the input mutex.

The instance owns the input mutex if it has successfully requested the mutex in the past and not yet released it.

Returns:

Whether this instance has the input mutex.

isActive

public final boolean isActive()

Returns if this controller is active.

An IInputMode should only handle events and gestures if this property on its associated ConcurrencyController is set to true.

If this controller is set as non-exclusive by its input mode it is active iff it is Enabled. Otherwise it has to be Enabled and no other input mode may have the input mutex.

Returns:

true if the associated input mode should handle events and gestures.

See Also:

addActiveChangedListener(IEventHandler)

isEnabled

public final boolean isEnabled()

Gets if this controller is enabled.

The default state is disabled. A disabled controller is always inactive.

When the controller is installed and the input mode is ready for editing, it has to set this property to true if it wants to use the input mutex.

Returns:

The Enabled.

See Also:

isActive(), addActiveChangedListener(IEventHandler), setEnabled(boolean)

isExclusive

public final boolean isExclusive()

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

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

Changing this property will temporarily disable the controller.

Returns:

The Exclusive.

See Also:

setExclusive(boolean)

onPriorityChanged

public final void onPriorityChanged()

Triggers a PriorityChanged event with IEventArgs.EMPTY.

This method should be called by the associated mode if its Priority has changed.

releaseMutex

public final void releaseMutex()

Releases the input mutex.

Modes should call this method when they have finished editing the contents exclusively. This will reactivate those modes whose controller that had been deactivated at the time the mutex has been requested.

removeActiveChangedListener

public final void removeActiveChangedListener(IEventHandler<IEventArgs> activeChangedEvent)

Removes the given listener for the ActiveChanged event that occurs the Active property changes.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

activeChangedEvent - The listener to remove.

See Also:

addActiveChangedListener(IEventHandler)

removeMutexObtainedListener

public final void removeMutexObtainedListener(IEventHandler<IEventArgs> mutexObtainedEvent)

Removes the given listener for the MutexObtained event that occurs when the mutex has been successfully obtained.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

mutexObtainedEvent - The listener to remove.

See Also:

addMutexObtainedListener(IEventHandler)

removeMutexReleasedListener

public final void removeMutexReleasedListener(IEventHandler<IEventArgs> mutexReleasedEvent)

Removes the given listener for the MutexReleased event that occurs when the mutex has been released.

This event is invoked with IEventArgs.EMPTY per default.

Parameters:

mutexReleasedEvent - The listener to remove.

See Also:

addMutexReleasedListener(IEventHandler)

removePreferredCursorChangedListener

public final void removePreferredCursorChangedListener(IEventHandler<IEventArgs> preferredCursorChangedEvent)

Removes the given listener for the PreferredCursorChanged event that occurs when the PreferredCursor property changes.

MultiplexingInputMode listens to property changes of the controller of its sub modes. properties. This event is invoked with IEventArgs.EMPTY per default.

Parameters:

preferredCursorChangedEvent - The listener to remove.

See Also:

addPreferredCursorChangedListener(IEventHandler)

removePriorityChangedListener

public final void removePriorityChangedListener(IEventHandler<IEventArgs> priorityChangedEvent)

Removes the given listener for the PriorityChanged event that occurs when onPriorityChanged() is called by the associated mode.

MultiplexingInputMode listens to priority changes of the controller of its sub modes.

Parameters:

priorityChangedEvent - The listener to remove.

See Also:

addPriorityChangedListener(IEventHandler)

requestMutex

public final void requestMutex()

Can be called to request an input mutex for the input mode.

Modes should call this method to request exclusive editing for a canvas control. canRequestMutex() should be called before requesting the mutex. If the mutex cannot be obtained, this method will trigger an exception.

Throws:

RuntimeException - If the mutex could not be obtained.

setEnabled

public final void setEnabled(boolean value)

Sets if this controller is enabled.

The default state is disabled. A disabled controller is always inactive.

When the controller is installed and the input mode is ready for editing, it has to set this property to true if it wants to use the input mutex.

Parameters:

value - The Enabled to set.

See Also:

isActive(), addActiveChangedListener(IEventHandler), isEnabled()

setExclusive

public final void setExclusive(boolean value)

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

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

Changing this property will temporarily disable the controller.

Parameters:

value - The Exclusive to set.

See Also:

isExclusive()

setPreferredCursor

public final void setPreferredCursor(Cursor value)

Returns the cursor the associated mode of this controller would like to have displayed in the CanvasControl.

To indicate that the mode does not have any preferences the property should be set to null.

Parameters:

value - The PreferredCursor to set.

See Also:

getPreferredCursor()