ReparentStripeInputMode

ReparentStripeInputMode

Implemented Interfaces

Remarks

This implementation delegates most work to an instance of ReparentStripePositionHandler

Type Details

yFiles module: view

Constructors

ReparentStripeInputMode

()

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(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

enableSnappingRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

directionalConstraintRecognizer - function(EventArgs, unknown):boolean

The event recognizer that constrains the current movement to be orthogonal or diagonal. This option sets the directionalConstraintRecognizer property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

beginRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

hoverRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

moveRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

cancelRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

finishRecognizer - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

beginRecognizerTouch - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

moveRecognizerTouch - function(EventArgs, unknown):boolean

The event recognizer that determines whether to move the selection via TOUCH input. This option sets the moveRecognizerTouch property on the created object.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

finishRecognizerTouch - function(EventArgs, unknown):boolean

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

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

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 the 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 - GraphSnapContext

The GraphSnapContext which manages snapping model items to certain coordinates (for instance, other items). This option either sets the value directly or recursively sets properties to the instance of 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 drag-started event, as well as the drag-finished event to get notified of the elements that may be or have been affected respectively by this input mode.

Property Value

A snapshot of the current collection of the items that are affected by the move operation.

Examples

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

mode.moveSelectedItemsInputMode.addEventListener('drag-finished', () => {
  for (const item of mode.moveSelectedItemsInputMode.affectedItems) {
    // these items have been moved
  }
})

Defined in

beginRecognizer

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer detects MOUSE or PEN DRAG events with the MOUSE_LEFT button.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

beginRecognizerTouch

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer is TOUCH_PRIMARY_DOWN which reacts to the user making touch contact with the main touch device. Using TOUCH_PRIMARY_LONG_PRESS allows for an intuitive alternative configuration, specifically, when panning the viewport is a more frequent use-case.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

cancelRecognizer

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer detects ESCAPE_DOWN or CANCEL and DRAG_CAPTURE_LOST events.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

controller

: ConcurrencyController?

Gets the installed controller.

Defined in

directionalConstraintRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that constrains the current movement to be orthogonal or diagonal.

Remarks

The default recognizer is SHIFT_IS_DOWN

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

disableSnappingRecognizer

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer is ALT_DOWN.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

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.moveSelectedItemsInputMode.enabled = false

Defined in

enableSnappingRecognizer

: function(EventArgs, unknown):boolean

Gets or sets the event recognizer that determines whether to re-enable temporarily disabled snapping.

Remarks

The default recognizer is ALT_UP.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

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

finishRecognizer

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer detects left-up events of mouse and stylus devices.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

finishRecognizerTouch

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer is TOUCH_PRIMARY_UP.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

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(EventArgs, unknown):boolean

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

Remarks

The default implementation uses the hitTestable to determine whether the move operation can be started at the current location.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer is MOUSE_DRAG.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

Defined in

moveRecognizerTouch

: function(EventArgs, unknown):boolean

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

Remarks

The default recognizer is TOUCH_PRIMARY_DRAG.

Signature Details

function(evt: EventArgs, eventSource: unknown) : 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

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

Returns

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

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

createInputModeContext

() : IInputModeContext

Returns the input mode context that will be passed to implementations that are called by this instance and require a context.

Returns

↪IInputModeContext: A context to use for the implementations that are called by this instance.

Defined in

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

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

onCanceled

()

Called after cancel has been called.

Remarks

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

This implementation does nothing.

Defined in

onConcurrencyControllerActivated

()

Called after the active property of the installed ConcurrencyController has been set to true.

Remarks

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

Overriding implementations should call the base implementation.

Defined in

onConcurrencyControllerDeactivated

()

Called after the active property of the installed ConcurrencyController has been set to false.

Remarks

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

Overriding implementations should call the base implementation.

Defined in

onDragCanceled

MoveInputMode.onDragCanceled

Triggers the drag-canceled event.

Parameters

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

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

Overrides

onDragCanceling

Triggers the drag-canceling event.

Parameters

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

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

Defined in

onDragFinished

MoveInputMode.onDragFinished

Called once the drag has been finalized.

Remarks

This method triggers the drag-finished event.

Parameters

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 drag-finishing 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 drag-started 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 drag-starting 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 query-position-handler 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

startDrag

(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

tryStop

() : boolean

Will be called to request a stop of the current editing progress.

Remarks

This should stop the current edit, if one is in progress, and possibly commit all pending 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

'drag-canceled'

: function(InputModeEventArgs, this):void

Occurs when the drag has been canceled.

Defined in

'drag-canceling'

: function(InputModeEventArgs, this):void

Occurs before the drag will be canceled.

Defined in