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

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

All Implemented Interfaces:

IInputMode
```
public class MoveViewportInputMode
extends Object
implements IInputMode
```
An IInputMode implementation that can be used to grab and drag the viewport of the control it is installed in.
This implementation will request the mutex as soon as it recognizes a drag with the mouse or touch. Zooming is done with two fingers using the pinch zoom gesture. If the primary pointer is released during pinch, the secondary pointer is used for viewpoint dragging. The pinch zoom then can be restarted by touching another pointer that is recognized as the primary pointer.

This mode is Exclusive by default.

Constructor Summary

Constructors
Constructor and Description

MoveViewportInputMode()
Creates a new instance of the move viewport mode.

Constructors
Constructor and Description
`MoveViewportInputMode()` Creates a new instance of the move viewport mode.

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.
`protected void`	`arm()` Called to prepare moving the viewport when the mouse is pressed.
`void`	`cancel()` Cancels navigation.
`protected void`	`disarm()` Called after moving the viewport is finished or canceled.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`Cursor`	`getDragCursor()` The cursor to use during the dragging.
`IEventRecognizer`	`getDraggedRecognizer()` Gets the "dragged" recognizer.
`InertiaPolicies`	`getInertia()` Gets the mode that determines when to use inertia when dragging the viewport.
`double`	`getInertiaDamping()` The amount of damping that is applied to the inertia movement.
`double`	`getInertiaFactor()` Gets the factor that determines how much the recent movement data is taken into account for the calculation of inertia speed and direction.
`double`	`getInertiaThreshold()` Gets the threshold that determines when inertia movement should stop.
`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`	`getPrimaryDownRecognizer()` Gets the `IEventRecognizer` that starts the 'move viewport' gesture.
`IEventRecognizer`	`getPrimaryMoveRecognizer()` Gets the `IEventRecognizer` that moves the viewport or zooms the canvas if a secondary device is down.
`IEventRecognizer`	`getPrimaryUpRecognizer()` Gets the `IEventRecognizer` that ends the 'move viewport' or 'pinch' gesture.
`int`	`getPriority()` The priority of this input mode.
`IEventRecognizer`	`getReleasedRecognizer()` Gets the "released" recognizer.
`IEventRecognizer`	`getSecondaryDownRecognizer()` Gets the `IEventRecognizer` that starts the 'pinch' gesture.
`IEventRecognizer`	`getSecondaryMoveRecognizer()` Gets the `IEventRecognizer` that zooms the canvas using the 'pinch' gesture or moves the viewport if no primary device is down.
`IEventRecognizer`	`getSecondaryUpRecognizer()` Gets the `IEventRecognizer` that ends the pinch zoom gesture or ends the move if no primary device is down.
`void`	`install(IInputModeContext context, ConcurrencyController controller)` Installs this mode into the given context that is provided by the canvas.
`boolean`	`isEnabled()` Gets the enabled state of this input mode.
`boolean`	`isExclusive()` Gets a value indicating whether this mode will be the only one running when it has the mutex.
`boolean`	`isPinchZoomAllowed()` Gets a value indicating whether to allow the pinch zoom gesture.
`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`	`setDragCursor(Cursor value)` The cursor to use during the dragging.
`void`	`setDraggedRecognizer(IEventRecognizer value)` Sets the "dragged" recognizer.
`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`	`setInertia(InertiaPolicies value)` Sets the mode that determines when to use inertia when dragging the viewport.
`void`	`setInertiaDamping(double value)` The amount of damping that is applied to the inertia movement.
`void`	`setInertiaFactor(double value)` Sets the factor that determines how much the recent movement data is taken into account for the calculation of inertia speed and direction.
`void`	`setInertiaThreshold(double value)` Sets the threshold that determines when inertia movement should stop.
`void`	`setPinchZoomAllowed(boolean value)` Sets a value indicating whether to allow the pinch zoom gesture.
`void`	`setPressedRecognizer(IEventRecognizer value)` Sets the "pressed" state recognizer.
`void`	`setPrimaryDownRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that starts the 'move viewport' gesture.
`void`	`setPrimaryMoveRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that moves the viewport or zooms the canvas if a secondary device is down.
`void`	`setPrimaryUpRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that ends the 'move viewport' or 'pinch' gesture.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setReleasedRecognizer(IEventRecognizer value)` Sets the "released" recognizer.
`void`	`setSecondaryDownRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that starts the 'pinch' gesture.
`void`	`setSecondaryMoveRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that zooms the canvas using the 'pinch' gesture or moves the viewport if no primary device is down.
`void`	`setSecondaryUpRecognizer(IEventRecognizer value)` Sets the `IEventRecognizer` that ends the pinch zoom gesture or ends the move if no primary device is down.
`boolean`	`stop()` Called by the client in order to stop a current editing progress.
`void`	`uninstall(IInputModeContext context)` Uninstalls this mode from the given context.

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

- Constructor Detail
  - MoveViewportInputMode
```
public MoveViewportInputMode()
```
    Creates a new instance of the move viewport mode.
- 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)
  - arm
```
protected void arm()
```
    Called to prepare moving the viewport when the mouse is pressed.
    This will set the mouse cursor to DragCursor.
  - cancel
```
public void cancel()
```
    Cancels navigation.
    
    Specified by:
    
    cancel in interface IInputMode
  - disarm
```
protected void disarm()
```
    Called after moving the viewport is finished or canceled.
    This will reset the mouse cursor.
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getDragCursor
```
public final Cursor getDragCursor()
```
    The cursor to use during the dragging.
    The default is Hand.
    
    Returns:
    
    The DragCursor.
    
    See Also:
    
    setDragCursor(Cursor)
  - getDraggedRecognizer
```
public final IEventRecognizer getDraggedRecognizer()
```
    Gets the "dragged" recognizer.
    This recognizer instance determines when the user is dragging the viewport.
    
    Returns:
    
    The "dragged" recognizer.
    
    See Also:
    
    setDraggedRecognizer(IEventRecognizer)
  - getInertia
```
public final InertiaPolicies getInertia()
```
    Gets the mode that determines when to use inertia when dragging the viewport.
    
    Returns:
    
    The Inertia.
    
    See Also:
    
    setInertia(InertiaPolicies)
  - getInertiaDamping
```
public final double getInertiaDamping()
```
    The amount of damping that is applied to the inertia movement.
    The default value is 0.15d
    
    Returns:
    
    A value between 0 and 1 that determines the factor the inertia speed is reduced by after one second.
    
    See Also:
    
    setInertiaDamping(double)
  - getInertiaFactor
```
public final double getInertiaFactor()
```
    Gets the factor that determines how much the recent movement data is taken into account for the calculation of inertia speed and direction.
    The default value is 0.02d
    
    Returns:
    
    A value between 0 and 1. Lesser values mean less influence of old data.
    
    See Also:
    
    setInertiaFactor(double)
  - getInertiaThreshold
```
public final double getInertiaThreshold()
```
    Gets the threshold that determines when inertia movement should stop.
    The default value is 30
    
    Returns:
    
    A positive value that determines the threshold in pixels per second.
    
    See Also:
    
    setInertiaThreshold(double)
  - 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 the navigation gesture.
    
    Returns:
    
    The "pressed" recognizer.
    
    See Also:
    
    setPressedRecognizer(IEventRecognizer)
  - getPrimaryDownRecognizer
```
public final IEventRecognizer getPrimaryDownRecognizer()
```
    Gets the IEventRecognizer that starts the 'move viewport' gesture.
    
    Returns:
    
    The recognizer instance that identifies the event that starts the viewport moving gesture. The default instance recognizes if the user presses the primary touch device down.
    
    See Also:
    
    setPrimaryDownRecognizer(IEventRecognizer)
  - getPrimaryMoveRecognizer
```
public final IEventRecognizer getPrimaryMoveRecognizer()
```
    Gets the IEventRecognizer that moves the viewport or zooms the canvas if a secondary device is down.
    
    Returns:
    
    The recognizer instance that identifies the event that moves the viewport or zooms the canvas. The default instance recognizes if the user moves the primary touch device.
    
    See Also:
    
    setPrimaryMoveRecognizer(IEventRecognizer)
  - getPrimaryUpRecognizer
```
public final IEventRecognizer getPrimaryUpRecognizer()
```
    Gets the IEventRecognizer that ends the 'move viewport' or 'pinch' gesture.
    
    Returns:
    
    The recognizer instance that identifies the event that ends the viewport moving or pinch gesture. The default instance recognizes if the user releases the primary touch device.
    
    See Also:
    
    setPrimaryUpRecognizer(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 dragging the viewport.
    
    Returns:
    
    The "released" recognizer.
    
    See Also:
    
    setReleasedRecognizer(IEventRecognizer)
  - getSecondaryDownRecognizer
```
public final IEventRecognizer getSecondaryDownRecognizer()
```
    Gets the IEventRecognizer that starts the 'pinch' gesture.
    
    Returns:
    
    The recognizer instance that identifies the event that starts the pinch gesture. The default instance recognizes if the user presses the secondary touch device down.
    
    See Also:
    
    setSecondaryDownRecognizer(IEventRecognizer)
  - getSecondaryMoveRecognizer
```
public final IEventRecognizer getSecondaryMoveRecognizer()
```
    Gets the IEventRecognizer that zooms the canvas using the 'pinch' gesture or moves the viewport if no primary device is down.
    
    Returns:
    
    The recognizer instance that identifies the event that zooms the canvas or moves the viewport if no primary device is down. The default instance recognizes if the user moves the secondary touch device.
    
    See Also:
    
    setSecondaryMoveRecognizer(IEventRecognizer)
  - getSecondaryUpRecognizer
```
public final IEventRecognizer getSecondaryUpRecognizer()
```
    Gets the IEventRecognizer that ends the pinch zoom gesture or ends the move if no primary device is down.
    
    Returns:
    
    The recognizer instance that identifies the event that ends the pinch zoom gesture or ends the move if no primary device is down. The default instance recognizes if the user releases the secondary touch device.
    
    See Also:
    
    setSecondaryUpRecognizer(IEventRecognizer)
  - 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)
  - isPinchZoomAllowed
```
public final boolean isPinchZoomAllowed()
```
    Gets a value indicating whether to allow the pinch zoom gesture.
    
    Returns:
    
    true if the pinch zoom gesture is allowed to change the zoom level; otherwise, false.
    
    See Also:
    
    setPinchZoomAllowed(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(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)
  - setDragCursor
```
public final void setDragCursor(Cursor value)
```
    The cursor to use during the dragging.
    The default is Hand.
    
    Parameters:
    
    value - The DragCursor to set.
    
    See Also:
    
    getDragCursor()
  - setDraggedRecognizer
```
public final void setDraggedRecognizer(IEventRecognizer value)
```
    Sets the "dragged" recognizer.
    This recognizer instance determines when the user is dragging the viewport.
    
    Parameters:
    
    value - The "dragged" recognizer.
    
    See Also:
    
    getDraggedRecognizer()
  - 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()
  - setInertia
```
public final void setInertia(InertiaPolicies value)
```
    Sets the mode that determines when to use inertia when dragging the viewport.
    
    Parameters:
    
    value - The Inertia to set.
    
    See Also:
    
    getInertia()
  - setInertiaDamping
```
public final void setInertiaDamping(double value)
```
    The amount of damping that is applied to the inertia movement.
    The default value is 0.15d
    
    Parameters:
    
    value - A value between 0 and 1 that determines the factor the inertia speed is reduced by after one second.
    
    See Also:
    
    getInertiaDamping()
  - setInertiaFactor
```
public final void setInertiaFactor(double value)
```
    Sets the factor that determines how much the recent movement data is taken into account for the calculation of inertia speed and direction.
    The default value is 0.02d
    
    Parameters:
    
    value - A value between 0 and 1. Lesser values mean less influence of old data.
    
    See Also:
    
    getInertiaFactor()
  - setInertiaThreshold
```
public final void setInertiaThreshold(double value)
```
    Sets the threshold that determines when inertia movement should stop.
    The default value is 30
    
    Parameters:
    
    value - A positive value that determines the threshold in pixels per second.
    
    See Also:
    
    getInertiaThreshold()
  - setPinchZoomAllowed
```
public final void setPinchZoomAllowed(boolean value)
```
    Sets a value indicating whether to allow the pinch zoom gesture.
    
    Parameters:
    
    value - true if the pinch zoom gesture is allowed to change the zoom level; otherwise, false.
    
    See Also:
    
    isPinchZoomAllowed()
  - setPressedRecognizer
```
public final void setPressedRecognizer(IEventRecognizer value)
```
    Sets the "pressed" state recognizer.
    This recognizer instance will be used to determine when the user begins the navigation gesture.
    
    Parameters:
    
    value - The "pressed" recognizer.
    
    See Also:
    
    getPressedRecognizer()
  - setPrimaryDownRecognizer
```
public final void setPrimaryDownRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that starts the 'move viewport' gesture.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that starts the viewport moving gesture. The default instance recognizes if the user presses the primary touch device down.
    
    See Also:
    
    getPrimaryDownRecognizer()
  - setPrimaryMoveRecognizer
```
public final void setPrimaryMoveRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that moves the viewport or zooms the canvas if a secondary device is down.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that moves the viewport or zooms the canvas. The default instance recognizes if the user moves the primary touch device.
    
    See Also:
    
    getPrimaryMoveRecognizer()
  - setPrimaryUpRecognizer
```
public final void setPrimaryUpRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that ends the 'move viewport' or 'pinch' gesture.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that ends the viewport moving or pinch gesture. The default instance recognizes if the user releases the primary touch device.
    
    See Also:
    
    getPrimaryUpRecognizer()
  - 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 dragging the viewport.
    
    Parameters:
    
    value - The "released" recognizer.
    
    See Also:
    
    getReleasedRecognizer()
  - setSecondaryDownRecognizer
```
public final void setSecondaryDownRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that starts the 'pinch' gesture.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that starts the pinch gesture. The default instance recognizes if the user presses the secondary touch device down.
    
    See Also:
    
    getSecondaryDownRecognizer()
  - setSecondaryMoveRecognizer
```
public final void setSecondaryMoveRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that zooms the canvas using the 'pinch' gesture or moves the viewport if no primary device is down.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that zooms the canvas or moves the viewport if no primary device is down. The default instance recognizes if the user moves the secondary touch device.
    
    See Also:
    
    getSecondaryMoveRecognizer()
  - setSecondaryUpRecognizer
```
public final void setSecondaryUpRecognizer(IEventRecognizer value)
```
    Sets the IEventRecognizer that ends the pinch zoom gesture or ends the move if no primary device is down.
    
    Parameters:
    
    value - The recognizer instance that identifies the event that ends the pinch zoom gesture or ends the move if no primary device is down. The default instance recognizes if the user releases the secondary touch device.
    
    See Also:
    
    getSecondaryUpRecognizer()
  - 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 final void uninstall(IInputModeContext context)
```
    Description copied from interface: IInputMode
    
    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.
    
    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 MoveViewportInputMode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MoveViewportInputMode

Method Detail

addDragCanceledListener

addDragCancelingListener

addDragFinishedListener

addDragFinishingListener

addDraggedListener

addDraggingListener

addDragStartedListener

addDragStartingListener

arm

cancel

disarm

getController

getDragCursor

getDraggedRecognizer

getInertia

getInertiaDamping

getInertiaFactor

getInertiaThreshold

getInputModeContext

getPressedRecognizer

getPrimaryDownRecognizer

getPrimaryMoveRecognizer

getPrimaryUpRecognizer

getPriority

getReleasedRecognizer

getSecondaryDownRecognizer

getSecondaryMoveRecognizer

getSecondaryUpRecognizer

install

isEnabled

isExclusive

isPinchZoomAllowed

onCanceled

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onDragCanceled

onDragCanceling

onDragFinished

onDragFinishing

onDragged

onDragging

onDragStarted

onDragStarting

onStopped

removeDragCanceledListener

removeDragCancelingListener

removeDragFinishedListener

removeDragFinishingListener

removeDraggedListener

removeDraggingListener

removeDragStartedListener

removeDragStartingListener

setDragCursor

setDraggedRecognizer

setEnabled

setExclusive

setInertia

setInertiaDamping

setInertiaFactor

setInertiaThreshold

setPinchZoomAllowed

setPressedRecognizer

setPrimaryDownRecognizer

setPrimaryMoveRecognizer

setPrimaryUpRecognizer

setPriority

setReleasedRecognizer

setSecondaryDownRecognizer

setSecondaryMoveRecognizer

setSecondaryUpRecognizer

stop

uninstall