com.yworks.yfiles.view.input

Class ConstrainedDragHandler<TWrapped extends IDragHandler>

java.lang.Object

com.yworks.yfiles.view.input.ConstrainedDragHandler<TWrapped>

Type Parameters:

TWrapped - The exact type of the wrapped implementation.

All Implemented Interfaces:

IDragHandler

Direct Known Subclasses:

ConstrainedHandle, ConstrainedPositionHandler

public abstract class ConstrainedDragHandler<TWrapped extends IDragHandler>
extends Object
implements IDragHandler

A utility implementation of the IDragHandler interface that can be used to constrain the movement of an existing instance.

See Also:

ConstrainedHandle, ConstrainedPositionHandler, constrainNewLocation(IInputModeContext, PointD, PointD)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConstrainedDragHandler(TWrapped wrappedHandler) Initializes a new instance of the ConstrainedDragHandler class that delegates to the wrappedHandler.

Method Summary

Modifier and Type	Method and Description
void	cancelDrag(IInputModeContext context, PointD originalLocation) Cancels the move operation and calls onCanceled(IInputModeContext, PointD).
protected abstract PointD	constrainNewLocation(IInputModeContext context, PointD originalLocation, PointD newLocation) Callback that needs to implement the constraints for the new location.
void	dragFinished(IInputModeContext context, PointD originalLocation, PointD newLocation) Handles the finish operation and invokes onFinished(IInputModeContext, PointD, PointD).
IPoint	getLocation() Delegates to the WrappedHandler's Location property.
protected TWrapped	getWrappedHandler() Gets the wrapped handler to which calls will be ultimately delegated.
void	handleMove(IInputModeContext context, PointD originalLocation, PointD newLocation) Handles the move operation and subsequently calls onMoved(IInputModeContext, PointD, PointD).
void	initializeDrag(IInputModeContext context) Initializes the drag operation and subsequently calls onInitialized(IInputModeContext, PointD).
protected void	onCanceled(IInputModeContext context, PointD originalLocation) Called when the cancelDrag(IInputModeContext, PointD) method has been called.
protected void	onFinished(IInputModeContext context, PointD originalLocation, PointD newLocation) Called when the dragFinished(IInputModeContext, PointD, PointD) method has been called.
protected void	onInitialized(IInputModeContext context, PointD originalLocation) Called when the initializeDrag(IInputModeContext) method has been called.
protected void	onMoved(IInputModeContext context, PointD originalLocation, PointD newLocation) Called when the handleMove(IInputModeContext, PointD, PointD) operation has been performed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstrainedDragHandler

protected ConstrainedDragHandler(TWrapped wrappedHandler)

Initializes a new instance of the ConstrainedDragHandler class that delegates to the wrappedHandler.

Parameters:

wrappedHandler - The handler to wrap.

Method Detail

cancelDrag

public final void cancelDrag(IInputModeContext context,
                             PointD originalLocation)

Cancels the move operation and calls onCanceled(IInputModeContext, PointD).

Specified by:

cancelDrag in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

originalLocation - The value of the coordinate of the Location property at the time of initializeDrag(IInputModeContext).

constrainNewLocation

protected abstract PointD constrainNewLocation(IInputModeContext context,
                                               PointD originalLocation,
                                               PointD newLocation)

Callback that needs to implement the constraints for the new location.

Parameters:

context - The context in which the drag will be performed.

originalLocation - The value of the Location property at the time of initializeDrag(IInputModeContext).

newLocation - The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the Location may or may not be modified to reflect the new value.

Returns:

The constrained value of newLocation.

dragFinished

public final void dragFinished(IInputModeContext context,
                               PointD originalLocation,
                               PointD newLocation)

Handles the finish operation and invokes onFinished(IInputModeContext, PointD, PointD).

Specified by:

dragFinished in interface IDragHandler

Parameters:

context - The context to retrieve information about the drag from.

originalLocation - The value of the Location property at the time of initializeDrag(IInputModeContext).

newLocation - The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the Location may or may not be modified to reflect the new value. This is the same value as delivered in the last invocation of handleMove(IInputModeContext, PointD, PointD)

getLocation

public IPoint getLocation()

Delegates to the WrappedHandler's Location property.

Specified by:

getLocation in interface IDragHandler

Returns:

The Location.

getWrappedHandler

protected final TWrapped getWrappedHandler()

Gets the wrapped handler to which calls will be ultimately delegated.

Returns:

The wrappe handler.

handleMove

public final void handleMove(IInputModeContext context,
                             PointD originalLocation,
                             PointD newLocation)

Handles the move operation and subsequently calls onMoved(IInputModeContext, PointD, PointD).

This method will use the constrainNewLocation(IInputModeContext, PointD, PointD) callback to let subclasses constrain the movement.

Specified by:

handleMove in interface IDragHandler

Parameters:

context - The context in which the drag will be performed.

originalLocation - The value of the Location property at the time of initializeDrag(IInputModeContext).

newLocation - The coordinates in the world coordinate system that the client wants the handle to be at. Depending on the implementation the Location may or may not be modified to reflect the new value.

initializeDrag

public final void initializeDrag(IInputModeContext context)

Initializes the drag operation and subsequently calls onInitialized(IInputModeContext, PointD).

Specified by:

initializeDrag in interface IDragHandler

Parameters:

context - The context in which the drag will be performed.

onCanceled

protected void onCanceled(IInputModeContext context,
                          PointD originalLocation)

Called when the cancelDrag(IInputModeContext, PointD) method has been called.

Parameters:

context - The input mode context.

originalLocation - The original location.

onFinished

protected void onFinished(IInputModeContext context,
                          PointD originalLocation,
                          PointD newLocation)

Called when the dragFinished(IInputModeContext, PointD, PointD) method has been called.

Parameters:

context - The input mode context.

originalLocation - The original location.

newLocation - The new location.

onInitialized

protected void onInitialized(IInputModeContext context,
                             PointD originalLocation)

Called when the initializeDrag(IInputModeContext) method has been called.

Parameters:

context - The input mode context.

originalLocation - The original location.

onMoved

protected void onMoved(IInputModeContext context,
                       PointD originalLocation,
                       PointD newLocation)

Called when the handleMove(IInputModeContext, PointD, PointD) operation has been performed.

Parameters:

context - The input mode context.

originalLocation - The original location.

newLocation - The new location.