com.yworks.yfiles.view.input

Class FocusGuardInputMode

java.lang.Object

com.yworks.yfiles.view.input.FocusGuardInputMode

All Implemented Interfaces:

IInputMode

public class FocusGuardInputMode
extends Object
implements IInputMode

An IInputMode that can be added to a MultiplexingInputMode to suppress other modes from doing unwanted things if the control has just become focused.

This mode requests the input mutex once the canvas gains focus. It returns the mutex after the mode has regained focus and the mouse has been clicked or 100 milliseconds have passed. This mode should be registered with the MultiplexingInputMode using the MultiplexingInputMode.add(IInputMode) method and a large priority number (e.g. 1000). So that other modes don't receive the input mutex once this one has released the mutex.

This mode is Exclusive by default.

Constructor Summary

Constructors

Constructor and Description
FocusGuardInputMode() Creates a new instance of this mode.

Method Summary

Modifier and Type	Method and Description
void	cancel() Called by the client to unconditionally cancel all editing.
protected ConcurrencyController	getController() Returns the installed Controller.
Cursor	getGuardCursor() Gets the Cursor that will be shown during active guards.
IInputModeContext	getInputModeContext() Returns the context instance this mode is currently installed in or null if this instance is not installed.
int	getPriority() The priority of this input mode.
void	install(IInputModeContext context, ConcurrencyController controller) Installs this mode into the given context that is provided by the canvas.
boolean	isEnabled() Gets the enabled state of this input mode.
protected void	onCanceled() Called after cancel() has been called.
protected void	onConcurrencyControllerActivated() Called after the Active property of the installed ConcurrencyController has been set to true.
protected void	onConcurrencyControllerDeactivated() Called after the Active property of the installed ConcurrencyController has been set to false.
protected void	onStopped() Called after stop() has been called.
void	setEnabled(boolean value) Sets the enabled state of this input mode.
void	setGuardCursor(Cursor value) Sets the Cursor that will be shown during active guards.
void	setPriority(int value) The priority of this input mode.
boolean	stop() Called by the client in order to stop a current editing progress.
void	uninstall(IInputModeContext context) Uninstalls this mode from the given context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FocusGuardInputMode

public FocusGuardInputMode()

Creates a new instance of this mode.

Method Detail

cancel

public void cancel()

Description copied from interface: IInputMode

Called 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:

Specified by:

cancel in interface IInputMode

getController

protected final ConcurrencyController getController()

Returns the installed Controller.

Returns:

The Controller.

getGuardCursor

public final Cursor getGuardCursor()

Gets the Cursor that will be shown during active guards.

The default is Arrow

Returns:

The GuardCursor.

See Also:

setGuardCursor(Cursor)

getInputModeContext

public final IInputModeContext getInputModeContext()

Description copied from interface: IInputMode

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

Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the ParentInputMode should be used.

Specified by:

getInputModeContext in interface IInputMode

Returns:

The InputModeContext.

getPriority

public final int getPriority()

Description copied from interface: IInputMode

The priority of this input mode.

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Specified by:

getPriority in interface IInputMode

Returns:

The Priority.

install

public void install(IInputModeContext context,
                    ConcurrencyController controller)

Installs this mode into the given context that is provided by the canvas.

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation, first.

Specified by:

install in interface IInputMode

Parameters:

context - The context that this instance shall be installed into. The same instance will be passed to this instance during IInputMode.uninstall(IInputModeContext). A reference to the context may be kept and queried during the time the mode is installed.

controller - The Controller for this mode.

See Also:

IInputMode.uninstall(IInputModeContext)

isEnabled

public boolean isEnabled()

Gets the enabled state of this input mode.

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.

Returns:

The Enabled.

See Also:

setEnabled(boolean)

onCanceled

protected void onCanceled()

Called after cancel() has been called.

Can be overridden in subclasses to perform additional actions after the mode has been canceled.

This implementation does nothing.

onConcurrencyControllerActivated

protected void onConcurrencyControllerActivated()

Called after the Active property of the installed ConcurrencyController has been set to true.

Can be overridden in subclasses to perform additional actions after the mode has been activated.

Overriding implementations should call the base implementation.

onConcurrencyControllerDeactivated

protected void onConcurrencyControllerDeactivated()

Called after the Active property of the installed ConcurrencyController has been set to false.

Can be overridden in subclasses to perform additional actions after the mode has been deactivated.

Overriding implementations should call the base implementation.

onStopped

protected void onStopped()

Called after stop() has been called.

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

setEnabled

public void setEnabled(boolean value)

Sets the enabled state of this input mode.

Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.

Parameters:

value - The Enabled to set.

See Also:

isEnabled()

setGuardCursor

public final void setGuardCursor(Cursor value)

Sets the Cursor that will be shown during active guards.

The default is Arrow

Parameters:

value - The GuardCursor to set.

See Also:

getGuardCursor()

setPriority

public final void setPriority(int value)

The priority of this input mode.

The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.

Parameters:

value - The Priority to set.

See Also:

getPriority()

stop

public boolean stop()

Description copied from interface: IInputMode

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

Specified by:

stop in interface IInputMode

Returns:

true if and only if the editing has been stopped or there was no edit in progress

See Also:

IInputMode.cancel()

uninstall

public void uninstall(IInputModeContext context)

Uninstalls this mode from the given context.

This code should clean up all changes made to the canvas in the IInputMode.install(IInputModeContext, ConcurrencyController) method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

Specified by:

uninstall in interface IInputMode

Parameters:

context - The context to deregister from. This is the same instance that had been passed to IInputMode.install(IInputModeContext, ConcurrencyController) during installation.