| Package | com.yworks.canvas.input |
| Class | public class ClickInputMode |
| Inheritance | ClickInputMode  StateMachineInputMode AbstractConcurrentInputMode AbstractInputMode flash.events.EventDispatcher |
Clients add listeners for the clicked event to get notified of mouse clicks.
If the doubleClick property is set to true, this input mode
will handle double clicks instead of single clicks.
| Property | Defined By | ||
|---|---|---|---|
 | canceledState : State [read-only]
Returns the canceled state of the state machine. | StateMachineInputMode | |
| canvas : CanvasComponent [read-only]
The canvas instance this mode is currently installed in or null
| AbstractInputMode | |
| clickPoint : IPoint [read-only]
The point, on whose coordinates the last click happened. | ClickInputMode | ||
| controller : ConcurrencyController
Gets or injects the ConcurrencyController for this instance. | AbstractConcurrentInputMode | |
| doubleClick : Boolean
Determines whether this input mode handles single (false) or double (true) mouse clicks. | ClickInputMode | ||
| enabled : Boolean
Gets or sets the enabled state of this input mode. | AbstractConcurrentInputMode | |
| inputModeContext : IInputModeContext [read-only]
The context instance this mode is currently installed in or
null if this instance is not installed. | AbstractInputMode | |
| installed : Boolean [read-only]
Whether this mode is currently installed, i.e
if a call to the canvas property will yield a non-null result. | AbstractInputMode | |
| lastMouseEvent : CanvasMouseEvent [read-only]
Returns the last mouse event. | StateMachineInputMode | |
| preferredCursor : Cursor
Gets or sets the cursor this mode would like to have displayed in the CanvasComponent. | AbstractConcurrentInputMode | |
| startState : State [read-only]
Returns the start state of the state machine. | StateMachineInputMode | |
| stateMachine : StateMachine [read-only]
Gets the state machine. | StateMachineInputMode | |
| stoppedState : State [read-only]
Returns the stopped state of the state machine. | StateMachineInputMode | |
| swallowFocusClick : Boolean
Gets or sets a property that determines whether clicks should
be swallowed if they happen within a short amount of time
after the CanvasComponent got focus. | ClickInputMode | ||
| Method | Defined By | ||
|---|---|---|---|
Standard constructor. | ClickInputMode | ||
cancel():void [override]
Runs the machine using the cancel and reset events,
releases the input mutex and returns. | ClickInputMode | ||
| dispose():void
Disposes this input mode. | AbstractInputMode | |
| install(context:IInputModeContext):void
Installs this mode into the canvas of the given context. | AbstractInputMode | |
| resetMachine():void
Runs the machine using a special reset event. | StateMachineInputMode | |
| run(evt:Event):void
Tries to run the virtual machine using the pair of source and event argument
to determine which transition to take. | StateMachineInputMode | |
stop():Boolean [override]
Runs the machine using a special stop event. | ClickInputMode | ||
| uninstall(context:IInputModeContext):void
Uninstalls this mode from the canvas. | AbstractInputMode | |
| Method | Defined By | ||
|---|---|---|---|
begin(t:TransitionEvent):void | ClickInputMode | ||
| canRequestMutex():Boolean
Determines whether this instance can request the InputMutex. | AbstractConcurrentInputMode | |
|
Factory method that creates a canceled State
for the given machine. | StateMachineInputMode | |
Create the context for the next ClickEvent. | ClickInputMode | ||
createClickRecognizer():Function
Creates the event recognizer that is used to recognize the clicks for this instance. | ClickInputMode | ||
createPressRecognizer():Function
Creates the event recognizer that is used to recognize the press event for this instance. | ClickInputMode | ||
createReleaseRecognizer():Function
Creates the event recognizer that is used to recognize the release event for this instance. | ClickInputMode | ||
|
Factory method that creates a start State for the given machine. | StateMachineInputMode | |
|
Factory method that creates the state machine. | StateMachineInputMode | |
|
Factory method that creates a stopped State
for the given machine. | StateMachineInputMode | |
end(t:TransitionEvent):void | ClickInputMode | ||
| fireInstalled():void | AbstractInputMode | |
| fireInstalling():void | AbstractInputMode | |
| fireUninstalled():void | AbstractInputMode | |
| fireUninstalling():void | AbstractInputMode | |
| hasMutex():Boolean
Determines whether this instance owns the input mutex. | AbstractConcurrentInputMode | |
| initialize():void
Performs one-time initialization of this instance. | AbstractInputMode | |
initializeStateMachine(machine:StateMachine, startState:State, canceledState:State, stoppedState:State, finishedState:State):void [override]
Called to initialize the state machine. | ClickInputMode | ||
| installCore(context:IInputModeContext):void [override]
Installs this mode into the given canvas. | StateMachineInputMode | |
installListeners():void [override]
Installs all necessary listeners to trigger the run method. | ClickInputMode | ||
| invalidate():void
Convenience method for subclass implementations that invalidates
the canvasComponent this mode is currently installed in. | AbstractInputMode | |
| isCancelEvent(evt:Event):Boolean
Method that identifies an event as a cancel event. | StateMachineInputMode | |
| isDisabledEvent(evt:Event):Boolean
Method that identifies an event as a disabled event. | StateMachineInputMode | |
| isEnabledEvent(evt:Event):Boolean
Method that identifies an event as an enabled event. | StateMachineInputMode | |
| isMutexAquiredEvent(evt:Event):Boolean
Method that identifies an event as a mutexAquired event. | StateMachineInputMode | |
| isMutexLostEvent(evt:Event):Boolean
Method that identifies an event as a mutexLost event. | StateMachineInputMode | |
| isStopEvent(evt:Event):Boolean
Method that identifies an event as a stop event. | StateMachineInputMode | |
| onCancelStateEntered(evt:StateChangeEvent):void
Called when the cancel state has been entered. | StateMachineInputMode | |
onClicked():void | ClickInputMode | ||
| onDisable():void
Runs the state machine using a disable event. | StateMachineInputMode | |
| onDisabled():void
Called when the enabled property changes to false. | AbstractConcurrentInputMode | |
| onEnable():void
Runs the state machine using a enable event. | StateMachineInputMode | |
| onEnabled():void
Called when the enabled property changes to true. | AbstractConcurrentInputMode | |
onMachineReset():void [override]
| ClickInputMode | ||
| onMutexObtained():void [override]
Runs the state machine using a mutex obtained event. | StateMachineInputMode | |
| onMutexReleased():void [override]
Runs the state machine using a mutex lost event. | StateMachineInputMode | |
|
Called when the preferredCursor property changes. | AbstractConcurrentInputMode | |
| onRun(evt:Event):void
Callback method that will be called after the state machine has
been run using the arguments provided. | StateMachineInputMode | |
| onStopStateEntered(evt:StateChangeEvent):void
Called when the cancel state has been entered. | StateMachineInputMode | |
| releaseMutex():void
Releases the mutex that is currently owned by this instance. | AbstractConcurrentInputMode | |
| requestMutex():void
Requests the InputMutex from the current controller. | AbstractConcurrentInputMode | |
| setLastMouseEvent(evt:CanvasMouseEvent):void | StateMachineInputMode | |
| setPreferredCursorTransition(cursorClass:Class):Function
Factory method that can be used to obtain an listener
implementation that sets the given preferredCursor. | StateMachineInputMode | |
| setResetCursorTransition():Function
Factory method that can be used to obtain a listener implementation
that resets the preferredCursor. | StateMachineInputMode | |
| uninstallCore(context:IInputModeContext):void [override]
Uninstalls this mode from the canvas. | StateMachineInputMode | |
uninstallListeners():void [override]
Uninstalls all listeners, this instance has installed on calling intallListeners()
| ClickInputMode | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the mouse has been clicked. | ClickInputMode | |||
| Dispatched after the input mode was installed. | AbstractInputMode | ||
| Dispatched before the input mode will be installed. | AbstractInputMode | ||
| Dispatched when the default cursor changed. | AbstractConcurrentInputMode | ||
| Dispatched after the input mode was uninstalled. | AbstractInputMode | ||
| Dispatched before the input mode will be uninstalled. | AbstractInputMode | ||
| clickPoint | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesclickPoint:IPoint [read-only] The point, on whose coordinates the last click happened.
This property may return null, if no mouse click was performed since initialization.
public function get clickPoint():IPoint| doubleClick | property |
doubleClick:Boolean
Determines whether this input mode handles single (false) or double (true) mouse clicks.
public function get doubleClick():Boolean public function set doubleClick(value:Boolean):void| swallowFocusClick | property |
swallowFocusClick:BooleanGets or sets a property that determines whether clicks should be swallowed if they happen within a short amount of time after the CanvasComponent got focus.
If set to true clicks are discarded within
100 ms after the focus entered.
The default value is true.
public function get swallowFocusClick():Boolean public function set swallowFocusClick(value:Boolean):void| ClickInputMode | () | Constructor |
public function ClickInputMode()Standard constructor.
| begin | () | method |
| cancel | () | method |
override public function cancel():voidRuns the machine using the cancel and reset events, releases the input mutex and returns.
| createClickInputModeContext | () | method |
protected function createClickInputModeContext():IInputModeContext
Create the context for the next ClickEvent.
IInputModeContext |
| createClickRecognizer | () | method |
protected function createClickRecognizer():FunctionCreates the event recognizer that is used to recognize the clicks for this instance.
An event recognizer is a function that takes an event object as its only argument and returns a boolean that indicates whether the event was recognized.
ReturnsFunction |
See also
| createPressRecognizer | () | method |
protected function createPressRecognizer():FunctionCreates the event recognizer that is used to recognize the press event for this instance.
An event recognizer is a function that takes an event object as its only argument and returns a boolean that indicates whether the event was recognized.
ReturnsFunction |
See also
| createReleaseRecognizer | () | method |
protected function createReleaseRecognizer():FunctionCreates the event recognizer that is used to recognize the release event for this instance.
An event recognizer is a function that takes an event object as its only argument and returns a boolean that indicates whether the event was recognized.
ReturnsFunction |
See also
| end | () | method |
| initializeStateMachine | () | method |
override protected function initializeStateMachine(machine:StateMachine, startState:State, canceledState:State, stoppedState:State, finishedState:State):voidCalled to initialize the state machine.
This implementation does nothing.
Parameters
machine:StateMachine — The machine to initialize and configure
| |
startState:State — The start state to use.
| |
canceledState:State — The canceled state to use.
| |
stoppedState:State — The stopped state to use.
| |
finishedState:State — The finished state to use.
|
| installListeners | () | method |
override protected function installListeners():void
Installs all necessary listeners to trigger the run method.
This implementation registers for all mouse events and keyboard events.
| onClicked | () | method |
protected function onClicked():void
| onMachineReset | () | method |
override protected function onMachineReset():void
| stop | () | method |
override public function stop():BooleanRuns the machine using a special stop event.
If the machine arrives at the startState, this method
will release the input mutex and return true.
Boolean — true if the machine arrived at the start state and stopped.
|
| uninstallListeners | () | method |
override protected function uninstallListeners():void
Uninstalls all listeners, this instance has installed on calling intallListeners()
| click | Event |
com.yworks.canvas.input.ClickEventcom.yworks.canvas.input.ClickEvent.CLICKDispatched when the mouse has been clicked.