IReparentNodeHandler

Show usages

Interface used for implementations that recognize, approve, and disapprove node reparenting gestures, as well as actually perform the reparenting.

Inheritance Hierarchy

IReparentNodeHandler

ReparentNodeHandler

Remarks

Implementations of this interface are queried from the IInputModeContext by code that wants to reparent a node. Specifically, this is used by default to reparent nodes during the dragging of nodes.

Related Programming Samples

Reparent Handler: Shows how reparenting of nodes can be customized.

Type Details

yFiles module: view

Methods

isReparentGesture

(context: IInputModeContext, node: INode) : boolean

Determines whether the current gesture that can be determined through the context is a reparent gesture.

Parameters

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

context - IInputModeContext: The context that provides information about the user input.
node - INode: The node that will possibly be reparented.

Returns

↪boolean: Whether this is a reparenting gesture.

isValidParent

(context: IInputModeContext, node: INode, newParent: INode) : boolean

Determines whether the provided node may be reparented to a newParent.

Parameters

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

context - IInputModeContext: The context that provides information about the user input.
node - INode: The node that will be reparented.
newParent - INode: The potential new parent or null. Can be a group or a non-group node.

Returns

↪boolean: Whether newParent is a valid new parent for node.

reparent

(context: IInputModeContext, node: INode, newParent: INode)

Performs the actual reparenting after the reparent gesture has been finalized.

Remarks

Implementations should set the parent of node to newParent.

Parameters

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

context - IInputModeContext: The context that provides information about the user input.
node - INode: The node that will be reparented.
newParent - INode: The potential new parent or null. Can be a group or a non-group node.

shouldReparent

(context: IInputModeContext, node: INode) : boolean

Determines whether the user may detach the given node from its current parent in order to reparent it.

Parameters

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

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

Returns

↪boolean: Whether the node may be detached and reparented.

Static Methods

create

() : IReparentNodeHandler

ParametersOptions Overload

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

isReparentGesture - function(IInputModeContext, INode):boolean: Determines whether the current gesture that can be determined through the context is a reparent gesture.
This property holds the implementation for isReparentGesture.
shouldReparent - function(IInputModeContext, INode):boolean: Determines whether the user may detach the given node from its current parent in order to reparent it.
This property holds the implementation for shouldReparent.
isValidParent - function(IInputModeContext, INode, INode):boolean: Determines whether the provided node may be reparented to a newParent.
This property holds the implementation for isValidParent.
reparent - function(IInputModeContext, INode, INode):void: Performs the actual reparenting after the reparent gesture has been finalized.
This property holds the implementation for reparent.