C

ResizeStripeInputMode

Show Usages
Specialized input mode that is used to resize a stripe by dragging one of its borders.
ImplementsInheritance Hierarchy

Remarks

By default, adjacent stripes are moved. To redistribute the space instead, use resizeNeighborsRecognizer. Also, by default the content of the stripes is either moved or constrains the minimum available sizes for the stripe resize operations. To completely ignore all content nodes, use ignoreContentRecognizer.

This mode is exclusive by default.

See Also

Developer's Guide

Members

Show:

Constructors

ResizeStripeInputMode

()
Creates a new instance of this input mode.

Parameters

Properties

beginRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to start resizing the stripe.
final

Property Value

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

beginRecognizerTouch

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to start resizing the stripe via TOUCH input.
final

Property Value

The default recognizer is TOUCH_PRIMARY_LONG_PRESS.

cancelRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to cancel the resize operation.
final

Property Value

The default recognizer detects CANCEL and DRAG_CAPTURE_LOST, or ESCAPE_DOWN events.

columnInvalidEndCursor

: Cursor
Gets or sets the cursor to use when a column cannot be resized to current mouse position.
The default value is NOT_ALLOWED
conversionfinal

columnResizeCursor

: Cursor
Gets or sets the cursor to use while resizing columns.
The default value is COL_RESIZE
conversionfinal

columnValidBeginCursor

: Cursor
Gets or sets the cursor to use while hovering over the border of a column that may be resized.
The default value is COL_RESIZE
conversionfinal

controller

: ConcurrencyController
protectedreadonly
Gets the installed controller.
protectedreadonlyfinal

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.

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

finishRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to finish resizing the stripe.
final

Property Value

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

finishRecognizerTouch

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to finish resizing the stripe via TOUCH input.
final

Property Value

The default recognizer is TOUCH_PRIMARY_UP.

ignoreContentRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to ignore the content of all stripes instead of moving them or considering for minimum sizes.

If this recognizer recognizes its gesture, the behavior will be to completely ignore all stripe contents.

The default detects the current platform and delegates either to META_IS_DOWN (macOS) or CTRL_IS_DOWN (other platforms).

final

Property Value

The default recognizer is CTRL_IS_DOWN.

isDragging

: boolean
readonly
Gets a value indicating whether a drag operation is currently in progress.
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

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

resizeNeighborsRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to resize adjacent stripes instead of moving them.
final

Property Value

The default recognizer is SHIFT_IS_DOWN.

resizeRecognizer

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to change the stripe size.
final

Property Value

The default recognizer is MOUSE_DRAG.

resizeRecognizerTouch

: function(EventArgs, unknown): boolean
Gets or sets the event recognizer that determines whether to change the stripe size via TOUCH input.
final

Property Value

The default recognizer is TOUCH_PRIMARY_DRAG.

rowInvalidEndCursor

: Cursor
Gets or sets the cursor to use when a row cannot be resized to current mouse position.
The default value is NOT_ALLOWED
conversionfinal

rowResizeCursor

: Cursor
Gets or sets the cursor to use while resizing rows.
The default value is ROW_RESIZE
conversionfinal

rowValidBeginCursor

: Cursor
Gets or sets the cursor to use while hovering over the border of a row that may be resized.
The default value is ROW_RESIZE
conversionfinal

Methods

cancel

()
Cancels the editing of this mode.
This implementation releases the mutex if it is currently owned by this instance and calls onCanceled.

See Also

API
onCanceled

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 signal 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

IInputModeContext
A readily configured IInputModeContext.

See Also

API
enumerateHits, isHit, IInputModeContext

install

(context: IInputModeContext, controller: ConcurrencyController)
Installs this mode into the given context that is provided by the canvas.

In general a mode can only be installed into a single canvas at all times.

This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.

Overriding implementations should call the base implementation first.

Parameters

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.

See Also

API
uninstall

isValidBeginLocation

(location: Point): boolean
protected
Called to determine whether it is valid to begin the gesture.
This implementation checks whether a stripe border has been hit at the latest PointerEventArgs.
protected

Parameters

location: Point
The event location to check.

Return Value

boolean
true iff a stripe border has been hit at the latest PointerEventArgs

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

onDragCanceled

(evt: InputModeEventArgs)
protected
Triggers the drag-canceled event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragCanceling

(evt: InputModeEventArgs)
protected
Triggers the drag-canceling event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragFinished

(evt: InputModeEventArgs)
protected
Called once the drag has been finalized.
This method triggers the drag-finished event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragFinishing

(evt: InputModeEventArgs)
protected
Called before the drag will be finalized.
This method triggers the drag-finishing event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragged

(evt: InputModeEventArgs)
protected
Called at the end of each drag.
This method triggers the dragged event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragging

(evt: InputModeEventArgs)
protected
Called at the start of each drag.
This method triggers the dragging event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragStarted

(evt: InputModeEventArgs)
protected
Triggers the drag-started event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

onDragStarting

(evt: InputModeEventArgs)
protected
Triggers the drag-starting event.
protected

Parameters

evt: InputModeEventArgs
The event argument that contains context information.

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

tryStop

(): boolean
Will be called to request a stop of the current editing progress.
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

Return Value

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

uninstall

(context: IInputModeContext)
Uninstalls this mode from the given context.

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

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

Events

'drag-canceled'

: InputModeEventArgs
Occurs when the drag has been canceled.

Properties of

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

'drag-canceling'

: InputModeEventArgs
Occurs before the drag will be canceled.

Properties of

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

'drag-finished'

: InputModeEventArgs
Occurs once the drag has been finished.

Properties of

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

'drag-finishing'

: InputModeEventArgs
Occurs before the drag will be finished.

Properties of

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

'drag-started'

: InputModeEventArgs
Occurs once the drag is initialized and has started.

Properties of

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

'drag-starting'

: InputModeEventArgs
Occurs once the drag is starting.

Properties of

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

'dragged'

: InputModeEventArgs
Occurs at the end of every drag.

Properties of

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

'dragging'

: InputModeEventArgs
Occurs at the start of every drag.

Properties of

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