com.yworks.yfiles.view.input

Class ReparentNodeHandler

java.lang.Object

com.yworks.yfiles.view.input.ReparentNodeHandler

All Implemented Interfaces:

IReparentNodeHandler

public class ReparentNodeHandler
extends Object
implements IReparentNodeHandler

Simple default implementation of IReparentNodeHandler that treats shift key presses as reparent gestures and allows for reparenting all nodes.

Constructor Summary

Constructors

Constructor and Description
ReparentNodeHandler()

Method Summary

Modifier and Type	Method and Description
IEventRecognizer	getReparentRecognizer() Gets the IEventRecognizer that will be queried to determine whether the gesture is a reparent gesture.
boolean	isReparentGesture(IInputModeContext context, INode node) Determines whether the current gesture that can be determined through the context is a reparent gesture.
boolean	isValidParent(IInputModeContext context, INode node, INode newParent) Determines whether the provided node may be reparented to a newParent.
void	reparent(IInputModeContext context, INode node, INode newParent) Performs the actual reparenting after the reparent gesture has been finalized.
void	setReparentRecognizer(IEventRecognizer value) Sets the IEventRecognizer that will be queried to determine whether the gesture is a reparent gesture.
boolean	shouldReparent(IInputModeContext context, INode node) Determines whether the user may detach the given node from its current parent in order to reparent it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReparentNodeHandler

public ReparentNodeHandler()

Method Detail

getReparentRecognizer

public final IEventRecognizer getReparentRecognizer()

Gets the IEventRecognizer that will be queried to determine whether the gesture is a reparent gesture.

The default is IEventRecognizer.SHIFT_PRESSED

Returns:

The ReparentRecognizer.

See Also:

isReparentGesture(IInputModeContext, INode), setReparentRecognizer(IEventRecognizer)

isReparentGesture

public boolean isReparentGesture(IInputModeContext context,
                                 INode node)

Description copied from interface: IReparentNodeHandler

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

Specified by:

isReparentGesture in interface IReparentNodeHandler

Parameters:

context - The context that provides information about the user input.

node - The node that will possibly be reparented.

Returns:

Whether this is a reparenting gesture.

isValidParent

public boolean isValidParent(IInputModeContext context,
                             INode node,
                             INode newParent)

Description copied from interface: IReparentNodeHandler

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

Specified by:

isValidParent in interface IReparentNodeHandler

Parameters:

context - The context that provides information about the user input.

node - The node that will be reparented.

newParent - The potential new parent or null. Can be a group or a non-group node.

Returns:

Whether newParent is a valid new parent for node.

reparent

public void reparent(IInputModeContext context,
                     INode node,
                     INode newParent)

Description copied from interface: IReparentNodeHandler

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

Implementations should set the parent of node to newParent.

Specified by:

reparent in interface IReparentNodeHandler

Parameters:

context - The context that provides information about the user input.

node - The node that will be reparented.

newParent - The potential new parent or null. Can be a group or a non-group node.

setReparentRecognizer

public final void setReparentRecognizer(IEventRecognizer value)

Sets the IEventRecognizer that will be queried to determine whether the gesture is a reparent gesture.

The default is IEventRecognizer.SHIFT_PRESSED

Parameters:

value - The ReparentRecognizer to set.

See Also:

isReparentGesture(IInputModeContext, INode), getReparentRecognizer()

shouldReparent

public boolean shouldReparent(IInputModeContext context,
                              INode node)

Description copied from interface: IReparentNodeHandler

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

Specified by:

shouldReparent in interface IReparentNodeHandler

Parameters:

context - The context that provides information about the user input.

node - The node that is about to be detached from its current parent.

Returns:

Whether the node may be detached and reparented.