| Package | com.yworks.canvas.input |
| Class | public class OverviewInputMode |
| Inheritance | OverviewInputMode  AbstractInputMode flash.events.EventDispatcher |
IInputMode that can be used for an overview
CanvasComponent.
This mode will add navigation capabilities to the control it is installed in.
See also
| Property | Defined By | ||
|---|---|---|---|
| autoInvalidate : Boolean
Determines whether the the canvas this mode is installed in should automatically be
invalidated if the client canvas gets invalidated. | OverviewInputMode | ||
 | canvas : CanvasComponent [read-only]
The canvas instance this mode is currently installed in or null
| AbstractInputMode | |
| clientCanvas : CanvasComponent
The canvas this canvas should use to navigate
| OverviewInputMode | ||
| 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 | |
| updateTimerDelay : Number
Gets or sets the invalidation delay in milliseconds
for the timer that triggers an update of the canvas. | OverviewInputMode | ||
| viewPortPaintable : ShapePaintable
The display object creator for the display object used to indicate the viewPort of the overview. | OverviewInputMode | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance. | OverviewInputMode | ||
cancel():void [override]
Called by the client to unconditionally cancel all editing. | OverviewInputMode | ||
| dispose():void
Disposes this input mode. | AbstractInputMode | |
| install(context:IInputModeContext):void
Installs this mode into the canvas of the given context. | AbstractInputMode | |
stop():Boolean [override]
Called by the client in order to stop a current editing progress. | OverviewInputMode | ||
| uninstall(context:IInputModeContext):void
Uninstalls this mode from the canvas. | AbstractInputMode | |
validateNow():void
Updates the viewport and content rect if necessary and triggers a repaint. | OverviewInputMode | ||
| Method | Defined By | ||
|---|---|---|---|
| fireInstalled():void | AbstractInputMode | |
| fireInstalling():void | AbstractInputMode | |
| fireUninstalled():void | AbstractInputMode | |
| fireUninstalling():void | AbstractInputMode | |
| initialize():void
Performs one-time initialization of this instance. | AbstractInputMode | |
installCore(context:IInputModeContext):void [override]
Installs this mode into the given canvas. | OverviewInputMode | ||
| invalidate():void
Convenience method for subclass implementations that invalidates
the canvasComponent this mode is currently installed in. | AbstractInputMode | |
uninstallCore(context:IInputModeContext):void [override]
Uninstalls this mode from the given canvas. | OverviewInputMode | ||
| autoInvalidate | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesautoInvalidate:BooleanDetermines whether the the canvas this mode is installed in should automatically be invalidated if the client canvas gets invalidated.
Automatic invalidation will be deferred shortly.
public function get autoInvalidate():Boolean public function set autoInvalidate(value:Boolean):void| clientCanvas | property |
clientCanvas:CanvasComponentThe canvas this canvas should use to navigate
public function get clientCanvas():CanvasComponent public function set clientCanvas(value:CanvasComponent):void| updateTimerDelay | property |
updateTimerDelay:NumberGets or sets the invalidation delay in milliseconds for the timer that triggers an update of the canvas.
The default value is 300.
public function get updateTimerDelay():Number public function set updateTimerDelay(value:Number):void| viewPortPaintable | property |
viewPortPaintable:ShapePaintableThe display object creator for the display object used to indicate the viewPort of the overview.
public function get viewPortPaintable():ShapePaintable public function set viewPortPaintable(value:ShapePaintable):void| OverviewInputMode | () | Constructor |
public function OverviewInputMode()Creates a new instance.
| cancel | () | method |
override public function cancel():voidCalled by the client to unconditionally cancel all editing. This will be called prior to the uninstalling of this instance. In order to stop an active input mode manually, client code should use the following idiom:
if ( !mode.stop() ){
mode.cancel();
}
| installCore | () | method |
override protected function installCore(context:IInputModeContext):voidInstalls this mode into the given canvas.
Installation usually means registering some event listeners
on the canvasComponent or on canvasComponent.root.
Parameters
context:IInputModeContext — The context of the graph canvas that this instance shall be
installed into (i.e. the overview canvas).
|
| stop | () | method |
override public function stop():Boolean
Called by the client in order to stop a current editing progress.
This should stop the current edit, if one is in progress and possibly commit
all of the changes.
If stopping is not possible, this method can return false
Boolean — true if and only if the editing has been stopped or there was
no edit in progress
|
| uninstallCore | () | method |
override protected function uninstallCore(context:IInputModeContext):void
Uninstalls this mode from the given canvas.
This code should clean up all changes made to the canvas in the install
method. After a mode has been uninstalled it can be installed again into the same or
another canvas.
Parameters
context:IInputModeContext — The context to remove this mode from. This is the same instance that
has been passed to install( IInputModeContext ).
|
| validateNow | () | method |
public function validateNow():voidUpdates the viewport and content rect if necessary and triggers a repaint.