Package | com.yworks.graph.input |
Class | public class ResizeStripeInputMode |
Inheritance | ResizeStripeInputMode StateMachineInputMode AbstractConcurrentInputMode AbstractInputMode flash.events.EventDispatcher |
By default, adjacent stripes are moved. To redistribute the space instead, use
resizeNeighborsRecognizer
. Also, by default the content of the stripes
is either moved or constrains the minimum available sizes for the stripe resize operations.
To completely ignore all content nodes, use ignoreContentRecognizer
.
Property | Defined By | ||
---|---|---|---|
canceledState : State [read-only]
Returns the canceled state of the state machine. | StateMachineInputMode | ||
cancelRecognizer : Function
The "cancel" recognizer. | ResizeStripeInputMode | ||
canvas : CanvasComponent [read-only]
The canvas instance this mode is currently installed in or null
| AbstractInputMode | ||
controller : ConcurrencyController
Gets or injects the ConcurrencyController for this instance. | AbstractConcurrentInputMode | ||
draggedRecognizer : Function
The "dragged" recognizer. | ResizeStripeInputMode | ||
enabled : Boolean
Gets or sets the enabled state of this input mode. | AbstractConcurrentInputMode | ||
ignoreContentRecognizer : Function
The recognizer that changes the behaviour to ignore the content of all stripes instead of
moving them or considering for minimum sizes. | ResizeStripeInputMode | ||
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 | ||
pressedRecognizer : Function
The "pressed" state recognizer. | ResizeStripeInputMode | ||
releasedRecognizer : Function
The "released" recognizer. | ResizeStripeInputMode | ||
resizeNeighborsRecognizer : Function
The recognizer that changes the behaviour to resize adjacent stripes instead of moving them. | ResizeStripeInputMode | ||
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 |
Method | Defined By | ||
---|---|---|---|
Creates a new instance of this input mode. | ResizeStripeInputMode | ||
cancel():void [override]
Runs the machine using the cancel and reset events,
releases the input mutex and returns. | StateMachineInputMode | ||
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. | StateMachineInputMode | ||
uninstall(context:IInputModeContext):void
Uninstalls this mode from the canvas. | AbstractInputMode |
Method | Defined By | ||
---|---|---|---|
canRequestMutex():Boolean
Determines whether this instance can request the InputMutex. | AbstractConcurrentInputMode | ||
Factory method that creates a canceled State
for the given machine. | StateMachineInputMode | ||
Creates the resize visualization. | ResizeStripeInputMode | ||
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 | ||
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. | ResizeStripeInputMode | ||
installCore(context:IInputModeContext):void [override]
Installs this mode into the given canvas. | StateMachineInputMode | ||
installListeners():void
Installs all necessary listeners to trigger the run method. | StateMachineInputMode | ||
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 | ||
isValidBegin(e:Event):Boolean
Called to determine whether it is valid to begin the gesture. | ResizeStripeInputMode | ||
onCancelStateEntered(evt:StateChangeEvent):void
Called when the cancel state has been entered. | StateMachineInputMode | ||
onDisable():void
Runs the state machine using a disable event. | StateMachineInputMode | ||
onDisabled():void
Called when the enabled property changes to false. | AbstractConcurrentInputMode | ||
onDragCanceled():void
Callback triggered when the drag has been canceled. | ResizeStripeInputMode | ||
onDragFinished():void
Callback triggered once the drag has been finalized. | ResizeStripeInputMode | ||
onDragStarted():void
Callback triggered when the drag is initialized and has started. | ResizeStripeInputMode | ||
onDragStarting():void
Callback triggered when the user starts dragging. | ResizeStripeInputMode | ||
onEnable():void
Runs the state machine using a enable event. | StateMachineInputMode | ||
onEnabled():void
Called when the enabled property changes to true. | AbstractConcurrentInputMode | ||
onMachineReset():void | StateMachineInputMode | ||
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. | ResizeStripeInputMode | ||
uninstallListeners():void
Uninstalls all listeners, this instance has installed on calling intallListeners()
| StateMachineInputMode |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the drag has been canceled. | ResizeStripeInputMode | |||
Dispatched when the drag has been finished. | ResizeStripeInputMode | |||
Dispatched when the drag is initialized and has started. | ResizeStripeInputMode | |||
Dispatched when the drag has started. | ResizeStripeInputMode | |||
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 |
Constant | Defined By | ||
---|---|---|---|
INSTALLED : String = installed [static]
| AbstractInputMode | ||
INSTALLING : String = installing [static]
| AbstractInputMode | ||
POLICY_CONSIDER_CONTENT : String = ConsiderContent [static]
Describes the policy to use when resizing stripes:
Stripes can't be made smaller than their content nodes. | ResizeStripeInputMode | ||
POLICY_IGNORE_CONTENT : String = IgnoreContent [static]
Describes the policy to use when resizing stripes:
Stripe content is ignored when resizing. | ResizeStripeInputMode | ||
PREFERRED_CURSOR_CHANGED : String = preferredCursorChanged [static] | AbstractConcurrentInputMode | ||
UNINSTALLED : String = uninstalled [static]
| AbstractInputMode | ||
UNINSTALLING : String = uninstalling [static]
| AbstractInputMode |
cancelRecognizer | property |
cancelRecognizer:Function
The "cancel" recognizer.
This recognizer recognizes a cancel action during the resize operation.
public function get cancelRecognizer():Function
public function set cancelRecognizer(value:Function):void
draggedRecognizer | property |
draggedRecognizer:Function
The "dragged" recognizer.
This recognizer instance determines when the user is dragging the mouse to resize the stripe.
public function get draggedRecognizer():Function
public function set draggedRecognizer(value:Function):void
ignoreContentRecognizer | property |
ignoreContentRecognizer:Function
The recognizer that changes the behaviour to ignore the content of all stripes instead of moving them or considering for minimum sizes.
If this recognizer recognizes its gesture, the behavior will be to completely ignore all stripe contents.
public function get ignoreContentRecognizer():Function
public function set ignoreContentRecognizer(value:Function):void
pressedRecognizer | property |
pressedRecognizer:Function
The "pressed" state recognizer.
This recognizer instance will be used to determine when the user begins to resize the stripe.
public function get pressedRecognizer():Function
public function set pressedRecognizer(value:Function):void
releasedRecognizer | property |
releasedRecognizer:Function
The "released" recognizer.
This instance determines when the user has finished the resize operation.
public function get releasedRecognizer():Function
public function set releasedRecognizer(value:Function):void
resizeNeighborsRecognizer | property |
resizeNeighborsRecognizer:Function
The recognizer that changes the behaviour to resize adjacent stripes instead of moving them.
If this recognizer recognizes its gesture, the behavior will be to resize adjacent stripes instead of moving them (which is the default).
public function get resizeNeighborsRecognizer():Function
public function set resizeNeighborsRecognizer(value:Function):void
ResizeStripeInputMode | () | Constructor |
public function ResizeStripeInputMode()
Creates a new instance of this input mode.
createResizeVisualization | () | method |
protected function createResizeVisualization(tableItem:IStripe, ctx:IInputModeContext):IDisplayObjectCreator
Creates the resize visualization.
Parameters
tableItem:IStripe — The table item to resize.
| |
ctx:IInputModeContext — The current input mode context.
|
IDisplayObjectCreator — A display object creator that visualizes the resize gesture.
|
initializeStateMachine | () | method |
override protected function initializeStateMachine(machine:StateMachine, startState:State, canceledState:State, stoppedState:State, finishedState:State):void
Called 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.
|
isValidBegin | () | method |
protected function isValidBegin(e:Event):Boolean
Called to determine whether it is valid to begin the gesture.
This implementation checks whether a stripe border has been hit at the current mouse position.
Parameters
e:Event — The event to test.
|
Boolean — true iff a stripe border has been hit at the last mouse location.
|
onDragCanceled | () | method |
protected function onDragCanceled():void
Callback triggered when the drag has been canceled.
This method dispatches the dragCanceled
event.
onDragFinished | () | method |
protected function onDragFinished():void
Callback triggered once the drag has been finalized.
This method dispatches the dragFinished
event.
onDragStarted | () | method |
protected function onDragStarted():void
Callback triggered when the drag is initialized and has started.
This method dispatches the dragStarted
event.
onDragStarting | () | method |
protected function onDragStarting():void
Callback triggered when the user starts dragging.
This method dispatches the dragStarting
event.
uninstallCore | () | method |
override protected function uninstallCore(context:IInputModeContext):void
Uninstalls this mode from the canvas.
Subclasses should always call super.uninstallCore( canvas )
as the last
statement.
This implementation calls uninstallListeners
.
Parameters
context:IInputModeContext — The canvas component to uninstall this input mode from.
|
dragCanceled | Event |
com.yworks.canvas.input.DragEvent
com.yworks.canvas.input.DragEvent.DRAG_CANCELED
Dispatched when the drag has been canceled.
dragFinished | Event |
com.yworks.canvas.input.DragEvent
com.yworks.canvas.input.DragEvent.DRAG_FINISHED
Dispatched when the drag has been finished.
dragStarted | Event |
com.yworks.canvas.input.DragEvent
com.yworks.canvas.input.DragEvent.DRAG_STARTED
Dispatched when the drag is initialized and has started.
dragStarting | Event |
com.yworks.canvas.input.DragEvent
com.yworks.canvas.input.DragEvent.DRAG_STARTING
Dispatched when the drag has started.
POLICY_CONSIDER_CONTENT | Constant |
public static const POLICY_CONSIDER_CONTENT:String = ConsiderContent
Describes the policy to use when resizing stripes: Stripes can't be made smaller than their content nodes.
POLICY_IGNORE_CONTENT | Constant |
public static const POLICY_IGNORE_CONTENT:String = IgnoreContent
Describes the policy to use when resizing stripes: Stripe content is ignored when resizing.