ReparentStripeInputMode

ReparentStripeInputMode

Implemented Interfaces

Remarks

This implementation delegates most work to an instance of ReparentStripePositionHandler

Type Details

yfiles module: view-table
yfiles-umd modules: view-table, view
Legacy UMD name: yfiles.input.ReparentStripeInputMode

Constructors

ReparentStripeInputMode

()

Initializes a new instance of the ReparentStripeInputMode class.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

enabled - boolean

The enabled state of this input mode. This option sets the enabled property on the created object.

priority - number

exclusive - boolean

A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.

disableSnappingRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to temporarily disable snapping. This option sets the disableSnappingRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

enableSnappingRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to reenable temporarily disabled snapping. This option sets the enableSnappingRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

pressedRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to start moving the selection. This option sets the pressedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

hoverRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to the user is hovering over an item where pressing can initialize a move operation. This option sets the hoverRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

draggedRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to move the selection. This option sets the draggedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

cancelRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to cancel the move. This option sets the cancelRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

releasedRecognizer - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish moving the selection. This option sets the releasedRecognizer property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

pressedRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to start moving the selection via touch. This option sets the pressedRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

draggedRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to move the selection via touch. This option sets the draggedRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

releasedRecognizerTouch - function(Object, EventArgs):boolean

The event recognizer that determines whether to finish moving the selection via touch. This option sets the releasedRecognizerTouch property on the created object.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

hitTestable - IHitTestable

The IHitTestable that will be used by this mode to determine where the user may start dragging. This option sets the hitTestable property on the created object.

positionHandler - IPositionHandler

The IPositionHandler that will be used as fallback to handle that actual movement of the elements during the drag. This option sets the positionHandler property on the created object.

validBeginCursor - Cursor

The cursor to use while hovering above items that may be moved. This option sets the validBeginCursor property on the created object.

moveCursor - Cursor

The cursor to use while moving items. This option sets the moveCursor property on the created object.

snapContext - SnapContext

The snapContext which manages snapping model items to certain coordinates (for instance, other items). This option sets the snapContext property on the created object.

Properties

affectedItems

: IEnumerable<IModelItem>

Gets an immutable snapshot of the IModelItems affected by the currently active gesture.

Remarks

When the gesture is starting and the positionHandler is initialized, the implementation can register the affected item(s) through the IModelItemCollector instance that is bound to the context available via its lookup.

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.

Examples

If one needs to execute some code after some items have been moved by the MoveInputMode he can register a handler to its DragFinished event. The moved items can be retrieved from the affectedItems property:

mode.moveInputMode.addDragFinishedListener((sender, args) => {
  for (const item of mode.moveInputMode.affectedItems) {
    // these items have been moved
  }
})

Defined in

cancelRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to cancel the move.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

controller

: ConcurrencyController

Gets the installed controller.

Defined in

disableSnappingRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to temporarily disable snapping.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

draggedRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to move the selection.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

draggedRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to move the selection via touch.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

enabled

: boolean

Gets or sets the enabled state of this input mode.

Remarks

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 MoveInputMode on its parent input mode

mode.moveInputMode.enabled = false

Defined in

enableSnappingRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to reenable temporarily disabled snapping.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

exclusive

: boolean

Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.

Remarks

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.

Defined in

hitTestable

: IHitTestable

Gets or sets the IHitTestable that will be used by this mode to determine where the user may start dragging.

Defined in

hoverRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to the user is hovering over an item where pressing can initialize a move operation.

Remarks

The default implementation uses the isValidStartLocation method to determine whether the mode can be initialized, here.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

initialLocation

: Point

Gets the initial position where the dragging was initiated.

Defined in

inputModeContext

: IInputModeContext

Gets the context instance this mode is currently installed in or null if this instance is not installed.

Remarks

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.

Implements

isDragging

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

pressedRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to start moving the selection via touch.

Remarks

This recognizer instance determines when the user begins the move selection operation.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

priority

: number

Gets the priority of this input mode.

Remarks

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.

Implements

releasedRecognizer

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish moving the selection.

Remarks

This instance determines when the user has finished the move.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

releasedRecognizerTouch

: function(any, EventArgs):boolean

Gets or sets the event recognizer that determines whether to finish moving the selection via touch.

Signature Details

function(eventSource: any, evt: EventArgs) : boolean

A callback that recognizes events.

Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.

Parameters

eventSource - any: The source of the event.
evt - EventArgs: The arguments of the event to be decided to handle.

Returns

boolean: true if the evt is considered to be handled.

Defined in

snapContext

: SnapContext

Gets or sets the snapContext which manages snapping model items to certain coordinates (for instance, other items).

Remarks

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.

Default is null.

Defined in

validBeginCursor

: Cursor

Gets or sets the cursor to use while hovering above items that may be moved.

Remarks

The default cursor is MOVE.

Defined in

Methods

arm

()

Called when this mode is "armed".

Remarks

This happens when the mouse hovers over the item(s) to move. This implementation sets the mouse cursor to validBeginCursor.

Defined in

cancel

()

Cancels the editing of this mode.

Remarks

This implementation releases the mutex if it is currently owned by this instance and calls onCanceled.

Implements

createPositionHandlerInputModeContext

() : IInputModeContext

Creates an IInputModeContext for use with the IPositionHandler interface for the upcoming drag operation.

Returns

↪IInputModeContext: An instance of IInputModeContext.

Defined in

disarm

()

Called when this mode is "disarmed".

Remarks

This happens when the mouse stops hovering over the item(s). This implementation resets the mouse cursor again.

Defined in

doStartDrag

(location: Point) : Promise<IEnumerable<IModelItem>>

Simulates the start of a drag and puts the state machine into the dragging state.

Remarks

Subsequent moves of input devices will behave as if the dragging has been successfully initiated at location.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The location where the drag had been initialized.

Returns

↪Promise<IEnumerable<IModelItem>>: A task that represents the asynchronous drag operation. The result of the task contains the affected items or null if the drag was canceled.

Defined in

install

(context: IInputModeContext, controller: ConcurrencyController)

Installs this mode into the given context that is provided by the canvas.

Remarks

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.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried during the time the mode is installed.
controller - ConcurrencyController: The controller for this mode.

Implements

MoveInputMode.onDragFinished

isValidStartLocation

(location: Point) : boolean

Determines whether the given location is a valid start location for the move gesture.

Remarks

This implementation delegates to the hitTestable. During this callback it is possible to reset or reconfigure the positionHandler.

Parameters

options - Object
A map of options to pass to the method.

location - Point: The location in the world coordinate system.

Returns

↪boolean: true if at the given location it is valid to start the move gesture; otherwise, false.

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Overrides

onDragFinishing

Called before the drag will be finalized.

Remarks

This method triggers the DragFinishing event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Defined in

onDragged

Called at the end of each drag.

Remarks

This method triggers the Dragged event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Defined in

onDragging

Called at the start of each drag.

Remarks

This method triggers the Dragging event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Defined in

onDragStarted

Triggers the DragStarted event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Defined in

onDragStarting

MoveInputMode.onDragStarting

Triggers the DragStarting event.

Parameters

options - Object
A map of options to pass to the method.

evt - InputModeEventArgs: The event argument that contains context information.

Overrides

onQueryPositionHandler

(evt: QueryPositionHandlerEventArgs)

Raises the QueryPositionHandler event.

Parameters

options - Object
A map of options to pass to the method.

evt - QueryPositionHandlerEventArgs: The QueryPositionHandlerEventArgs instance containing the event data.

Defined in

onStopped

()

Called after tryStop has been called.

Remarks

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

This implementation does nothing.

Defined in

tryStop

() : boolean

Called by the client in order to stop a current editing progress.

Remarks

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

Returns

↪boolean: true if and only if the editing has been stopped or there was no edit in progress

Implements

uninstall

(context: IInputModeContext)

Uninstalls this mode from the given context.

Remarks

This code should clean up all changes made to the canvas in the install method. After a mode has been uninstalled it can be installed again into the same or another canvas.

Overriding implementations should call the base implementation after their own code.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext: The context to deregister from. This is the same instance that had been passed to install during installation.

Implements

Events

DragCanceled

Occurs when the drag has been canceled.

Defined in

Event Registration

addDragCanceledListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragCanceledListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

DragCanceling

Occurs before the drag will be canceled.

Defined in

Event Registration

addDragCancelingListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragCancelingListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

DragFinished

Occurs once the drag has been finished.

Examples

mode.moveInputMode.addDragFinishedListener((sender, args) => {
  for (const item of mode.moveInputMode.affectedItems) {
    // these items have been moved
  }
})

Defined in

Event Registration

addDragFinishedListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragFinishedListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

DragFinishing

Occurs before the drag will be finished.

Defined in

Event Registration

addDragFinishingListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragFinishingListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

Dragged

Occurs at the end of every drag.

Defined in

Event Registration

addDraggedListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDraggedListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

Dragging

Occurs at the start of every drag.

Defined in

Event Registration

addDraggingListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDraggingListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

DragStarted

Occurs once the drag is initialized and has started.

Defined in

Event Registration

addDragStartedListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragStartedListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

DragStarting

Occurs once the drag is starting.

Defined in

Event Registration

addDragStartingListener(function(this, InputModeEventArgs):void)

Event Deregistration

removeDragStartingListener(function(this, InputModeEventArgs):void)

Signature Details

function(sender: this, evt: InputModeEventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - InputModeEventArgs: An object that contains the event data.

QueryPositionHandler

Occurs when a drag is recognized for the MoveInputMode.

Remarks

If the event args are handled, the IPositionHandler that is carried with the event args is used to actually move the items. Otherwise the pre-set positionHandler property is used.

Defined in