The canvas instance this mode is currently installed in or null

The context instance this mode is currently installed in or null if this instance is not installed.

Whether this mode is currently installed, i.e if a call to the canvas property will yield a non-null result.

Cancels the editing of this mode. This implementation does nothing. Classes that need to perform clean-up should override this method and invoke super.cancel as the last statement.

Disposes this input mode.

Subclasses should remove all listeners that they have registered.

Performs one-time initialization of this instance. This method should not be invoked by subclasses. This will be done automatically upon first installment of this mode.

This code will be executed only once. The canvas property will yield null when this code is executed. This method not should be used to install this mode into a specific canvas. Subclasses should always call super.initialize() first.

Installs this mode into the canvas of the given context.

This method is final. Subclasses should override the method installCore() instead.

This method fires an INSTALLING event, calls installCore(), then fires INSTALLED

Parameters

The implementation of the install() method: installs this mode into the canvas of the given context.

Subclasses should override this method and call super.installCore(context), first. One-time initialization should be performed in the initialize method. The install method will call the initialize method the first time this mode gets installed.

Parameters

Convenience method for subclass implementations that invalidates the canvasComponent this mode is currently installed in.

Tries to stop the editing. This implementation always return true. Subclasses that want to prevent a stop or need to do special clean up should do this here if super.stop() returns true.

A typical implementation should follow this idiom if it wants to stop:

         if( super.stop() ) {
           //do cleanup
           return true;
         } else {
           return false;
         }
         

Uninstalls this mode from the canvas.

This method is final. Subclasses should override uninstallCore instead.

This method fires an UNINSTALLING event, calls uninstallCore(), then fires UNINSTALLED

Parameters

Implementation of uninstall: Uninstalls this mode from the canvas.

Subclasses should always call super.uninstallCore( context ) as the last statement.

Parameters

Dispatched after the input mode was installed.

Dispatched before the input mode will be installed.

Event handlers for this event can be used to configure the input mode before it is installed.

Dispatched after the input mode was uninstalled.

Dispatched before the input mode will be uninstalled.