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

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

All Implemented Interfaces:

IInputMode
```
public class ClickInputMode
extends Object
implements IInputMode
```
An input mode that recognizes simple mouse clicks.
Clients register to Clicked to get notified of mouse clicks. The ActiveButtons property can be used to switch between the detection of right and left mouse clicks.
This mode can be instructed to swallow clicks if they lead happen shortly after the control gained focus. This is useful to prevent accidental clicks from being processed if the user wanted to put the focus into the control, only.

This mode is Exclusive by default.

See Also:

getDoubleClickPolicy(), isFocusClickSwallowingEnabled(), getActiveButtons()

Constructor Summary

Constructors
Constructor and Description

ClickInputMode()
Creates a new instance of this mode that detects left mouse clicks.

Constructors
Constructor and Description
`ClickInputMode()` Creates a new instance of this mode that detects left mouse clicks.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addClickedListener(IEventHandler<ClickEventArgs> clickedEvent)` Adds the given listener for the `Clicked` event that occurs once a click has been detected.
`void`	`addDoubleClickedListener(IEventHandler<ClickEventArgs> doubleClickedEvent)` Adds the given listener for the `DoubleClicked` event that occurs once a double-click has been detected.
`void`	`addLeftClickedListener(IEventHandler<ClickEventArgs> leftClickedEvent)` Adds the given listener for the `LeftClicked` event that occurs once a left click has been detected.
`void`	`addLeftDoubleClickedListener(IEventHandler<ClickEventArgs> leftDoubleClickedEvent)` Adds the given listener for the `LeftDoubleClicked` event that occurs once a left double-click has been detected.
`void`	`addRightClickedListener(IEventHandler<ClickEventArgs> rightClickedEvent)` Adds the given listener for the `RightClicked` event that occurs once a right click has been detected.
`void`	`addRightDoubleClickedListener(IEventHandler<ClickEventArgs> rightDoubleClickedEvent)` Adds the given listener for the `RightDoubleClicked` event that occurs once a right double-click has been detected.
`void`	`cancel()` Cancels the editing of this mode.
`protected IEventRecognizer`	`createClickRecognizer()` Creates the event recognizer that is used to recognize the clicks for this instance.
`protected IEventRecognizer`	`createPressRecognizer()` Creates the event recognizer that is used to recognize the press event for this instance.
`protected IEventRecognizer`	`createReleaseRecognizer()` Creates the event recognizer that is used to recognize the release event for this instance.
`MouseButtons`	`getActiveButtons()` Determines for which button(s) mouse clicks should be processed.
`PointD`	`getClickLocation()` Gets the location of the last click.
`protected ConcurrencyController`	`getController()` Gets the installed `Controller`.
`DoubleClickPolicy`	`getDoubleClickPolicy()` Gets the click handling mode that determines the triggering behavior of `Clicked` and `DoubleClicked`.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`ModifierKeys`	`getModifiers()` Returns the state of the modifier keys at the time of the end of the gesture.
`int`	`getPriority()` The priority of this input mode.
`Cursor`	`getValidClickHitCursor()` Gets the cursor to use when hovering over a valid hit region.
`IHitTestable`	`getValidClickHitTestable()` Gets a hit test that determines where this mode should recognize clicks.
`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`	`isExclusive()` Gets a value indicating whether this mode will be the only one running when it has the mutex.
`boolean`	`isFocusClickSwallowingEnabled()` Gets a property that determines whether clicks should be swallowed if they happen within a short amount of time after the CanvasControl got focus.
`protected boolean`	`isInvalidPress(Object eventSource, IEventArgs eventArg)` Determines whether the given event is a press event that occurred at an invalid location.
`boolean`	`isLeftClick()` Deprecated.
`protected boolean`	`isValidClick(Object src, IEventArgs arg)` Determines whether the given event is a valid click event.
`protected boolean`	`isValidPress(Object eventSource, IEventArgs eventArg)` Determines whether the given event is a valid press event.
`protected boolean`	`isValidRelease(Object src, IEventArgs arg)` Determines whether the given event is a valid release event.
`protected void`	`onCanceled()` Called after `cancel()` has been called.
`protected void`	`onClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a click gesture.
`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`	`onDoubleClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a double-click gesture.
`protected void`	`onLeftClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a left click gesture.
`protected void`	`onLeftDoubleClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a left double-click gesture.
`protected void`	`onRightClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a right click gesture.
`protected void`	`onRightDoubleClicked(ClickEventArgs eventArgs)` Called once this mode has recognized a double-click gesture.
`protected void`	`onStopped()` Called after `stop()` has been called.
`void`	`preventNextDoubleClick()` Prevents a double-click event from being issued if the next click would do so and sends only a single click instead.
`protected boolean`	`queryAndResetPreventNextDoubleClick()` Returns and resets the flag set by `preventNextDoubleClick()`.
`void`	`removeClickedListener(IEventHandler<ClickEventArgs> clickedEvent)` Removes the given listener for the `Clicked` event that occurs once a click has been detected.
`void`	`removeDoubleClickedListener(IEventHandler<ClickEventArgs> doubleClickedEvent)` Removes the given listener for the `DoubleClicked` event that occurs once a double-click has been detected.
`void`	`removeLeftClickedListener(IEventHandler<ClickEventArgs> leftClickedEvent)` Removes the given listener for the `LeftClicked` event that occurs once a left click has been detected.
`void`	`removeLeftDoubleClickedListener(IEventHandler<ClickEventArgs> leftDoubleClickedEvent)` Removes the given listener for the `LeftDoubleClicked` event that occurs once a left double-click has been detected.
`void`	`removeRightClickedListener(IEventHandler<ClickEventArgs> rightClickedEvent)` Removes the given listener for the `RightClicked` event that occurs once a right click has been detected.
`void`	`removeRightDoubleClickedListener(IEventHandler<ClickEventArgs> rightDoubleClickedEvent)` Removes the given listener for the `RightDoubleClicked` event that occurs once a right double-click has been detected.
`void`	`setActiveButtons(MouseButtons value)` Determines for which button(s) mouse clicks should be processed.
`void`	`setDoubleClickPolicy(DoubleClickPolicy value)` Sets the click handling mode that determines the triggering behavior of `Clicked` and `DoubleClicked`.
`void`	`setEnabled(boolean value)` Sets the enabled state of this input mode.
`void`	`setExclusive(boolean value)` Sets a value indicating whether this mode will be the only one running when it has the mutex.
`void`	`setFocusClickSwallowingEnabled(boolean value)` Sets a property that determines whether clicks should be swallowed if they happen within a short amount of time after the CanvasControl got focus.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setRequestingMutexOnClickEnabled(boolean value)` Whether to `request the mutex` on a click.
`void`	`setValidClickHitCursor(Cursor value)` Sets the cursor to use when hovering over a valid hit region.
`void`	`setValidClickHitTestable(IHitTestable value)` Sets a hit test that determines where this mode should recognize clicks.
`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
  - ClickInputMode
```
public ClickInputMode()
```
    Creates a new instance of this mode that detects left mouse clicks.
- Method Detail
  - addClickedListener
```
public final void addClickedListener(IEventHandler<ClickEventArgs> clickedEvent)
```
    Adds the given listener for the Clicked event that occurs once a click has been detected.
    
    Parameters:
    
    clickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeClickedListener(IEventHandler)
  - addDoubleClickedListener
```
public final void addDoubleClickedListener(IEventHandler<ClickEventArgs> doubleClickedEvent)
```
    Adds the given listener for the DoubleClicked event that occurs once a double-click has been detected.
    
    Parameters:
    
    doubleClickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeDoubleClickedListener(IEventHandler)
  - addLeftClickedListener
```
public final void addLeftClickedListener(IEventHandler<ClickEventArgs> leftClickedEvent)
```
    Adds the given listener for the LeftClicked event that occurs once a left click has been detected.
    
    Parameters:
    
    leftClickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeLeftClickedListener(IEventHandler)
  - addLeftDoubleClickedListener
```
public final void addLeftDoubleClickedListener(IEventHandler<ClickEventArgs> leftDoubleClickedEvent)
```
    Adds the given listener for the LeftDoubleClicked event that occurs once a left double-click has been detected.
    
    Parameters:
    
    leftDoubleClickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeLeftDoubleClickedListener(IEventHandler)
  - addRightClickedListener
```
public final void addRightClickedListener(IEventHandler<ClickEventArgs> rightClickedEvent)
```
    Adds the given listener for the RightClicked event that occurs once a right click has been detected.
    
    Parameters:
    
    rightClickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeRightClickedListener(IEventHandler)
  - addRightDoubleClickedListener
```
public final void addRightDoubleClickedListener(IEventHandler<ClickEventArgs> rightDoubleClickedEvent)
```
    Adds the given listener for the RightDoubleClicked event that occurs once a right double-click has been detected.
    
    Parameters:
    
    rightDoubleClickedEvent - The listener to add.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), removeRightDoubleClickedListener(IEventHandler)
  - cancel
```
public void cancel()
```
    Cancels the editing of this mode.
    This implementation releases the mutex if it is currently owned by this instance and calls onCanceled().
    
    Specified by:
    
    cancel in interface IInputMode
    
    See Also:
    
    onCanceled()
  - createClickRecognizer
```
protected IEventRecognizer createClickRecognizer()
```
    Creates the event recognizer that is used to recognize the clicks for this instance.
  - createPressRecognizer
```
protected IEventRecognizer createPressRecognizer()
```
    Creates the event recognizer that is used to recognize the press event for this instance.
  - createReleaseRecognizer
```
protected IEventRecognizer createReleaseRecognizer()
```
    Creates the event recognizer that is used to recognize the release event for this instance.
  - getActiveButtons
```
public final MouseButtons getActiveButtons()
```
    Determines for which button(s) mouse clicks should be processed.
    Default value is MouseButtons.LEFT
    
    Returns:
    
    The ActiveButtons.
    
    See Also:
    
    createClickRecognizer(), setActiveButtons(MouseButtons)
  - getClickLocation
```
public final PointD getClickLocation()
```
    Gets the location of the last click.
    
    Returns:
    
    The ClickLocation.
  - getController
```
protected final ConcurrencyController getController()
```
    Gets the installed Controller.
    
    Returns:
    
    The Controller.
    
    See Also:
    
    IInputMode.install(IInputModeContext, ConcurrencyController)
  - getDoubleClickPolicy
```
public final DoubleClickPolicy getDoubleClickPolicy()
```
    Gets the click handling mode that determines the triggering behavior of Clicked and DoubleClicked.
    
    Returns:
    
    The click handling mode to use for this instance. The default is DoubleClickPolicy.BOTH_SINGLE_CLICKS_AND_DOUBLE_CLICK
    
    See Also:
    
    getDoubleClickPolicy(), setDoubleClickPolicy(DoubleClickPolicy)
  - 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.
  - getModifiers
```
public final ModifierKeys getModifiers()
```
    Returns the state of the modifier keys at the time of the end of the gesture.
    
    Returns:
    
    The Modifiers.
  - 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.
  - getValidClickHitCursor
```
public final Cursor getValidClickHitCursor()
```
    Gets the cursor to use when hovering over a valid hit region.
    The default is null and the current cursor is used instead.
    
    Returns:
    
    The ValidClickHitCursor.
    
    See Also:
    
    setValidClickHitCursor(Cursor)
  - getValidClickHitTestable
```
public final IHitTestable getValidClickHitTestable()
```
    Gets a hit test that determines where this mode should recognize clicks.
    This implementation is tested during the isValidPress(Object, IEventArgs) to determine whether it is valid to click here. The default implementation is IHitTestable.ALWAYS.
    
    Returns:
    
    The ValidClickHitTestable.
    
    See Also:
    
    setValidClickHitTestable(IHitTestable)
  - 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)
  - isExclusive
```
public final boolean isExclusive()
```
    Gets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Returns:
    
    The Exclusive.
    
    See Also:
    
    setExclusive(boolean)
  - isFocusClickSwallowingEnabled
```
public final boolean isFocusClickSwallowingEnabled()
```
    Gets a property that determines whether clicks should be swallowed if they happen within a short amount of time after the CanvasControl got focus.
    The default is false. If set to true clicks are discarded within 100 ms after the focus entered.
    
    Returns:
    
    The FocusClickSwallowingEnabled.
    
    See Also:
    
    setFocusClickSwallowingEnabled(boolean)
  - isInvalidPress
```
protected boolean isInvalidPress(Object eventSource,
                                 IEventArgs eventArg)
```
    Determines whether the given event is a press event that occurred at an invalid location.
    
    See Also:
    
    getValidClickHitTestable()
  - isLeftClick
```
@Deprecated
public final boolean isLeftClick()
```
    Deprecated.
    
    Whether to request the mutex on a click.
    If set to true this will detect only left mouse clicks, otherwise, only right clicks are detected.
    
    Returns:
    
    The LeftClick.
    
    See Also:
    
    createClickRecognizer(), #setLeftClick(boolean)
  - isValidClick
```
protected boolean isValidClick(Object src,
                               IEventArgs arg)
```
    Determines whether the given event is a valid click event.
    
    See Also:
    
    getValidClickHitTestable()
  - isValidPress
```
protected boolean isValidPress(Object eventSource,
                               IEventArgs eventArg)
```
    Determines whether the given event is a valid press event.
  - isValidRelease
```
protected boolean isValidRelease(Object src,
                                 IEventArgs arg)
```
    Determines whether the given event is a valid release event.
    
    See Also:
    
    getValidClickHitTestable()
  - 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.
  - onClicked
```
protected void onClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a click gesture.
    This method will trigger the Clicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - 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.
  - onDoubleClicked
```
protected void onDoubleClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a double-click gesture.
    This method will trigger the DoubleClicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - onLeftClicked
```
protected void onLeftClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a left click gesture.
    This method will trigger the LeftClicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - onLeftDoubleClicked
```
protected void onLeftDoubleClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a left double-click gesture.
    This method will trigger the LeftDoubleClicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - onRightClicked
```
protected void onRightClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a right click gesture.
    This method will trigger the RightClicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - onRightDoubleClicked
```
protected void onRightDoubleClicked(ClickEventArgs eventArgs)
```
    Called once this mode has recognized a double-click gesture.
    This method will trigger the RightDoubleClicked event.
    
    Parameters:
    
    eventArgs - The arguments.
  - 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.
  - preventNextDoubleClick
```
public final void preventNextDoubleClick()
```
    Prevents a double-click event from being issued if the next click would do so and sends only a single click instead.
    The intention is for "breaking" a double click if an input mode using ClickInputMode performs actions that would lead to surprising behavior if the next click would lead to a double-click. Examples of this are GraphEditorInputMode's selection cycling where several clicks in short succession may occur, as well as creating a node by clicking on the canvas and selecting it immediately afterwards with another click.
    
    This method's effect is very short-lived. It really only prevents a double-click event for the very next click that this input mode handles. The internal flag set by this method is re-set on every click received. This also means that if you call this method and the next click is just a regular single-click the flag is cleared nonetheless.
  - queryAndResetPreventNextDoubleClick
```
protected boolean queryAndResetPreventNextDoubleClick()
```
    Returns and resets the flag set by preventNextDoubleClick().
    To ensure that the flag really acts just once, this method resets the flag and returns its value prior to the reset.
  - removeClickedListener
```
public final void removeClickedListener(IEventHandler<ClickEventArgs> clickedEvent)
```
    Removes the given listener for the Clicked event that occurs once a click has been detected.
    
    Parameters:
    
    clickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addClickedListener(IEventHandler)
  - removeDoubleClickedListener
```
public final void removeDoubleClickedListener(IEventHandler<ClickEventArgs> doubleClickedEvent)
```
    Removes the given listener for the DoubleClicked event that occurs once a double-click has been detected.
    
    Parameters:
    
    doubleClickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addDoubleClickedListener(IEventHandler)
  - removeLeftClickedListener
```
public final void removeLeftClickedListener(IEventHandler<ClickEventArgs> leftClickedEvent)
```
    Removes the given listener for the LeftClicked event that occurs once a left click has been detected.
    
    Parameters:
    
    leftClickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addLeftClickedListener(IEventHandler)
  - removeLeftDoubleClickedListener
```
public final void removeLeftDoubleClickedListener(IEventHandler<ClickEventArgs> leftDoubleClickedEvent)
```
    Removes the given listener for the LeftDoubleClicked event that occurs once a left double-click has been detected.
    
    Parameters:
    
    leftDoubleClickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addLeftDoubleClickedListener(IEventHandler)
  - removeRightClickedListener
```
public final void removeRightClickedListener(IEventHandler<ClickEventArgs> rightClickedEvent)
```
    Removes the given listener for the RightClicked event that occurs once a right click has been detected.
    
    Parameters:
    
    rightClickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addRightClickedListener(IEventHandler)
  - removeRightDoubleClickedListener
```
public final void removeRightDoubleClickedListener(IEventHandler<ClickEventArgs> rightDoubleClickedEvent)
```
    Removes the given listener for the RightDoubleClicked event that occurs once a right double-click has been detected.
    
    Parameters:
    
    rightDoubleClickedEvent - The listener to remove.
    
    See Also:
    
    ClickEventArgs, getDoubleClickPolicy(), addRightDoubleClickedListener(IEventHandler)
  - setActiveButtons
```
public final void setActiveButtons(MouseButtons value)
```
    Determines for which button(s) mouse clicks should be processed.
    Default value is MouseButtons.LEFT
    
    Parameters:
    
    value - The ActiveButtons to set.
    
    See Also:
    
    createClickRecognizer(), getActiveButtons()
  - setDoubleClickPolicy
```
public final void setDoubleClickPolicy(DoubleClickPolicy value)
```
    Sets the click handling mode that determines the triggering behavior of Clicked and DoubleClicked.
    
    Parameters:
    
    value - The click handling mode to use for this instance. The default is DoubleClickPolicy.BOTH_SINGLE_CLICKS_AND_DOUBLE_CLICK
    
    See Also:
    
    getDoubleClickPolicy(), getDoubleClickPolicy()
  - 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()
  - setExclusive
```
public final void setExclusive(boolean value)
```
    Sets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Parameters:
    
    value - The Exclusive to set.
    
    See Also:
    
    isExclusive()
  - setFocusClickSwallowingEnabled
```
public final void setFocusClickSwallowingEnabled(boolean value)
```
    Sets a property that determines whether clicks should be swallowed if they happen within a short amount of time after the CanvasControl got focus.
    The default is false. If set to true clicks are discarded within 100 ms after the focus entered.
    
    Parameters:
    
    value - The FocusClickSwallowingEnabled to set.
    
    See Also:
    
    isFocusClickSwallowingEnabled()
  - 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()
  - setRequestingMutexOnClickEnabled
```
public final void setRequestingMutexOnClickEnabled(boolean value)
```
    Whether to request the mutex on a click.
    If set to true this will detect only left mouse clicks, otherwise, only right clicks are detected.
    
    Parameters:
    
    value - The LeftClick to set.
    
    See Also:
    
    createClickRecognizer(), isLeftClick()
  - setValidClickHitCursor
```
public final void setValidClickHitCursor(Cursor value)
```
    Sets the cursor to use when hovering over a valid hit region.
    The default is null and the current cursor is used instead.
    
    Parameters:
    
    value - The ValidClickHitCursor to set.
    
    See Also:
    
    getValidClickHitCursor()
  - setValidClickHitTestable
```
public final void setValidClickHitTestable(IHitTestable value)
```
    Sets a hit test that determines where this mode should recognize clicks.
    This implementation is tested during the isValidPress(Object, IEventArgs) to determine whether it is valid to click here. The default implementation is IHitTestable.ALWAYS.
    
    Parameters:
    
    value - The ValidClickHitTestable to set.
    
    See Also:
    
    getValidClickHitTestable()
  - 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 ClickInputMode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClickInputMode

Method Detail

addClickedListener

addDoubleClickedListener

addLeftClickedListener

addLeftDoubleClickedListener

addRightClickedListener

addRightDoubleClickedListener

cancel

createClickRecognizer

createPressRecognizer

createReleaseRecognizer

getActiveButtons

getClickLocation

getController

getDoubleClickPolicy

getInputModeContext

getModifiers

getPriority

getValidClickHitCursor

getValidClickHitTestable

install

isEnabled

isExclusive

isFocusClickSwallowingEnabled

isInvalidPress

isLeftClick

isValidClick

isValidPress

isValidRelease

onCanceled

onClicked

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onDoubleClicked

onLeftClicked

onLeftDoubleClicked

onRightClicked

onRightDoubleClicked

onStopped

preventNextDoubleClick

queryAndResetPreventNextDoubleClick

removeClickedListener

removeDoubleClickedListener

removeLeftClickedListener

removeLeftDoubleClickedListener

removeRightClickedListener

removeRightDoubleClickedListener

setActiveButtons

setDoubleClickPolicy

setEnabled

setExclusive

setFocusClickSwallowingEnabled

setPriority

setRequestingMutexOnClickEnabled

setValidClickHitCursor

setValidClickHitTestable

stop

uninstall