Packagecom.yworks.canvas.input
Interfacepublic interface IConcurrentInputMode extends IInputMode
Implementors AbstractConcurrentInputMode, NodeEffectInputMode

Specializes the IInputMode interface to support concurrency via ConcurrencyController instances.

Implementations may request an input mutex from a ConcurrencyController that will be given to them via the controller property. This allows them to exclusively modify the contents of the view. If another successfully acquires the mutex, this mode will be disabled via the enabled property.


Public Properties
 PropertyDefined By
  controller : ConcurrencyController
[write-only] Used by clients to provide this instance with a ConcurrencyController.
IConcurrentInputMode
  enabled : Boolean
Gets or sets the enabled state of this input mode.
IConcurrentInputMode
  preferredCursor : Cursor
[read-only] Returns the cursor this mode would like to have displayed in the To indicate that this mode does not have any preferences implementations should return null.
IConcurrentInputMode
Public Methods
 MethodDefined By
 Inherited
cancel():void
Called by the client to unconditionally cancel all editing.
IInputMode
 Inherited
install(context:IInputModeContext):void
Installs this mode into the given canvas.
IInputMode
 Inherited
stop():Boolean
Called by the client in order to stop a current editing progress.
IInputMode
 Inherited
uninstall(context:IInputModeContext):void
Uninstalls this mode from the given canvas.
IInputMode
Property Detail
controllerproperty
controller:ConcurrencyController  [write-only]

Used by clients to provide this instance with a ConcurrencyController.

Note that implementations may not depend on this property being set. The controller can be used to acquire and release an input mutex.


Implementation
    public function set controller(value:ConcurrencyController):void
enabledproperty 
enabled:Boolean

Gets or sets the enabled state of this input mode.

The controller will disable this mode if another mode acquires the input mutex. Also clients can use this property to disable or reenable this instance. A disabled instance should never try to acquire the input mutex.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
preferredCursorproperty 
preferredCursor:Cursor  [read-only]

Returns the cursor this mode would like to have displayed in the

To indicate that this mode does not have any preferences implementations should return null.


Implementation
    public function get preferredCursor():Cursor




Wed Oct 7 2015, 04:52 PM +02:00