WaitInputMode (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.input.WaitInputMode

All Implemented Interfaces:

IInputMode
```
public class WaitInputMode
extends Object
implements IInputMode
```
An IInputMode implementation that can be used to block user interaction.
Setting the Waiting property will try to cancel ongoing edits of the mutex owner and set the Editable state to false and set the preferred cursor to WaitCursor. This mode will try to add itself to the Lookup of the CanvasControl, so that other clients can make use of its functionality.

This mode uses an Exclusive controller by default.

See Also:

isWaiting()

Constructor Summary

Constructors
Constructor and Description

WaitInputMode()
Creates a new instance of this mode.

Constructors
Constructor and Description
`WaitInputMode()` Creates a new instance of this mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addWaitingEndedListener(IEventHandler<InputModeEventArgs> waitingEndedEvent)` Adds the given listener for the `WaitingEnded` event that occurs when the waiting ended.
`void`	`addWaitingStartedListener(IEventHandler<InputModeEventArgs> waitingStartedEvent)` Adds the given listener for the `WaitingStarted` event that occurs when the waiting started.
`void`	`cancel()` Called by the client to unconditionally cancel all editing.
`boolean`	`canStartWaiting()` Returns if this mode can request the mutex when `Waiting` is set to `true`.
`protected void`	`endWaiting()` Called when waiting is finished.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`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.
`Cursor`	`getWaitCursor()` Gets the WaitCursor property.
`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.
`boolean`	`isWaiting()` Gets the Waiting property.
`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.
`protected void`	`onWaitingEnded(InputModeEventArgs inputModeEventArgs)` Raises the `WaitingEnded` event.
`protected void`	`onWaitingStarted(InputModeEventArgs inputModeEventArgs)` Raises the `WaitingStarted` event.
`void`	`removeWaitingEndedListener(IEventHandler<InputModeEventArgs> waitingEndedEvent)` Removes the given listener for the `WaitingEnded` event that occurs when the waiting ended.
`void`	`removeWaitingStartedListener(IEventHandler<InputModeEventArgs> waitingStartedEvent)` Removes the given listener for the `WaitingStarted` event that occurs when the waiting started.
`void`	`setEnabled(boolean value)` Sets the enabled state of this input mode.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setWaitCursor(Cursor value)` Sets the WaitCursor property.
`void`	`setWaiting(boolean value)` Sets the Waiting property.
`protected void`	`startWaiting()` This will initiate the waiting process by trying to `ConcurrencyController.requestMutex()`request the input mutex.
`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
  - WaitInputMode
```
public WaitInputMode()
```
    Creates a new instance of this mode.
- Method Detail
  - addWaitingEndedListener
```
public final void addWaitingEndedListener(IEventHandler<InputModeEventArgs> waitingEndedEvent)
```
    Adds the given listener for the WaitingEnded event that occurs when the waiting ended.
    
    Parameters:
    
    waitingEndedEvent - The listener to add.
    
    See Also:
    
    removeWaitingEndedListener(IEventHandler)
  - addWaitingStartedListener
```
public final void addWaitingStartedListener(IEventHandler<InputModeEventArgs> waitingStartedEvent)
```
    Adds the given listener for the WaitingStarted event that occurs when the waiting started.
    
    Parameters:
    
    waitingStartedEvent - The listener to add.
    
    See Also:
    
    removeWaitingStartedListener(IEventHandler)
  - 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
  - canStartWaiting
```
public boolean canStartWaiting()
```
    Returns if this mode can request the mutex when Waiting is set to true.
    
    Returns:
    
    if this mode can request the mutex when Waiting is set to true.
  - endWaiting
```
protected void endWaiting()
```
    Called when waiting is finished.
    This will reset the PreferredCursor and the mutex is released.
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - 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.
  - getWaitCursor
```
public final Cursor getWaitCursor()
```
    Gets the WaitCursor property.
    
    Returns:
    
    The WaitCursor.
    
    See Also:
    
    setWaitCursor(Cursor)
  - 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)
  - isWaiting
```
public final boolean isWaiting()
```
    Gets the Waiting property.
    Setting this property to true will start the waiting process. Setting it to false will end the waiting.
    
    Returns:
    
    The Waiting.
    
    See Also:
    
    setWaiting(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.
  - onWaitingEnded
```
protected void onWaitingEnded(InputModeEventArgs inputModeEventArgs)
```
    Raises the WaitingEnded event.
    
    Parameters:
    
    inputModeEventArgs - The InputModeEventArgs instance containing the event data.
  - onWaitingStarted
```
protected void onWaitingStarted(InputModeEventArgs inputModeEventArgs)
```
    Raises the WaitingStarted event.
    
    Parameters:
    
    inputModeEventArgs - The InputModeEventArgs instance containing the event data.
  - removeWaitingEndedListener
```
public final void removeWaitingEndedListener(IEventHandler<InputModeEventArgs> waitingEndedEvent)
```
    Removes the given listener for the WaitingEnded event that occurs when the waiting ended.
    
    Parameters:
    
    waitingEndedEvent - The listener to remove.
    
    See Also:
    
    addWaitingEndedListener(IEventHandler)
  - removeWaitingStartedListener
```
public final void removeWaitingStartedListener(IEventHandler<InputModeEventArgs> waitingStartedEvent)
```
    Removes the given listener for the WaitingStarted event that occurs when the waiting started.
    
    Parameters:
    
    waitingStartedEvent - The listener to remove.
    
    See Also:
    
    addWaitingStartedListener(IEventHandler)
  - 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()
  - 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()
  - setWaitCursor
```
public final void setWaitCursor(Cursor value)
```
    Sets the WaitCursor property.
    
    Parameters:
    
    value - The WaitCursor to set.
    
    See Also:
    
    getWaitCursor()
  - setWaiting
```
public final void setWaiting(boolean value)
```
    Sets the Waiting property.
    Setting this property to true will start the waiting process. Setting it to false will end the waiting.
    
    Parameters:
    
    value - The Waiting to set.
    
    See Also:
    
    isWaiting()
  - startWaiting
```
protected void startWaiting()
```
    This will initiate the waiting process by trying to ConcurrencyController.requestMutex()request the input mutex.
    This will set the PreferredCursor to WaitCursor and set the Editable property of the canvas to false.
  - 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.

Class WaitInputMode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WaitInputMode

Method Detail

addWaitingEndedListener

addWaitingStartedListener

cancel

canStartWaiting

endWaiting

getController

getInputModeContext

getPriority

getWaitCursor

install

isEnabled

isWaiting

onCanceled

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onStopped

onWaitingEnded

onWaitingStarted

removeWaitingEndedListener

removeWaitingStartedListener

setEnabled

setPriority

setWaitCursor

setWaiting

startWaiting

stop

uninstall