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

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

All Implemented Interfaces:

IInputMode
```
public class HandleInputMode
extends Object
implements IInputMode
```
An IInputMode implementation that can handle a collection of IHandles.
This mode will render a visual representation of IHandles in the CanvasControl and deal with mouse gestures that drag the visual representations accordingly.

This mode is Exclusive by default.

See Also:

IHandle

Field Summary

Fields
Modifier and Type	Field and Description
`static ResourceKey`	`HANDLE_DRAWING_DEFAULT_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.DEFAULT`.
`static ResourceKey`	`HANDLE_DRAWING_DEFAULT_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` H`HandleTypes.DEFAULT` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_DEFAULT_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.DEFAULT` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_DEFAULT_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.DEFAULT` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_INVISIBLE_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.INVISIBLE`.
`static ResourceKey`	`HANDLE_DRAWING_INVISIBLE_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.INVISIBLE` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_INVISIBLE_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.INVISIBLE` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_INVISIBLE_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.INVISIBLE` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_MOVE_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.MOVE`.
`static ResourceKey`	`HANDLE_DRAWING_MOVE_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.MOVE` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_MOVE_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.MOVE` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_MOVE_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.MOVE` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_RESIZE_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.RESIZE`.
`static ResourceKey`	`HANDLE_DRAWING_RESIZE_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.RESIZE` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_RESIZE_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.RESIZE` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_RESIZE_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.RESIZE` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_ROTATE_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.ROTATE`.
`static ResourceKey`	`HANDLE_DRAWING_ROTATE_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.ROTATE` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_ROTATE_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.ROTATE` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_ROTATE_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.ROTATE` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_SHEAR_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.SHEAR`.
`static ResourceKey`	`HANDLE_DRAWING_SHEAR_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.SHEAR` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_SHEAR_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.SHEAR` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_SHEAR_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.SHEAR` \| `HandleTypes.VARIANT4`.
`static ResourceKey`	`HANDLE_DRAWING_WARP_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.WARP`.
`static ResourceKey`	`HANDLE_DRAWING_WARP_VARIANT2_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.WARP` \| `HandleTypes.VARIANT2`.
`static ResourceKey`	`HANDLE_DRAWING_WARP_VARIANT3_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.WARP` \| `HandleTypes.VARIANT3`.
`static ResourceKey`	`HANDLE_DRAWING_WARP_VARIANT4_KEY` A `ResourceKey` that can be used by instances of the `HandleInputMode` to look up a `IVisualTemplate` that will be used for the rendering of `IHandle`s of `type` `HandleTypes.WARP` \| `HandleTypes.VARIANT4`.

Constructor Summary

Constructors
Constructor and Description

HandleInputMode()
Creates a new mode with no handles initially.

Constructors
Constructor and Description
`HandleInputMode()` Creates a new mode with no handles initially.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDragCanceledListener(IEventHandler<InputModeEventArgs> dragCanceledEvent)` Adds the given listener for the `DragCanceled` event that occurs when the drag has been canceled.
`void`	`addDragCancelingListener(IEventHandler<InputModeEventArgs> dragCancelingEvent)` Adds the given listener for the `DragCanceling` event that occurs before the drag will be canceled.
`void`	`addDragFinishedListener(IEventHandler<InputModeEventArgs> dragFinishedEvent)` Adds the given listener for the `DragFinished` event that occurs once the drag has been finished.
`void`	`addDragFinishingListener(IEventHandler<InputModeEventArgs> dragFinishingEvent)` Adds the given listener for the `DragFinishing` event that occurs before the drag will be finished.
`void`	`addDraggedListener(IEventHandler<InputModeEventArgs> draggedEvent)` Adds the given listener for the `Dragged` event that occurs at the end of every drag.
`void`	`addDraggingListener(IEventHandler<InputModeEventArgs> draggingEvent)` Adds the given listener for the `Dragging` event that occurs at the start of every drag.
`void`	`addDragStartedListener(IEventHandler<InputModeEventArgs> dragStartedEvent)` Adds the given listener for the `DragStarted` event that occurs once the drag is initialized and has started.
`void`	`addDragStartingListener(IEventHandler<InputModeEventArgs> dragStartingEvent)` Adds the given listener for the `DragStarting` event that occurs once the drag is starting.
`void`	`addHandle(IHandle handle)` Adds a handle to the collection of handles managed by this instance.
`IHandle`	`addHandle(IMutablePoint location)` Factory method that creates and `adds` a handle to this mode by wrapping a given `IMutablePoint` instance.
`IHandle`	`addHandle(IMutablePoint location, Cursor cursor)` Factory method that creates and `adds` a handle to this mode by wrapping a given `IMutablePoint` instance.
`IHandle`	`addHandle(IMutablePoint location, Cursor cursor, HandleTypes type)` Factory method that creates and `adds` a handle to this mode by wrapping a given `IMutablePoint` instance.
`protected void`	`arm(IHandle handle)` Callback method that is invoked when this mode gets "armed".
`void`	`beginDragging(IHandle handle)` Method that can be used to initialize the dragging of a given handle by hand.
`void`	`cancel()` Called by the client to unconditionally cancel all editing.
`protected IInputModeContext`	`createHandleInputModeContext()` Creates an `IInputModeContext` for use with the `IHandle` interface for the upcoming drag operation.
`protected InputModeEventArgs`	`createInputModeEventArgs()` Helper method that yields a suitably configured `InputModeEventArgs` for this input mode.
`protected Node`	`createVisual(IRenderContext context, IHandle handle)` Callback that creates the `Node` for the given handle.
`protected void`	`disarm()` Callback method that is invoked when this mode gets "disarmed".
`IEnumerable<IModelItem>`	`getAffectedItems()` Gets an immutable snapshot of the `IModelItem`s affected by the currently modified `handle` gesture.
`IEventRecognizer`	`getCancelRecognizer()` Gets the "cancel" recognizer.
`protected IHandle`	`getClosestHitHandle(PointD location)` Finds the closest hit handle for the given world coordinate pair.
`protected IHandle`	`getClosestHitHandleTouch(PointD location)` Finds the closest hit handle for the given world coordinate pair.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`IHandle`	`getCurrentHandle()` Gets the handle that is currently being moved or `null` otherwise.
`IEventRecognizer`	`getDisableSnappingRecognizer()` Gets event recognizer that recognizes when the user temporarily disables snapping.
`IEventRecognizer`	`getDraggedRecognizer()` Gets the "dragged" recognizer.
`IEventRecognizer`	`getDraggedRecognizerTouch()` Gets the "dragged" recognizer for touch input.
`IEventRecognizer`	`getEnableSnappingRecognizer()` Gets event recognizer that recognizes when the user reenables temporarily disabled snapping.
`IObservableCollection<IHandle>`	`getHandles()` Gets the collection of `IHandle`s this mode manages.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`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.
`SnapContext`	`getSnapContext()` The `SnapContext` which manages snapping model items to certain coordinates (for instance, other items).
`protected boolean`	`handleIsHit(IHandle handle, PointD location, PointD distance)` Determines whether a given handle has been visually hit by the mouse at the given world coordinates.
`protected boolean`	`handleIsHitTouch(IHandle handle, PointD location, PointD distance)` Determines whether a given handle has been visually hit by the touch device at the given world coordinates.
`void`	`install(IInputModeContext context, ConcurrencyController controller)` Installs the visual representation of the handles into the canvas into the `InputModeGroup`.
`protected void`	`invalidate()` Convenience method that invalidates the canvas this mode is currently installed in.
`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 boolean`	`isHovering(Object sender, IEventArgs args)` Event recognizer callback used to determine whether the mouse is currently hovering over a handle.
`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(InputModeEventArgs inputModeEventArgs)` Triggers the `DragCanceled` event.
`protected void`	`onDragCanceling(InputModeEventArgs inputModeEventArgs)` Triggers the `DragCanceling` event.
`protected void`	`onDragFinished(InputModeEventArgs inputModeEventArgs)` Callback triggered once the drag has been finalized.
`protected void`	`onDragFinishing(InputModeEventArgs inputModeEventArgs)` Callback triggered before the drag will be finalized.
`protected void`	`onDragged(InputModeEventArgs inputModeEventArgs)` Callback triggered at the end of each drag.
`protected void`	`onDragging(InputModeEventArgs inputModeEventArgs)` Callback triggered at the start of each drag.
`protected void`	`onDragStarted(InputModeEventArgs inputModeEventArgs)` Triggers the `DragStarted` event.
`protected void`	`onDragStarting(InputModeEventArgs inputModeEventArgs)` Triggers the `DragStarting` event.
`protected void`	`onStopped()` Called after `stop()` has been called.
`void`	`removeDragCanceledListener(IEventHandler<InputModeEventArgs> dragCanceledEvent)` Removes the given listener for the `DragCanceled` event that occurs when the drag has been canceled.
`void`	`removeDragCancelingListener(IEventHandler<InputModeEventArgs> dragCancelingEvent)` Removes the given listener for the `DragCanceling` event that occurs before the drag will be canceled.
`void`	`removeDragFinishedListener(IEventHandler<InputModeEventArgs> dragFinishedEvent)` Removes the given listener for the `DragFinished` event that occurs once the drag has been finished.
`void`	`removeDragFinishingListener(IEventHandler<InputModeEventArgs> dragFinishingEvent)` Removes the given listener for the `DragFinishing` event that occurs before the drag will be finished.
`void`	`removeDraggedListener(IEventHandler<InputModeEventArgs> draggedEvent)` Removes the given listener for the `Dragged` event that occurs at the end of every drag.
`void`	`removeDraggingListener(IEventHandler<InputModeEventArgs> draggingEvent)` Removes the given listener for the `Dragging` event that occurs at the start of every drag.
`void`	`removeDragStartedListener(IEventHandler<InputModeEventArgs> dragStartedEvent)` Removes the given listener for the `DragStarted` event that occurs once the drag is initialized and has started.
`void`	`removeDragStartingListener(IEventHandler<InputModeEventArgs> dragStartingEvent)` Removes the given listener for the `DragStarting` event that occurs once the drag is starting.
`void`	`removeHandle(IHandle handle)` Removes a handle from the collection of handles managed by this instance.
`void`	`setCancelRecognizer(IEventRecognizer value)` Sets the "cancel" recognizer.
`void`	`setDisableSnappingRecognizer(IEventRecognizer value)` Sets event recognizer that recognizes when the user temporarily disables snapping.
`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`	`setEnableSnappingRecognizer(IEventRecognizer value)` Sets event recognizer that recognizes when the user reenables temporarily disabled snapping.
`void`	`setExclusive(boolean value)` Sets a value indicating whether this mode will be the only one running when it has the mutex.
`void`	`setHandles(IObservableCollection<IHandle> value)` Sets the collection of `IHandle`s this mode manages.
`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`	`setSnapContext(SnapContext value)` The `SnapContext` which manages snapping model items to certain coordinates (for instance, other items).
`boolean`	`stop()` Called by the client in order to stop a current editing progress.
`void`	`uninstall(IInputModeContext context)` Removes the `ICanvasObject` that displays the handles from the canvas.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HANDLE_DRAWING_DEFAULT_KEY
```
public static final ResourceKey HANDLE_DRAWING_DEFAULT_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.DEFAULT.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_DEFAULT_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_DEFAULT_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HHandleTypes.DEFAULT | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_DEFAULT_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_DEFAULT_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.DEFAULT | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_DEFAULT_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_DEFAULT_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.DEFAULT | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_INVISIBLE_KEY
```
public static final ResourceKey HANDLE_DRAWING_INVISIBLE_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.INVISIBLE.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_INVISIBLE_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_INVISIBLE_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.INVISIBLE | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_INVISIBLE_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_INVISIBLE_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.INVISIBLE | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_INVISIBLE_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_INVISIBLE_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.INVISIBLE | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_MOVE_KEY
```
public static final ResourceKey HANDLE_DRAWING_MOVE_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.MOVE.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_MOVE_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_MOVE_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.MOVE | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_MOVE_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_MOVE_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.MOVE | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_MOVE_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_MOVE_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.MOVE | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_RESIZE_KEY
```
public static final ResourceKey HANDLE_DRAWING_RESIZE_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.RESIZE.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_RESIZE_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_RESIZE_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.RESIZE | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_RESIZE_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_RESIZE_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.RESIZE | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_RESIZE_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_RESIZE_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.RESIZE | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_ROTATE_KEY
```
public static final ResourceKey HANDLE_DRAWING_ROTATE_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.ROTATE.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_ROTATE_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_ROTATE_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.ROTATE | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_ROTATE_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_ROTATE_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.ROTATE | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_ROTATE_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_ROTATE_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.ROTATE | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_SHEAR_KEY
```
public static final ResourceKey HANDLE_DRAWING_SHEAR_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.SHEAR.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_SHEAR_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_SHEAR_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.SHEAR | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_SHEAR_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_SHEAR_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.SHEAR | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_SHEAR_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_SHEAR_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.SHEAR | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_WARP_KEY
```
public static final ResourceKey HANDLE_DRAWING_WARP_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.WARP.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_WARP_VARIANT2_KEY
```
public static final ResourceKey HANDLE_DRAWING_WARP_VARIANT2_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.WARP | HandleTypes.VARIANT2.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_WARP_VARIANT3_KEY
```
public static final ResourceKey HANDLE_DRAWING_WARP_VARIANT3_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.WARP | HandleTypes.VARIANT3.
    The drawing returned should be centered around (0,0).
  - HANDLE_DRAWING_WARP_VARIANT4_KEY
```
public static final ResourceKey HANDLE_DRAWING_WARP_VARIANT4_KEY
```
    A ResourceKey that can be used by instances of the HandleInputMode to look up a IVisualTemplate that will be used for the rendering of IHandles of type HandleTypes.WARP | HandleTypes.VARIANT4.
    The drawing returned should be centered around (0,0).
- Constructor Detail
  - HandleInputMode
```
public HandleInputMode()
```
    Creates a new mode with no handles initially.
    
    See Also:
    
    getHandles()
- Method Detail
  - addDragCanceledListener
```
public final void addDragCanceledListener(IEventHandler<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> dragFinishedEvent)
```
    Adds the given listener for the DragFinished event that occurs once the drag has been finished.
    
    Parameters:
    
    dragFinishedEvent - The listener to add.
    
    See Also:
    
    removeDragFinishedListener(IEventHandler)
  - addDragFinishingListener
```
public final void addDragFinishingListener(IEventHandler<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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)
  - addHandle
```
public final void addHandle(IHandle handle)
```
    Adds a handle to the collection of handles managed by this instance.
    
    Parameters:
    
    handle - The handle to add.
  - addHandle
```
public final IHandle addHandle(IMutablePoint location)
```
    Factory method that creates and adds a handle to this mode by wrapping a given IMutablePoint instance.
    The cursor and type are used to initialize the IHandle instance.
    
    Parameters:
    
    location - The point to use as a handle.
    
    Returns:
    
    The handle created.
  - addHandle
```
public final IHandle addHandle(IMutablePoint location,
                               Cursor cursor)
```
    Factory method that creates and adds a handle to this mode by wrapping a given IMutablePoint instance.
    The cursor and type are used to initialize the IHandle instance.
    
    Parameters:
    
    location - The point to use as a handle.
    
    cursor - The cursor to use.
    
    Returns:
    
    The handle created.
  - addHandle
```
public final IHandle addHandle(IMutablePoint location,
                               Cursor cursor,
                               HandleTypes type)
```
    Factory method that creates and adds a handle to this mode by wrapping a given IMutablePoint instance.
    The cursor and type are used to initialize the IHandle instance.
    
    Parameters:
    
    location - The point to use as a handle.
    
    cursor - The cursor to use.
    
    type - The type of the handle to create.
    
    Returns:
    
    The handle created.
  - arm
```
protected void arm(IHandle handle)
```
    Callback method that is invoked when this mode gets "armed".
    This happens when the mouse pointer hovers over a handle. This changes the mouse cursor to the handle's Cursor.
  - beginDragging
```
public void beginDragging(IHandle handle)
```
    Method that can be used to initialize the dragging of a given handle by hand.
    This will simulate the user having initialized a drag of the given handle.
    
    Parameters:
    
    handle - The handle to be dragged.
  - 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
  - createHandleInputModeContext
```
protected IInputModeContext createHandleInputModeContext()
```
    Creates an IInputModeContext for use with the IHandle interface for the upcoming drag operation.
    
    Returns:
    
    An instance of IInputModeContext.
  - createInputModeEventArgs
```
protected InputModeEventArgs 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.
  - createVisual
```
protected Node createVisual(IRenderContext context,
                            IHandle handle)
```
    Callback that creates the Node for the given handle.
    
    Parameters:
    
    context - The render context the visual shall be created in.
    
    handle - The handle to create a visual representation for.
    
    Returns:
    
    The Node.
  - disarm
```
protected void disarm()
```
    Callback method that is invoked when this mode gets "disarmed".
    This happens when the mouse stops hovering over a handle. This resets the mouse cursor
  - getAffectedItems
```
public final IEnumerable<IModelItem> getAffectedItems()
```
    Gets an immutable snapshot of the IModelItems affected by the currently modified handle gesture.
    When the gesture is starting and the CurrentHandle is initialized, the implementation can register the affected item(s) through the IModelItemCollector instance that is bound to the context available via its ILookup.lookup(Class).
    
    Client code can register with the DragStarted event, as well as the DragFinished event to get notified of the elements that may be or have been affected respectively by this input mode.
    
    Returns:
    
    A snapshot of the current collection of the items that are affected by the handle drag operation.
  - getCancelRecognizer
```
public final IEventRecognizer getCancelRecognizer()
```
    Gets the "cancel" recognizer.
    This recognizer recognizes the cancel action during the move.
    
    Returns:
    
    The "cancel" recognizer.
    
    See Also:
    
    setCancelRecognizer(IEventRecognizer)
  - getClosestHitHandle
```
protected IHandle getClosestHitHandle(PointD location)
```
    Finds the closest hit handle for the given world coordinate pair.
    The default implementation compares the manhatten distance of the handles to find the closest handle.
    
    Parameters:
    
    location - The coordinates in the world coordinate system.
    
    Returns:
    
    The closest handle that has been hit or null
  - getClosestHitHandleTouch
```
protected IHandle getClosestHitHandleTouch(PointD location)
```
    Finds the closest hit handle for the given world coordinate pair.
    
    Parameters:
    
    location - The coordinates in the world coordinate system.
    
    Returns:
    
    The closest handle that has been hit or null
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getCurrentHandle
```
public final IHandle getCurrentHandle()
```
    Gets the handle that is currently being moved or null otherwise.
    
    Returns:
    
    The current handle or null.
  - getDisableSnappingRecognizer
```
public final IEventRecognizer getDisableSnappingRecognizer()
```
    Gets event recognizer that recognizes when the user temporarily disables snapping.
    
    Returns:
    
    The instance to use for disabling snapping. The default is IEventRecognizer.SHORTCUT_DOWN
    
    See Also:
    
    getEnableSnappingRecognizer(), setDisableSnappingRecognizer(IEventRecognizer)
  - getDraggedRecognizer
```
public final IEventRecognizer getDraggedRecognizer()
```
    Gets the "dragged" recognizer.
    This recognizer instance determines when the user is moving a handle.
    
    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 moving a handle.
    
    Returns:
    
    The "dragged" recognizer for touch events.
    
    See Also:
    
    setDraggedRecognizerTouch(IEventRecognizer)
  - getEnableSnappingRecognizer
```
public final IEventRecognizer getEnableSnappingRecognizer()
```
    Gets event recognizer that recognizes when the user reenables temporarily disabled snapping.
    
    Returns:
    
    The instance to use for reenabling snapping. The default is IEventRecognizer.SHORTCUT_UP
    
    See Also:
    
    setEnableSnappingRecognizer(IEventRecognizer)
  - getHandles
```
public final IObservableCollection<IHandle> getHandles()
```
    Gets the collection of IHandles this mode manages.
    
    Returns:
    
    The Handles.
    
    See Also:
    
    setHandles(IObservableCollection)
  - 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.
  - getPressedRecognizer
```
public final IEventRecognizer getPressedRecognizer()
```
    Gets the "pressed" state recognizer.
    This recognizer instance will be used to determine when the user begins to move a handle.
    
    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 move a handle.
    
    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 moving the handle.
    
    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 moving the handle.
    
    Returns:
    
    The "released" recognizer for touch events.
    
    See Also:
    
    setReleasedRecognizerTouch(IEventRecognizer)
  - getSnapContext
```
public final SnapContext getSnapContext()
```
    The SnapContext which manages snapping model items to certain coordinates (for instance, other items).
    If set to null (the default) this input mode tries to obtain the SnapContext from the IInputModeContext. To explicitly disable snapping, a SnapContext implementation that does nothing has to be set to this instance.
    
    Returns:
    
    The SnapContext.
    
    See Also:
    
    setSnapContext(SnapContext)
  - handleIsHit
```
protected boolean handleIsHit(IHandle handle,
                              PointD location,
                              PointD distance)
```
    Determines whether a given handle has been visually hit by the mouse at the given world coordinates.
    This implementation uses the manhatten distance as a metric to determine if the handle was hit.
    
    Parameters:
    
    handle - The handle to check
    
    location - The view coordinates to check.
    
    distance - The distance of the handle to the location. In the default implementation, this is a tuple representing the x- and y-distance of the handle to the location.
    
    Returns:
    
    Whether the handle has been hit.
  - handleIsHitTouch
```
protected boolean handleIsHitTouch(IHandle handle,
                                   PointD location,
                                   PointD distance)
```
    Determines whether a given handle has been visually hit by the touch device at the given world coordinates.
    
    Parameters:
    
    handle - The handle to check
    
    location - The world coordinates to check.
    
    distance - The distance of the handle to the touch location. In the default implementation, this is a tuple representing the x- and y-distance of the handle to the touch location.
    
    Returns:
    
    Whether the handle has been hit.
  - install
```
public void install(IInputModeContext context,
                    ConcurrencyController controller)
```
    Installs the visual representation of the handles into the canvas into the InputModeGroup.
    
    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 ConcurrencyController for this mode.
    
    See Also:
    
    IInputMode.uninstall(IInputModeContext)
  - invalidate
```
protected final void invalidate()
```
    Convenience method that invalidates the canvas this mode is currently installed in.
  - 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.
    
    Disabling this mode will hide the handles and prevent the user from interacting with them.
    
    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)
  - isHovering
```
protected boolean isHovering(Object sender,
                             IEventArgs args)
```
    Event recognizer callback used to determine whether the mouse is currently hovering over a handle.
    
    Returns:
    
    Whether the mouse is hovering over handle.
    
    See Also:
    
    getClosestHitHandle(PointD)
  - 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(InputModeEventArgs inputModeEventArgs)
```
    Triggers the DragCanceled event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragCanceling
```
protected void onDragCanceling(InputModeEventArgs inputModeEventArgs)
```
    Triggers the DragCanceling event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragFinished
```
protected void onDragFinished(InputModeEventArgs 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(InputModeEventArgs 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(InputModeEventArgs 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(InputModeEventArgs 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(InputModeEventArgs inputModeEventArgs)
```
    Triggers the DragStarted event.
    
    Parameters:
    
    inputModeEventArgs - The event argument that contains context information.
  - onDragStarting
```
protected void onDragStarting(InputModeEventArgs 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<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> dragFinishedEvent)
```
    Removes the given listener for the DragFinished event that occurs once the drag has been finished.
    
    Parameters:
    
    dragFinishedEvent - The listener to remove.
    
    See Also:
    
    addDragFinishedListener(IEventHandler)
  - removeDragFinishingListener
```
public final void removeDragFinishingListener(IEventHandler<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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<InputModeEventArgs> 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)
  - removeHandle
```
public final void removeHandle(IHandle handle)
```
    Removes a handle from the collection of handles managed by this instance.
    
    Parameters:
    
    handle - The handle to remove.
  - setCancelRecognizer
```
public final void setCancelRecognizer(IEventRecognizer value)
```
    Sets the "cancel" recognizer.
    This recognizer recognizes the cancel action during the move.
    
    Parameters:
    
    value - The "cancel" recognizer.
    
    See Also:
    
    getCancelRecognizer()
  - setDisableSnappingRecognizer
```
public final void setDisableSnappingRecognizer(IEventRecognizer value)
```
    Sets event recognizer that recognizes when the user temporarily disables snapping.
    
    Parameters:
    
    value - The instance to use for disabling snapping. The default is IEventRecognizer.SHORTCUT_DOWN
    
    See Also:
    
    getEnableSnappingRecognizer(), getDisableSnappingRecognizer()
  - setDraggedRecognizer
```
public final void setDraggedRecognizer(IEventRecognizer value)
```
    Sets the "dragged" recognizer.
    This recognizer instance determines when the user is moving a handle.
    
    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 moving a handle.
    
    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.
    
    Disabling this mode will hide the handles and prevent the user from interacting with them.
    
    Parameters:
    
    value - The Enabled to set.
    
    See Also:
    
    isEnabled()
  - setEnableSnappingRecognizer
```
public final void setEnableSnappingRecognizer(IEventRecognizer value)
```
    Sets event recognizer that recognizes when the user reenables temporarily disabled snapping.
    
    Parameters:
    
    value - The instance to use for reenabling snapping. The default is IEventRecognizer.SHORTCUT_UP
    
    See Also:
    
    getEnableSnappingRecognizer()
  - 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()
  - setHandles
```
public final void setHandles(IObservableCollection<IHandle> value)
```
    Sets the collection of IHandles this mode manages.
    
    Parameters:
    
    value - The Handles to set.
    
    See Also:
    
    getHandles()
  - 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 move a handle.
    
    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 move a handle.
    
    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 moving the handle.
    
    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 moving the handle.
    
    Parameters:
    
    value - The "released" recognizer for touch events.
    
    See Also:
    
    getReleasedRecognizerTouch()
  - setSnapContext
```
public final void setSnapContext(SnapContext value)
```
    The SnapContext which manages snapping model items to certain coordinates (for instance, other items).
    If set to null (the default) this input mode tries to obtain the SnapContext from the IInputModeContext. To explicitly disable snapping, a SnapContext implementation that does nothing has to be set to this instance.
    
    Parameters:
    
    value - The SnapContext to set.
    
    See Also:
    
    getSnapContext()
  - 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)
```
    Removes the ICanvasObject that displays the handles from the canvas.
    
    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 HandleInputMode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HANDLE_DRAWING_DEFAULT_KEY

HANDLE_DRAWING_DEFAULT_VARIANT2_KEY

HANDLE_DRAWING_DEFAULT_VARIANT3_KEY

HANDLE_DRAWING_DEFAULT_VARIANT4_KEY

HANDLE_DRAWING_INVISIBLE_KEY

HANDLE_DRAWING_INVISIBLE_VARIANT2_KEY

HANDLE_DRAWING_INVISIBLE_VARIANT3_KEY

HANDLE_DRAWING_INVISIBLE_VARIANT4_KEY

HANDLE_DRAWING_MOVE_KEY

HANDLE_DRAWING_MOVE_VARIANT2_KEY

HANDLE_DRAWING_MOVE_VARIANT3_KEY

HANDLE_DRAWING_MOVE_VARIANT4_KEY

HANDLE_DRAWING_RESIZE_KEY

HANDLE_DRAWING_RESIZE_VARIANT2_KEY

HANDLE_DRAWING_RESIZE_VARIANT3_KEY

HANDLE_DRAWING_RESIZE_VARIANT4_KEY

HANDLE_DRAWING_ROTATE_KEY

HANDLE_DRAWING_ROTATE_VARIANT2_KEY

HANDLE_DRAWING_ROTATE_VARIANT3_KEY

HANDLE_DRAWING_ROTATE_VARIANT4_KEY

HANDLE_DRAWING_SHEAR_KEY

HANDLE_DRAWING_SHEAR_VARIANT2_KEY

HANDLE_DRAWING_SHEAR_VARIANT3_KEY

HANDLE_DRAWING_SHEAR_VARIANT4_KEY

HANDLE_DRAWING_WARP_KEY

HANDLE_DRAWING_WARP_VARIANT2_KEY

HANDLE_DRAWING_WARP_VARIANT3_KEY

HANDLE_DRAWING_WARP_VARIANT4_KEY

Constructor Detail

HandleInputMode

Method Detail

addDragCanceledListener

addDragCancelingListener

addDragFinishedListener

addDragFinishingListener

addDraggedListener

addDraggingListener

addDragStartedListener

addDragStartingListener

addHandle

addHandle

addHandle

addHandle

arm

beginDragging

cancel

createHandleInputModeContext

createInputModeEventArgs

createVisual

disarm

getAffectedItems

getCancelRecognizer

getClosestHitHandle

getClosestHitHandleTouch

getController

getCurrentHandle

getDisableSnappingRecognizer

getDraggedRecognizer

getDraggedRecognizerTouch

getEnableSnappingRecognizer

getHandles

getInputModeContext

getPressedRecognizer

getPressedRecognizerTouch

getPriority

getReleasedRecognizer

getReleasedRecognizerTouch

getSnapContext

handleIsHit

handleIsHitTouch

install

invalidate

isEnabled

isExclusive