C

ItemDropInputMode<T>
abstract

Show Usages
A DropInputMode providing a preview of the dragged item.
Implements
Inheritance Hierarchy

Remarks

This input mode can visualize a preview of the draggedItem during the drag operation, and supports snapping via the snapContext and highlighting of the dropTarget via a HighlightIndicatorManager<T>.

Type Parameters

T

See Also

Developer's Guide

Members

Show:

Constructors

ItemDropInputMode

(transferType: string)
protected
Initializes a new instance of the ItemDropInputMode<T> class for the given data type.
This instance fires events only if a drag operation carries data of the given type.
protected

Parameters

transferType: string
A list of types that are used in getData.

Properties

capturePointerInputDuringDrag

: boolean
Gets or sets a value indicating whether to capture pointer input during drag operations.
The default is true and thus prevents pointer events from being processed by visuals in the canvas.
final

Property Value

true if pointer input should be captured during the drag; false otherwise.

controller

: ConcurrencyController
protectedreadonly
Gets the installed controller.
protectedreadonlyfinal

disableSnappingRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to disable snapping temporarily.
final

Property Value

The disable snapping recognizer. The default recognizer checks for a pressed using CONTROL_KEY.

dragDropEffect

: DragDropEffects
Gets or sets the DragDropEffects that will be used for drags on the canvas.
conversionfinal

draggedItem

: T
protectedreadonly
Gets the currently dragged item.
This implementation simply tries to cast the dropData to the type of the dragged items.
protectedreadonly

dropData

: any
readonly
Gets the data carried by a drag operation.
This is only valid, if a drag entered the CanvasComponent first.
readonly

dropLocation

: Point
readonly
Gets the pointer position after dropping an item.
The position is returned in world coordinates according to the CanvasComponent into which this input mode is installed.
readonlyfinal

dropTarget

: IModelItem
Gets the drop target at snappedPointerPosition
final

See Also

API
highlightDropTarget

enabled

: boolean
Gets or 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.

Examples

Disabling the NodeDropInputMode on its parent input mode
mode.nodeDropInputMode.enabled = false

exclusive

: boolean
Gets or 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.

final

highlightDropTarget

: boolean
Gets or sets whether the drop target is highlighted.
final

See Also

Developer's Guide

isDragging

: boolean
readonly
Gets a value indicating whether a drag operation is currently in progress.
readonlyfinal

itemCreator

: function(IInputModeContext, IGraph, any, IModelItem, Point): T
Gets or sets the callback for item creation.
Called by method onDragDropped.
final

See Also

Developer's Guide

lastDragEventArgs

: DragEventArgs
readonly
Gets the last processed drag event argument.
readonlyfinal

parentInputModeContext

: IInputModeContext
protectedreadonly
Retrieves the IInputModeContext this mode has been installed in.
The value will be null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.
protectedreadonlyfinal

pointerPosition

: IPoint
readonly
Gets the current pointer position during drag operations.
The position is returned in world coordinates according to the CanvasComponent into which this input mode is installed.
readonlyfinal

previewGraph

: IGraph
protectedreadonly
Gets the graph displayed as item preview.
protectedreadonlyfinal

Property Value

The preview graph or null if no preview is displayed at the moment.

See Also

Developer's Guide

priority

: number
Gets the priority of this input mode.
The priority will influence the order in which the modes will be installed into the CanvasComponent. The lower the priority value, the earlier it will be installed. If two modes are using the same priority value, the first one to be registered will be installed earlier.
final

showPreview

: boolean
Gets or sets whether a preview of the dragged element is displayed during the drag.
final

See Also

Developer's Guide

snapContext

: GraphSnapContext
Gets or sets the GraphSnapContext which is used to snap the dragged element during the drag.
If set to null (the default), this input mode tries to obtain the GraphSnapContext from the IInputModeContext. To explicitly disable snapping, a GraphSnapContext implementation that is disabled needs to be set.
final

See Also

Developer's Guide

snappedPointerPosition

: Point
readonly
Gets the current snapped pointer position during drag operations.
The position is returned in world coordinates according to the CanvasComponent into which this input mode is installed. If snappingEnabled is false, this value corresponds with pointerPosition.
readonlyfinal

snappingEnabled

: boolean
Gets or sets whether dragged items are snapped.
final

See Also

Developer's Guide

validDropHitTestable

: IHitTestable
Gets or sets the IHitTestable that determines whether the given location is a valid drop location.
final

Property Value

The hit testable that yields true for valid drop locations.

See Also

Developer's Guide

Methods

addEventListener

(
type: string
listener: function(evt:EventArgs, sender:this): void
options?: ListenerOptions
)
Adds an event handler for a given event type.
final

Parameters

type: string
A string which represents the type of the event to register as listed in events.
listener: function(evt:EventArgs, sender:this): void
The function which will be invoked when the event is raised.
options?: ListenerOptions
Options which specify how the listener will be invoked.

adjustEffect

(evt: DragEventArgs): boolean
protected
Called to adjust the dropEffect accordingly.
protected

Parameters

evt: DragEventArgs
The event args of the drag event to adjust the effects for.

Return Value

boolean
true if the drag event is handled by this input mode.

cancel

()
Cleanly cancels this mode.

cleanUp

()
protected
Cleanup method that calls cleanUpSnapContext, cleanUpPreview and cleanUpDropTarget.
This method should be called for cleanup actions after a drag/drop gesture has been finished or canceled.
protected

cleanUpDropTarget

()
protected
Cleans up the drop target and its highlighting.

cleanUpPreview

()
protected
Cleans up the item preview.
protected

See Also

Developer's Guide

cleanUpSnapContext

()
protected
Cleans up the snap context.

collectSnapResults

(evt: CollectSnapResultsEventArgs, source: any)
protected
Callback registered on the SnapContext that collects SnapResults for the dragged element.
The default implementation doesn't collect any snap results.
protected

Parameters

evt: CollectSnapResultsEventArgs
The arguments describing the movement SnapResults shall be collected for.
source: any
The SnapContext this callback is registered at.

createInputModeContext

(): IInputModeContext
protected
Creates an implementation of IInputModeContext that is specific to this mode.

This is needed for events that are triggered by this InputMode to signalize where the event is coming from. A common usage for this is for example in isHit calls.

The result can be given to isHit or enumerateHits to let implementations of IHitTestable get access to the current IInputModeContext. This can be done by looking up IInputModeContext from the ICanvasContext's lookup method or simply downcasting.

protected

Return Value

createInputModeEventArgs

(): InputModeEventArgs
protected
Helper method that yields a suitably configured InputModeEventArgs for this input mode.
protected

Return Value

InputModeEventArgs
An input mode event argument that is configured for this instance.

getDropTarget

(dragLocation: Point): IModelItem
protected
Returns the drop target at the specified location.
The drop target is highlighted, if highlightDropTarget is enabled. By default, null is returned.
protected

Parameters

dragLocation: Point
The location to return the drop target for.

Return Value

IModelItem
The drop target at the specified location or null if no drop target can be found.

initializeDropTarget

()
protected
Initializes the drop target.

initializePreview

()
protected
Initializes the item preview.
This method is called by onDragEntered. If a preview shall be displayed, the previewGraph is initialized and populatePreviewGraph is called.
protected

See Also

Developer's Guide

initializeSnapContext

()
protected
Initializes the snapping context.
This method is called by onDragEntered
protected

install

(context: IInputModeContext, controller: ConcurrencyController)
Installs this mode into the given canvas.
Clients should not call this method as this is handled by the framework.

Parameters

context: IInputModeContext
the context to install this mode into
controller: ConcurrencyController
The controller for this mode.

See Also

API
CanvasComponent

onCanceled

()
protected
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.

protected

onConcurrencyControllerActivated

()
protected
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.

protected

onConcurrencyControllerDeactivated

()
protected
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.

protected

onDragDropped

(evt: InputModeEventArgs)
protected
Called once a drag has been dropped on the canvas.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragEntered

(evt: InputModeEventArgs)
protected
Called once a drag has entered the canvas.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDraggedOver

(evt: InputModeEventArgs)
protected
Called whenever a drag is over the canvas.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragLeft

(evt: InputModeEventArgs)
protected
Called once a drag has left the canvas.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onItemCreated

(evt: InputModeItemEventArgs<T>)
protected
Called whenever a new item is created.
protected

Parameters

onStopped

()
protected
Called after tryStop has been called.

Can be overridden in subclasses to perform additional actions after the mode has been stopped.

This implementation does nothing.

protected

populatePreviewGraph

(previewGraph: IGraph)
protected
Subclasses shall fill the specified graph that is used to preview the dragged item.
protected

Parameters

previewGraph: IGraph
The preview graph to fill.

See Also

Developer's Guide

removeEventListener

(
type: string
listener: function(evt:EventArgs, sender:this): void
options?: ListenerOptions
)
Adds an event handler for a given event type.
final

Parameters

type: string
A string which represents the type of the event to register as listed in events.
listener: function(evt:EventArgs, sender:this): void
The function which will be invoked when the event is raised.
options?: ListenerOptions
Options which specify how the listener will be invoked.

setDragLocation

(location: Point)
protected
Sets the drag location and calls updatePreview to update the layout of item preview based on the pointer coordinates and the results of the snapContext.
protected

Parameters

location: Point
The current location of the pointer in world coordinates.

tryStop

(): boolean
Overridden to only return true if this instance does not currently have the input mutex.

Return Value

boolean
true iff this instance does not own the mutex.

uninstall

(context: IInputModeContext)
Uninstalls this mode from the canvas.
Clients should not call this method as this is handled by the framework.

Parameters

context: IInputModeContext
the context

updateDropTarget

(dragLocation: Point)
protected
Calls getDropTarget for snappedPointerPosition and sets the returned item as dropTarget.
If highlightDropTarget is enabled, the highlight is updated as well.
protected

Parameters

dragLocation: Point
The location to update the drop target for.

updatePreview

(previewGraph: IGraph, dragLocation: Point)
protected
Subclasses shall update the previewGraph so the dragged item is displayed at the specified dragLocation.
protected

Parameters

previewGraph: IGraph
The preview graph to update.
dragLocation: Point
The current drag location.

See Also

Developer's Guide

Events

'drag-dropped'

: InputModeEventArgs
Occurs when a drag operation is dropped onto the CanvasComponent 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 type.

To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.

context: IInputModeContext
final
Gets the context for the current event.

See Also

Developer's Guide

'drag-entered'

: InputModeEventArgs
Occurs when a drag operation enters the CanvasComponent 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 type.

To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.

context: IInputModeContext
final
Gets the context for the current event.

See Also

Developer's Guide

'drag-left'

: InputModeEventArgs
Occurs when a drag operation leaves the CanvasComponent 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 type.

To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.

context: IInputModeContext
final
Gets the context for the current event.

See Also

Developer's Guide

'drag-over'

: InputModeEventArgs
Occurs when a drag operation drags over the CanvasComponent 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 type.

To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.

context: IInputModeContext
final
Gets the context for the current event.

See Also

Developer's Guide

'item-created'

: InputModeItemEventArgs<T>
Occurs when a new item gets created by this input mode.
context: IInputModeContext
final
Gets the context for the current event.
item: TModelItem
final
Gets the item which has been created or changed.