I

IReparentStripeHandler

Show Usages
Interface used for implementations that recognize, approve, and disapprove stripe reparenting gestures, as well as actually perform the reparenting.
Inheritance Hierarchy

See Also

API

ReparentStripePositionHandler

Members

No filters for this type

Methods

isValidParent

(
context: IInputModeContext
stripe: IStripe
newParent: IStripe
index: number
reparentPosition: StripeReparentPolicy
): boolean
abstract
Determines whether the provided node may be reparented to a newParent.
This method is called to determine whether a reparent operation should actually be executed.
abstract

Parameters

context: IInputModeContext
The context that provides information about the user input.
stripe: IStripe
The stripe that will be reparented.
newParent: IStripe
The potential new parent.
index: number
The index where the stripe would be reparented
reparentPosition: StripeReparentPolicy
Where to place the stripe as a result of the gesture that would be used for the reparent operation.

Return Value

boolean
Whether newParent is a valid new parent for stripe for the given index and gesture.

reparent

(
context: IInputModeContext
movedStripe: IStripe
newParent: IStripe
index: number
reparentPosition: StripeReparentPolicy
)
abstract
Performs the actual reparenting after the reparent gesture has been finalized.
Implementations should use setParent or setParent to set the parent of movedStripe to newParent.
abstract

Parameters

context: IInputModeContext
The context that provides information about the user input.
movedStripe: IStripe
The stripe that will be reparented.
newParent: IStripe
The potential new parent.
index: number
The index where the stripe should be inserted.
reparentPosition: StripeReparentPolicy
Where to place the stripe as a result of the gesture that triggered the reparent operation.

shouldReparent

(context: IInputModeContext, stripe: IStripe): boolean
abstract
Determines whether the user may detach the given stripe from its current parent in order to reparent it.
abstract

Parameters

context: IInputModeContext
The context that provides information about the user input.
stripe: IStripe
The stripe that is about to be detached from its current parent.

Return Value

boolean
Whether the stripe may be detached and reparented.

Static Methods

create

(): IReparentStripeHandler
static
Creates an implementation of the interface IReparentStripeHandler from the given definition.
The given object must contain exactly the abstract members of the IReparentStripeHandler interface. No member may be omitted and no additional members can be added. While additional custom members can later be added directly on the instance, this is discouraged.
static

Parameters

Return Value

IReparentStripeHandler
An instance of the IReparentStripeHandler interface based on the given definition.