A controller class that manages a single IInputMode implementation.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.ConcurrencyController
See Also
Constructors
Creates an instance that can be used to install the given mode.
Remarks
mode will effectively run in a non-exclusive mode.Parameters
A map of options to pass to the method.
- mode - IInputMode
- The mode, the ConcurrencyController shall be created for.
Properties
Gets if this controller is active.
Remarks
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.
See Also
Gets or sets a value indicating whether this controller will be the only one running when it has the mutex.
Remarks
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.
Gets the current owner of the input mutex or null if no mode currently owns the mutex.
Gets or sets the cursor the associated mode of this controller would like to have displayed in the CanvasComponent.
Remarks
null.See Also
Methods
Determines if the mutex can be successfully requested currently.
Remarks
true, iff this instance is active and doesn't hold the mutex.Returns
- ↪boolean
- Whether a call to requestMutex would currently succeed.
Triggers a PriorityChanged event with EMPTY.
Remarks
Releases the input mutex.
Remarks
Can be called to request an input mutex for the input mode.
Remarks
Throws
- Exception({ name: 'Error' })
- If the mutex could not be obtained.
Events
Occurs when the preferredCursor property changes.
Remarks
Event Registration
addPreferredCursorChangedListener(function(this, EventArgs):void)Event Deregistration
removePreferredCursorChangedListener(function(this, EventArgs):void)Occurs when onPriorityChanged is called by the associated mode.
Remarks
Event Registration
addPriorityChangedListener(function(this, EventArgs):void)Event Deregistration
removePriorityChangedListener(function(this, EventArgs):void)