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

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

All Implemented Interfaces:

IInputMode

Direct Known Subclasses:

ItemDropInputMode
```
public class DropInputMode
extends Object
implements IInputMode
```
This is an input mode handling drag and drop related events on a CanvasControl.
An instance of DropInputMode is initialized for an expected data format in the constructor. There are four events raised by an instance of this class.
- DragEntered is raised, if a drag operation enters the CanvasControl.
- DragOver is raised, if a drag operation moves over the CanvasControl after having entered it.
- DragDropped is raised, if a drag is dropped onto the CanvasControl.
- DragLeft is raised, if a drag is operation leaves the CanvasControl.
Clients can query the current MousePosition which is updated while a drag is in progress. Clients get the data from the drag operation by calling DropData from an event handler registered for any of these events.

This mode is Exclusive by default.

Field Summary

Fields
Modifier and Type Field and Description

static DataFormat DATA_FORMAT_DROP_ID

Fields
Modifier and Type	Field and Description
`static DataFormat`	`DATA_FORMAT_DROP_ID`

Constructor Summary

Constructors
Constructor and Description

DropInputMode(Class expectedType)
Constructs a new instance of class DropInputMode for the expected type of data.

Constructors
Constructor and Description
`DropInputMode(Class expectedType)` Constructs a new instance of class `DropInputMode` for the expected type of data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDragDroppedListener(IEventHandler<InputModeEventArgs> dragDroppedEvent)` Adds the given listener for the `DragDropped` event that occurs when a drag operation is dropped onto the `CanvasControl` into which this instance is installed.
`void`	`addDragEnteredListener(IEventHandler<InputModeEventArgs> dragEnteredEvent)` Adds the given listener for the `DragEntered` event that occurs when a drag operation enters the `CanvasControl` into which this instance is installed.
`void`	`addDragLeftListener(IEventHandler<InputModeEventArgs> dragLeftEvent)` Adds the given listener for the `DragLeft` event that occurs when a drag operation leaves the `CanvasControl` into which this instance is installed.
`void`	`addDragOverListener(IEventHandler<InputModeEventArgs> dragOverEvent)` Adds the given listener for the `DragOver` event that occurs when a drag operation drags over the `CanvasControl` into which this instance is installed.
`protected boolean`	`adjustTransferMode(DragEvent e)` Callback that adjusts the transfer mode accordingly.
`void`	`cancel()` Cleanly cancels this mode.
`protected InputModeEventArgs`	`createInputModeEventArgs()` Helper method that yields a suitably configured `InputModeEventArgs` for this input mode.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`Object`	`getDropData()` Gets the data carried by a drag operation.
`protected Object`	`getDropData(Dragboard dragboard)` Gets the data carried by the drag operation.
`Map`	`getDropDataMap()` Returns the map that maps a drop id to in instance of the type this `DropInputMode` was created for.
`PointD`	`getDropLocation()` Gets the mouse position after dropping an item.
`protected Class`	`getExpectedType()` Returns the type of data this `DropInputMode` instance can handle.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`DragEvent`	`getLastDragEvent()` Gets the last processed drag event argument.
`IPoint`	`getMousePosition()` Gets the current mouse position during drag operations.
`int`	`getPriority()` The priority of this input mode.
`TransferMode[]`	`getTransferMode()` Gets the `TransferMode` that will be used for drags on the canvas.
`IHitTestable`	`getValidDropHitTestable()` Gets the `IHitTestable` that determines whether the given location is a valid drop location.
`void`	`install(IInputModeContext context, ConcurrencyController controller)` Installs this mode into the given canvas.
`boolean`	`isCapturingMouseInputDuringDragEnabled()` Gets a value indicating whether to capture mouse input during drag operations.
`boolean`	`isEnabled()` Gets the enabled state of this input mode.
`boolean`	`isExclusive()` Gets a value indicating whether this mode will be the only one running when it has the mutex.
`protected void`	`onCanceled()` Called after `cancel()` has been called.
`protected void`	`onConcurrencyControllerActivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `true`.
`protected void`	`onConcurrencyControllerDeactivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `false`.
`protected void`	`onDragDropped(InputModeEventArgs eventArgs)` Called once a drag has been dropped on the canvas.
`protected void`	`onDragEntered(InputModeEventArgs eventArgs)` Called once a drag has entered the canvas.
`protected void`	`onDragExited(InputModeEventArgs eventArgs)` Called once a drag has left the canvas.
`protected void`	`onDraggedOver(InputModeEventArgs eventArgs)` Called whenever a drag is over the canvas.
`protected void`	`onStopped()` Called after `stop()` has been called.
`void`	`removeDragDroppedListener(IEventHandler<InputModeEventArgs> dragDroppedEvent)` Removes the given listener for the `DragDropped` event that occurs when a drag operation is dropped onto the `CanvasControl` into which this instance is installed.
`void`	`removeDragEnteredListener(IEventHandler<InputModeEventArgs> dragEnteredEvent)` Removes the given listener for the `DragEntered` event that occurs when a drag operation enters the `CanvasControl` into which this instance is installed.
`void`	`removeDragLeftListener(IEventHandler<InputModeEventArgs> dragLeftEvent)` Removes the given listener for the `DragLeft` event that occurs when a drag operation leaves the `CanvasControl` into which this instance is installed.
`void`	`removeDragOverListener(IEventHandler<InputModeEventArgs> dragOverEvent)` Removes the given listener for the `DragOver` event that occurs when a drag operation drags over the `CanvasControl` into which this instance is installed.
`void`	`setCapturingMouseInputDuringDragEnabled(boolean value)` Sets a value indicating whether to capture mouse input during drag operations.
`protected void`	`setDragLocation(PointD location)` This method updates the `MousePosition` according to the coordinates passed in.
`void`	`setDropDataMap(Map dropDataMap)` Sets the map that maps a drop id to in instance of the type this `DropInputMode` was created for.
`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`	`setPriority(int value)` The priority of this input mode.
`void`	`setTransferMode(TransferMode... value)` Sets the `TransferMode` that will be used for drags on the canvas.
`void`	`setValidDropHitTestable(IHitTestable value)` Sets the `IHitTestable` that determines whether the given location is a valid drop location.
`boolean`	`stop()` Overridden to only return `true` if this instance does not currently `have the input mutex`.
`void`	`uninstall(IInputModeContext context)` Uninstalls this mode from the canvas.

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

- Field Detail
  - DATA_FORMAT_DROP_ID
```
public static final DataFormat DATA_FORMAT_DROP_ID
```
- Constructor Detail
  - DropInputMode
```
public DropInputMode(Class expectedType)
```
    Constructs a new instance of class DropInputMode for the expected type of data.
    The input mode fires events (see DragEntered and DragDropped) only if a drag operation carries data conforming to the given type.
    
    Parameters:
    
    expectedType - This is a type which can be given to DragDropData#getData(Class).
- Method Detail
  - addDragDroppedListener
```
public final void addDragDroppedListener(IEventHandler<InputModeEventArgs> dragDroppedEvent)
```
    Adds the given listener for the DragDropped event that occurs when a drag operation is dropped onto the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragDroppedEvent - The listener to add.
    
    See Also:
    
    removeDragDroppedListener(IEventHandler)
  - addDragEnteredListener
```
public final void addDragEnteredListener(IEventHandler<InputModeEventArgs> dragEnteredEvent)
```
    Adds the given listener for the DragEntered event that occurs when a drag operation enters the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragEnteredEvent - The listener to add.
    
    See Also:
    
    removeDragEnteredListener(IEventHandler)
  - addDragLeftListener
```
public final void addDragLeftListener(IEventHandler<InputModeEventArgs> dragLeftEvent)
```
    Adds the given listener for the DragLeft event that occurs when a drag operation leaves the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragLeftEvent - The listener to add.
    
    See Also:
    
    removeDragLeftListener(IEventHandler)
  - addDragOverListener
```
public final void addDragOverListener(IEventHandler<InputModeEventArgs> dragOverEvent)
```
    Adds the given listener for the DragOver event that occurs when a drag operation drags over the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragOverEvent - The listener to add.
    
    See Also:
    
    removeDragOverListener(IEventHandler)
  - adjustTransferMode
```
protected boolean adjustTransferMode(DragEvent e)
```
    Callback that adjusts the transfer mode accordingly.
    
    Parameters:
    
    e -
  - cancel
```
public void cancel()
```
    Cleanly cancels this mode.
    
    Specified by:
    
    cancel in interface IInputMode
  - 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.
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getDropData
```
public Object getDropData()
```
    Gets the data carried by a drag operation.
    This is only valid, if a drag entered the CanvasControl first.
    
    Returns:
    
    The DropData.
  - getDropData
```
protected Object getDropData(Dragboard dragboard)
```
    Gets the data carried by the drag operation. This method is called by getDropData() with the current Dragboard as argument. The dragboard is set after a DragEvent.DRAG_ENTERED event on the CanvasControl occurs and updated for a DragEvent.DRAG_DROPPED event that follows if an transfermode is set.
    
    Parameters:
    
    dragboard - the dragboard that may contain the object that represents the drop data. This argument may be null.
    
    Returns:
    
    the data carried by the drag operation associated with the given drag board.
  - getDropDataMap
```
public Map getDropDataMap()
```
    Returns the map that maps a drop id to in instance of the type this DropInputMode was created for.
  - getDropLocation
```
public final PointD getDropLocation()
```
    Gets the mouse position after dropping an item.
    The position is returned in world coordinates according to the CanvasControl into which this input mode is installed.
    
    Returns:
    
    The DropLocation.
  - getExpectedType
```
protected final Class getExpectedType()
```
    Returns the type of data this DropInputMode instance can handle.
  - 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.
  - getLastDragEvent
```
public final DragEvent getLastDragEvent()
```
    Gets the last processed drag event argument.
    
    Returns:
    
    The LastDragEventArgs.
  - getMousePosition
```
public final IPoint getMousePosition()
```
    Gets the current mouse position during drag operations.
    The position is returned in world coordinates according to the CanvasControl into which this input mode is installed.
    
    Returns:
    
    The MousePosition.
  - 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.
  - getTransferMode
```
public final TransferMode[] getTransferMode()
```
    Gets the TransferMode that will be used for drags on the canvas.
    
    Returns:
    
    The TransferMode.
    
    See Also:
    
    setTransferMode(javafx.scene.input.TransferMode...)
  - getValidDropHitTestable
```
public final IHitTestable getValidDropHitTestable()
```
    Gets the IHitTestable that determines whether the given location is a valid drop location.
    
    Returns:
    
    The hit testable that yields true for valid drop locations.
    
    See Also:
    
    setValidDropHitTestable(IHitTestable)
  - install
```
public void install(IInputModeContext context,
                    ConcurrencyController controller)
```
    Installs this mode into the given canvas.
    Clients should not call this method as this is handled by the framework.
    
    Specified by:
    
    install in interface IInputMode
    
    Parameters:
    
    context - the context to install this mode into
    
    controller - The Controller for this mode.
    
    See Also:
    
    CanvasControl
  - isCapturingMouseInputDuringDragEnabled
```
public final boolean isCapturingMouseInputDuringDragEnabled()
```
    Gets a value indicating whether to capture mouse input during drag operations.
    The default is true and thus prevents mouse events from being processed by visuals in the canvas.
    
    Returns:
    
    true if mouse input should be captured during the drag; false otherwise.
    
    See Also:
    
    setCapturingMouseInputDuringDragEnabled(boolean)
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enabled state of this input mode.
    Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.
    
    Returns:
    
    The Enabled.
    
    See Also:
    
    setEnabled(boolean)
  - isExclusive
```
public final boolean isExclusive()
```
    Gets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Returns:
    
    The Exclusive.
    
    See Also:
    
    setExclusive(boolean)
  - onCanceled
```
protected void onCanceled()
```
    Called after cancel() has been called.
    Can be overridden in subclasses to perform additional actions after the mode has been canceled.
    
    This implementation does nothing.
  - onConcurrencyControllerActivated
```
protected void onConcurrencyControllerActivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to true.
    Can be overridden in subclasses to perform additional actions after the mode has been activated.
    
    Overriding implementations should call the base implementation.
  - onConcurrencyControllerDeactivated
```
protected void onConcurrencyControllerDeactivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to false.
    Can be overridden in subclasses to perform additional actions after the mode has been deactivated.
    
    Overriding implementations should call the base implementation.
  - onDragDropped
```
protected void onDragDropped(InputModeEventArgs eventArgs)
```
    Called once a drag has been dropped on the canvas.
  - onDragEntered
```
protected void onDragEntered(InputModeEventArgs eventArgs)
```
    Called once a drag has entered the canvas.
  - onDragExited
```
protected void onDragExited(InputModeEventArgs eventArgs)
```
    Called once a drag has left the canvas.
  - onDraggedOver
```
protected void onDraggedOver(InputModeEventArgs eventArgs)
```
    Called whenever a drag is over the canvas.
  - 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.
  - removeDragDroppedListener
```
public final void removeDragDroppedListener(IEventHandler<InputModeEventArgs> dragDroppedEvent)
```
    Removes the given listener for the DragDropped event that occurs when a drag operation is dropped onto the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragDroppedEvent - The listener to remove.
    
    See Also:
    
    addDragDroppedListener(IEventHandler)
  - removeDragEnteredListener
```
public final void removeDragEnteredListener(IEventHandler<InputModeEventArgs> dragEnteredEvent)
```
    Removes the given listener for the DragEntered event that occurs when a drag operation enters the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragEnteredEvent - The listener to remove.
    
    See Also:
    
    addDragEnteredListener(IEventHandler)
  - removeDragLeftListener
```
public final void removeDragLeftListener(IEventHandler<InputModeEventArgs> dragLeftEvent)
```
    Removes the given listener for the DragLeft event that occurs when a drag operation leaves the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragLeftEvent - The listener to remove.
    
    See Also:
    
    addDragLeftListener(IEventHandler)
  - removeDragOverListener
```
public final void removeDragOverListener(IEventHandler<InputModeEventArgs> dragOverEvent)
```
    Removes the given listener for the DragOver event that occurs when a drag operation drags over the CanvasControl into which this instance is installed.
    No event is raised
    - if this instance is not Enabled,
    - if another concurrent input mode is active or
    - the data from the drag operation does not conform to the expected format.
    To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The IEventArgs provide no useful data.
    Parameters:
    
    dragOverEvent - The listener to remove.
    
    See Also:
    
    addDragOverListener(IEventHandler)
  - setCapturingMouseInputDuringDragEnabled
```
public final void setCapturingMouseInputDuringDragEnabled(boolean value)
```
    Sets a value indicating whether to capture mouse input during drag operations.
    The default is true and thus prevents mouse events from being processed by visuals in the canvas.
    
    Parameters:
    
    value - true if mouse input should be captured during the drag; false otherwise.
    
    See Also:
    
    isCapturingMouseInputDuringDragEnabled()
  - setDragLocation
```
protected void setDragLocation(PointD location)
```
    This method updates the MousePosition according to the coordinates passed in.
    It is called prior to the onDragEntered(InputModeEventArgs), onDraggedOver(InputModeEventArgs), onDragDropped(InputModeEventArgs) and onDragExited(InputModeEventArgs) methods.
    
    Parameters:
    
    location - The current location of the mouse in world coordinates.
  - setDropDataMap
```
public void setDropDataMap(Map dropDataMap)
```
    Sets the map that maps a drop id to in instance of the type this DropInputMode was created for.
    
    Parameters:
    
    dropDataMap - The mapping between drop ids and drop data instances.
  - 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()
  - 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()
  - setTransferMode
```
public final void setTransferMode(TransferMode... value)
```
    Sets the TransferMode that will be used for drags on the canvas.
    
    Parameters:
    
    value - The TransferMode to set.
    
    See Also:
    
    getTransferMode()
  - setValidDropHitTestable
```
public final void setValidDropHitTestable(IHitTestable value)
```
    Sets the IHitTestable that determines whether the given location is a valid drop location.
    
    Parameters:
    
    value - The hit testable that yields true for valid drop locations.
    
    See Also:
    
    getValidDropHitTestable()
  - stop
```
public boolean stop()
```
    Overridden to only return true if this instance does not currently have the input mutex.
    
    Specified by:
    
    stop in interface IInputMode
    
    Returns:
    
    true iff this instance does not own the mutex.
    
    See Also:
    
    IInputMode.cancel()
  - uninstall
```
public void uninstall(IInputModeContext context)
```
    Uninstalls this mode from the canvas.
    Clients should not call this method as this is handled by the framework.
    
    Specified by:
    
    uninstall in interface IInputMode
    
    Parameters:
    
    context - the context

Class DropInputMode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATA_FORMAT_DROP_ID

Constructor Detail

DropInputMode

Method Detail

addDragDroppedListener

addDragEnteredListener

addDragLeftListener

addDragOverListener

adjustTransferMode

cancel

createInputModeEventArgs

getController

getDropData

getDropData

getDropDataMap

getDropLocation

getExpectedType

getInputModeContext

getLastDragEvent

getMousePosition

getPriority

getTransferMode

getValidDropHitTestable

install

isCapturingMouseInputDuringDragEnabled

isEnabled

isExclusive

onCanceled

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onDragDropped

onDragEntered

onDragExited

onDraggedOver

onStopped

removeDragDroppedListener

removeDragEnteredListener

removeDragLeftListener

removeDragOverListener

setCapturingMouseInputDuringDragEnabled

setDragLocation

setDropDataMap

setEnabled

setExclusive

setPriority

setTransferMode

setValidDropHitTestable

stop

uninstall