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

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

All Implemented Interfaces:

IInputMode
```
public class MarqueeSelectionInputMode
extends Object
implements IInputMode
```
An IInputMode implementation that can handle marquee selections performed by the user with a mouse.
This implementation will request the mutex as soon as it recognizes a mouse drag.

This mode is Exclusive by default.

Field Summary

Fields
Modifier and Type	Field and Description
`static ResourceKey`	`MARQUEE_RECTANGLE_TEMPLATE_KEY` A `ResourceKey` that can be used to store a `IVisualTemplate` that can be used to create the visual that will be used to draw the marquee box.

Constructor Summary

Constructors
Constructor and Description

MarqueeSelectionInputMode()
Creates a new instance of the marquee selection mode.

Constructors
Constructor and Description
`MarqueeSelectionInputMode()` Creates a new instance of the marquee selection mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDragCanceledListener(IEventHandler<MarqueeSelectionEventArgs> dragCanceledEvent)` Adds the given listener for the `DragCanceled` event that occurs when the drag has been canceled.
`void`	`addDragCancelingListener(IEventHandler<MarqueeSelectionEventArgs> dragCancelingEvent)` Adds the given listener for the `DragCanceling` event that occurs before the drag will be canceled.
`void`	`addDragFinishedListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishedEvent)` Adds the given listener for the `DragFinished` event that occurs the drag has been finished.
`void`	`addDragFinishingListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishingEvent)` Adds the given listener for the `DragFinishing` event that occurs before the drag will be finished.
`void`	`addDraggedListener(IEventHandler<MarqueeSelectionEventArgs> draggedEvent)` Adds the given listener for the `Dragged` event that occurs at the end of every drag.
`void`	`addDraggingListener(IEventHandler<MarqueeSelectionEventArgs> draggingEvent)` Adds the given listener for the `Dragging` event that occurs at the start of every drag.
`void`	`addDragStartedListener(IEventHandler<MarqueeSelectionEventArgs> dragStartedEvent)` Adds the given listener for the `DragStarted` event that occurs once the drag is initialized and has started.
`void`	`addDragStartingListener(IEventHandler<MarqueeSelectionEventArgs> dragStartingEvent)` Adds the given listener for the `DragStarting` event that occurs once the drag is starting.
`void`	`cancel()` Cancels any pending marquee selection.
`protected MarqueeSelectionEventArgs`	`createInputModeEventArgs()` Helper method that yields a suitably configured `InputModeEventArgs` for this input mode.
`IEventRecognizer`	`getCancelRecognizer()` Gets the "cancel" recognizer.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`IEventRecognizer`	`getDraggedRecognizer()` Gets the "dragged" recognizer.
`IEventRecognizer`	`getDraggedRecognizerTouch()` Gets the "dragged" recognizer for touch input.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`Cursor`	`getMarqueeCursor()` Gets the cursor to use during the dragging of the marquee.
`IEventRecognizer`	`getPressedRecognizer()` Gets the "pressed" state recognizer.
`IEventRecognizer`	`getPressedRecognizerTouch()` Gets the "pressed" state recognizer for touch input.
`int`	`getPriority()` The priority of this input mode.
`IEventRecognizer`	`getReleasedRecognizer()` Gets the "released" recognizer.
`IEventRecognizer`	`getReleasedRecognizerTouch()` Gets the "released" recognizer for touch input.
`RectD`	`getSelectionRectangle()` Gets the current or last marquee selection rectangle.
`IVisualTemplate`	`getTemplate()` Gets the template that is used for the visualization of the marquee rectangle.
`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.
`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`	`onDragCanceled(MarqueeSelectionEventArgs inputModeEventArgs)` Triggers the `DragCanceled` event.
`protected void`	`onDragCanceling(MarqueeSelectionEventArgs inputModeEventArgs)` Triggers the `DragCanceling` event.
`protected void`	`onDragFinished(MarqueeSelectionEventArgs inputModeEventArgs)` Callback triggered once the drag has been finalized.
`protected void`	`onDragFinishing(MarqueeSelectionEventArgs inputModeEventArgs)` Callback triggered before the drag will be finalized.
`protected void`	`onDragged(MarqueeSelectionEventArgs inputModeEventArgs)` Callback triggered at the end of each drag.
`protected void`	`onDragging(MarqueeSelectionEventArgs inputModeEventArgs)` Callback triggered at the start of each drag.
`protected void`	`onDragStarted(MarqueeSelectionEventArgs inputModeEventArgs)` Triggers the `DragStarted` event.
`protected void`	`onDragStarting(MarqueeSelectionEventArgs inputModeEventArgs)` Triggers the `DragStarting` event.
`protected void`	`onStopped()` Called after `stop()` has been called.
`void`	`removeDragCanceledListener(IEventHandler<MarqueeSelectionEventArgs> dragCanceledEvent)` Removes the given listener for the `DragCanceled` event that occurs when the drag has been canceled.
`void`	`removeDragCancelingListener(IEventHandler<MarqueeSelectionEventArgs> dragCancelingEvent)` Removes the given listener for the `DragCanceling` event that occurs before the drag will be canceled.
`void`	`removeDragFinishedListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishedEvent)` Removes the given listener for the `DragFinished` event that occurs the drag has been finished.
`void`	`removeDragFinishingListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishingEvent)` Removes the given listener for the `DragFinishing` event that occurs before the drag will be finished.
`void`	`removeDraggedListener(IEventHandler<MarqueeSelectionEventArgs> draggedEvent)` Removes the given listener for the `Dragged` event that occurs at the end of every drag.
`void`	`removeDraggingListener(IEventHandler<MarqueeSelectionEventArgs> draggingEvent)` Removes the given listener for the `Dragging` event that occurs at the start of every drag.
`void`	`removeDragStartedListener(IEventHandler<MarqueeSelectionEventArgs> dragStartedEvent)` Removes the given listener for the `DragStarted` event that occurs once the drag is initialized and has started.
`void`	`removeDragStartingListener(IEventHandler<MarqueeSelectionEventArgs> dragStartingEvent)` Removes the given listener for the `DragStarting` event that occurs once the drag is starting.
`void`	`setCancelRecognizer(IEventRecognizer value)` Sets the "cancel" recognizer.
`void`	`setDraggedRecognizer(IEventRecognizer value)` Sets the "dragged" recognizer.
`void`	`setDraggedRecognizerTouch(IEventRecognizer value)` Sets the "dragged" recognizer for touch input.
`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`	`setMarqueeCursor(Cursor value)` Sets the cursor to use during the dragging of the marquee.
`void`	`setPressedRecognizer(IEventRecognizer value)` Sets the "pressed" state recognizer.
`void`	`setPressedRecognizerTouch(IEventRecognizer value)` Sets the "pressed" state recognizer for touch input.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setReleasedRecognizer(IEventRecognizer value)` Sets the "released" recognizer.
`void`	`setReleasedRecognizerTouch(IEventRecognizer value)` Sets the "released" recognizer for touch input.
`void`	`setTemplate(IVisualTemplate value)` Sets the template that is used for the visualization of the marquee rectangle.
`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

- Field Detail
  - MARQUEE_RECTANGLE_TEMPLATE_KEY
```
public static final ResourceKey MARQUEE_RECTANGLE_TEMPLATE_KEY
```
    A ResourceKey that can be used to store a IVisualTemplate that can be used to create the visual that will be used to draw the marquee box.
- Constructor Detail
  - MarqueeSelectionInputMode
```
public MarqueeSelectionInputMode()
```
    Creates a new instance of the marquee selection mode.
- Method Detail
  - addDragCanceledListener
```
public final void addDragCanceledListener(IEventHandler<MarqueeSelectionEventArgs> dragCanceledEvent)
```
    Adds the given listener for the DragCanceled event that occurs when the drag has been canceled.
    
    Parameters:
    
    dragCanceledEvent - The listener to add.
    
    See Also:
    
    removeDragCanceledListener(IEventHandler)
  - addDragCancelingListener
```
public final void addDragCancelingListener(IEventHandler<MarqueeSelectionEventArgs> dragCancelingEvent)
```
    Adds the given listener for the DragCanceling event that occurs before the drag will be canceled.
    
    Parameters:
    
    dragCancelingEvent - The listener to add.
    
    See Also:
    
    removeDragCancelingListener(IEventHandler)
  - addDragFinishedListener
```
public final void addDragFinishedListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishedEvent)
```
    Adds the given listener for the DragFinished event that occurs the drag has been finished.
    
    Parameters:
    
    dragFinishedEvent - The listener to add.
    
    See Also:
    
    removeDragFinishedListener(IEventHandler)
  - addDragFinishingListener
```
public final void addDragFinishingListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishingEvent)
```
    Adds the given listener for the DragFinishing event that occurs before the drag will be finished.
    
    Parameters:
    
    dragFinishingEvent - The listener to add.
    
    See Also:
    
    removeDragFinishingListener(IEventHandler)
  - addDraggedListener
```
public final void addDraggedListener(IEventHandler<MarqueeSelectionEventArgs> draggedEvent)
```
    Adds the given listener for the Dragged event that occurs at the end of every drag.
    
    Parameters:
    
    draggedEvent - The listener to add.
    
    See Also:
    
    removeDraggedListener(IEventHandler)
  - addDraggingListener
```
public final void addDraggingListener(IEventHandler<MarqueeSelectionEventArgs> draggingEvent)
```
    Adds the given listener for the Dragging event that occurs at the start of every drag.
    
    Parameters:
    
    draggingEvent - The listener to add.
    
    See Also:
    
    removeDraggingListener(IEventHandler)
  - addDragStartedListener
```
public final void addDragStartedListener(IEventHandler<MarqueeSelectionEventArgs> dragStartedEvent)
```
    Adds the given listener for the DragStarted event that occurs once the drag is initialized and has started.
    
    Parameters:
    
    dragStartedEvent - The listener to add.
    
    See Also:
    
    removeDragStartedListener(IEventHandler)
  - addDragStartingListener
```
public final void addDragStartingListener(IEventHandler<MarqueeSelectionEventArgs> dragStartingEvent)
```
    Adds the given listener for the DragStarting event that occurs once the drag is starting.
    
    Parameters:
    
    dragStartingEvent - The listener to add.
    
    See Also:
    
    removeDragStartingListener(IEventHandler)
  - cancel
```
public void cancel()
```
    Cancels any pending marquee selection.
    
    Specified by:
    
    cancel in interface IInputMode
  - createInputModeEventArgs
```
protected MarqueeSelectionEventArgs createInputModeEventArgs()
```
    Helper method that yields a suitably configured InputModeEventArgs for this input mode.
    
    Returns:
    
    An input mode event argument that is configured for this instance.
  - getCancelRecognizer
```
public final IEventRecognizer getCancelRecognizer()
```
    Gets the "cancel" recognizer.
    This recognizer recognizes the cancel action during the marquee selection.
    
    Returns:
    
    The "cancel" recognizer.
    
    See Also:
    
    setCancelRecognizer(IEventRecognizer)
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getDraggedRecognizer
```
public final IEventRecognizer getDraggedRecognizer()
```
    Gets the "dragged" recognizer.
    This recognizer instance determines when the user is dragging the marquee.
    
    Returns:
    
    The "dragged" recognizer.
    
    See Also:
    
    setDraggedRecognizer(IEventRecognizer)
  - getDraggedRecognizerTouch
```
public final IEventRecognizer getDraggedRecognizerTouch()
```
    Gets the "dragged" recognizer for touch input.
    This recognizer instance determines when the user is dragging the marquee.
    
    Returns:
    
    The "dragged" recognizer for touch events.
    
    See Also:
    
    setDraggedRecognizerTouch(IEventRecognizer)
  - 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.
  - getMarqueeCursor
```
public final Cursor getMarqueeCursor()
```
    Gets the cursor to use during the dragging of the marquee.
    The default is Cursors.Cross
    
    Returns:
    
    The MarqueeCursor.
    
    See Also:
    
    setMarqueeCursor(Cursor)
  - getPressedRecognizer
```
public final IEventRecognizer getPressedRecognizer()
```
    Gets the "pressed" state recognizer.
    This recognizer instance will be used to determine when the user begins to draw the marquee.
    
    Returns:
    
    The "pressed" recognizer.
    
    See Also:
    
    setPressedRecognizer(IEventRecognizer)
  - getPressedRecognizerTouch
```
public final IEventRecognizer getPressedRecognizerTouch()
```
    Gets the "pressed" state recognizer for touch input.
    This recognizer instance will be used to determine when the user begins to draw the marquee.
    
    Returns:
    
    The "pressed" recognizer for touch events.
    
    See Also:
    
    setPressedRecognizerTouch(IEventRecognizer)
  - 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.
  - getReleasedRecognizer
```
public final IEventRecognizer getReleasedRecognizer()
```
    Gets the "released" recognizer.
    This instance determines when the user has finished creating the marquee.
    
    Returns:
    
    The "released" recognizer.
    
    See Also:
    
    setReleasedRecognizer(IEventRecognizer)
  - getReleasedRecognizerTouch
```
public final IEventRecognizer getReleasedRecognizerTouch()
```
    Gets the "released" recognizer for touch input.
    This instance determines when the user has finished creating the marquee.
    
    Returns:
    
    The "released" recognizer for touch events.
    
    See Also:
    
    setReleasedRecognizerTouch(IEventRecognizer)
  - getSelectionRectangle
```
public final RectD getSelectionRectangle()
```
    Gets the current or last marquee selection rectangle.
    
    Returns:
    
    The SelectionRectangle.
  - getTemplate
```
public final IVisualTemplate getTemplate()
```
    Gets the template that is used for the visualization of the marquee rectangle.
    
    Returns:
    
    The template.
    
    See Also:
    
    setTemplate(IVisualTemplate)
  - 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)
  - 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.
  - onDragCanceled
```
protected void onDragCanceled(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Triggers the DragCanceled event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragCanceling
```
protected void onDragCanceling(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Triggers the DragCanceling event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragFinished
```
protected void onDragFinished(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Callback triggered once the drag has been finalized.
    This method triggers the DragFinished event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragFinishing
```
protected void onDragFinishing(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Callback triggered before the drag will be finalized.
    This method triggers the DragFinishing event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragged
```
protected void onDragged(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Callback triggered at the end of each drag.
    This method triggers the Dragged event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragging
```
protected void onDragging(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Callback triggered at the start of each drag.
    This method triggers the Dragging event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragStarted
```
protected void onDragStarted(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Triggers the DragStarted event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragStarting
```
protected void onDragStarting(MarqueeSelectionEventArgs inputModeEventArgs)
```
    Triggers the DragStarting event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - 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.
  - removeDragCanceledListener
```
public final void removeDragCanceledListener(IEventHandler<MarqueeSelectionEventArgs> dragCanceledEvent)
```
    Removes the given listener for the DragCanceled event that occurs when the drag has been canceled.
    
    Parameters:
    
    dragCanceledEvent - The listener to remove.
    
    See Also:
    
    addDragCanceledListener(IEventHandler)
  - removeDragCancelingListener
```
public final void removeDragCancelingListener(IEventHandler<MarqueeSelectionEventArgs> dragCancelingEvent)
```
    Removes the given listener for the DragCanceling event that occurs before the drag will be canceled.
    
    Parameters:
    
    dragCancelingEvent - The listener to remove.
    
    See Also:
    
    addDragCancelingListener(IEventHandler)
  - removeDragFinishedListener
```
public final void removeDragFinishedListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishedEvent)
```
    Removes the given listener for the DragFinished event that occurs the drag has been finished.
    
    Parameters:
    
    dragFinishedEvent - The listener to remove.
    
    See Also:
    
    addDragFinishedListener(IEventHandler)
  - removeDragFinishingListener
```
public final void removeDragFinishingListener(IEventHandler<MarqueeSelectionEventArgs> dragFinishingEvent)
```
    Removes the given listener for the DragFinishing event that occurs before the drag will be finished.
    
    Parameters:
    
    dragFinishingEvent - The listener to remove.
    
    See Also:
    
    addDragFinishingListener(IEventHandler)
  - removeDraggedListener
```
public final void removeDraggedListener(IEventHandler<MarqueeSelectionEventArgs> draggedEvent)
```
    Removes the given listener for the Dragged event that occurs at the end of every drag.
    
    Parameters:
    
    draggedEvent - The listener to remove.
    
    See Also:
    
    addDraggedListener(IEventHandler)
  - removeDraggingListener
```
public final void removeDraggingListener(IEventHandler<MarqueeSelectionEventArgs> draggingEvent)
```
    Removes the given listener for the Dragging event that occurs at the start of every drag.
    
    Parameters:
    
    draggingEvent - The listener to remove.
    
    See Also:
    
    addDraggingListener(IEventHandler)
  - removeDragStartedListener
```
public final void removeDragStartedListener(IEventHandler<MarqueeSelectionEventArgs> dragStartedEvent)
```
    Removes the given listener for the DragStarted event that occurs once the drag is initialized and has started.
    
    Parameters:
    
    dragStartedEvent - The listener to remove.
    
    See Also:
    
    addDragStartedListener(IEventHandler)
  - removeDragStartingListener
```
public final void removeDragStartingListener(IEventHandler<MarqueeSelectionEventArgs> dragStartingEvent)
```
    Removes the given listener for the DragStarting event that occurs once the drag is starting.
    
    Parameters:
    
    dragStartingEvent - The listener to remove.
    
    See Also:
    
    addDragStartingListener(IEventHandler)
  - setCancelRecognizer
```
public final void setCancelRecognizer(IEventRecognizer value)
```
    Sets the "cancel" recognizer.
    This recognizer recognizes the cancel action during the marquee selection.
    
    Parameters:
    
    value - The "cancel" recognizer.
    
    See Also:
    
    getCancelRecognizer()
  - setDraggedRecognizer
```
public final void setDraggedRecognizer(IEventRecognizer value)
```
    Sets the "dragged" recognizer.
    This recognizer instance determines when the user is dragging the marquee.
    
    Parameters:
    
    value - The "dragged" recognizer.
    
    See Also:
    
    getDraggedRecognizer()
  - setDraggedRecognizerTouch
```
public final void setDraggedRecognizerTouch(IEventRecognizer value)
```
    Sets the "dragged" recognizer for touch input.
    This recognizer instance determines when the user is dragging the marquee.
    
    Parameters:
    
    value - The "dragged" recognizer for touch events.
    
    See Also:
    
    getDraggedRecognizerTouch()
  - 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()
  - setMarqueeCursor
```
public final void setMarqueeCursor(Cursor value)
```
    Sets the cursor to use during the dragging of the marquee.
    The default is Cursors.Cross
    
    Parameters:
    
    value - The MarqueeCursor to set.
    
    See Also:
    
    getMarqueeCursor()
  - setPressedRecognizer
```
public final void setPressedRecognizer(IEventRecognizer value)
```
    Sets the "pressed" state recognizer.
    This recognizer instance will be used to determine when the user begins to draw the marquee.
    
    Parameters:
    
    value - The "pressed" recognizer.
    
    See Also:
    
    getPressedRecognizer()
  - setPressedRecognizerTouch
```
public final void setPressedRecognizerTouch(IEventRecognizer value)
```
    Sets the "pressed" state recognizer for touch input.
    This recognizer instance will be used to determine when the user begins to draw the marquee.
    
    Parameters:
    
    value - The "pressed" recognizer for touch events.
    
    See Also:
    
    getPressedRecognizerTouch()
  - 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()
  - setReleasedRecognizer
```
public final void setReleasedRecognizer(IEventRecognizer value)
```
    Sets the "released" recognizer.
    This instance determines when the user has finished creating the marquee.
    
    Parameters:
    
    value - The "released" recognizer.
    
    See Also:
    
    getReleasedRecognizer()
  - setReleasedRecognizerTouch
```
public final void setReleasedRecognizerTouch(IEventRecognizer value)
```
    Sets the "released" recognizer for touch input.
    This instance determines when the user has finished creating the marquee.
    
    Parameters:
    
    value - The "released" recognizer for touch events.
    
    See Also:
    
    getReleasedRecognizerTouch()
  - setTemplate
```
public final void setTemplate(IVisualTemplate value)
```
    Sets the template that is used for the visualization of the marquee rectangle.
    
    Parameters:
    
    value - The template.
    
    See Also:
    
    getTemplate()
  - 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 MarqueeSelectionInputMode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MARQUEE_RECTANGLE_TEMPLATE_KEY

Constructor Detail

MarqueeSelectionInputMode

Method Detail

addDragCanceledListener

addDragCancelingListener

addDragFinishedListener

addDragFinishingListener

addDraggedListener

addDraggingListener

addDragStartedListener

addDragStartingListener

cancel

createInputModeEventArgs

getCancelRecognizer

getController

getDraggedRecognizer

getDraggedRecognizerTouch

getInputModeContext

getMarqueeCursor

getPressedRecognizer

getPressedRecognizerTouch

getPriority

getReleasedRecognizer

getReleasedRecognizerTouch

getSelectionRectangle

getTemplate

install

isEnabled

isExclusive

onCanceled

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onDragCanceled

onDragCanceling

onDragFinished

onDragFinishing

onDragged

onDragging

onDragStarted

onDragStarting

onStopped

removeDragCanceledListener

removeDragCancelingListener

removeDragFinishedListener

removeDragFinishingListener

removeDraggedListener

removeDraggingListener

removeDragStartedListener

removeDragStartingListener

setCancelRecognizer

setDraggedRecognizer

setDraggedRecognizerTouch

setEnabled

setExclusive

setMarqueeCursor

setPressedRecognizer

setPressedRecognizerTouch

setPriority

setReleasedRecognizer

setReleasedRecognizerTouch

setTemplate

stop

uninstall