com.yworks.yfiles.view.input

Class ConstrainedReshapeHandler

java.lang.Object

com.yworks.yfiles.view.input.ConstrainedReshapeHandler

All Implemented Interfaces:

IReshapeHandler

public abstract class ConstrainedReshapeHandler
extends Object
implements IReshapeHandler

A utility implementation of the IReshapeHandler interface that can be used to constrain the reshaping of an existing instance conveniently.

See Also:

ConstrainedHandle, ConstrainedPositionHandler, constrainNewBounds(IInputModeContext, RectD, RectD)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancelReshape(IInputModeContext context, RectD originalBounds) Cancels the move operation and calls onCanceled(IInputModeContext, RectD).
protected abstract RectD	constrainNewBounds(IInputModeContext context, RectD originalBounds, RectD newBounds) Callback that needs to implement the constraints for the new bounds.
IRectangle	getBounds() Delegates to the WrappedHandler's Bounds property.
protected IReshapeHandler	getWrappedHandler() Gets the wrapped handler to which calls will be ultimately delegated.
void	handleReshape(IInputModeContext context, RectD originalBounds, RectD newBounds) Handles the reshape operation and subsequently calls onReshaped(IInputModeContext, RectD, RectD).
void	initializeReshape(IInputModeContext context) Initializes the reshape operation and subsequently calls onInitialized(IInputModeContext, RectD).
protected void	onCanceled(IInputModeContext context, RectD originalBounds) Called when the cancelReshape(IInputModeContext, RectD) method has been called.
protected void	onFinished(IInputModeContext context, RectD originalBounds, RectD newBounds) Called when the reshapeFinished(IInputModeContext, RectD, RectD) method has been called.
protected void	onInitialized(IInputModeContext context, RectD originalBounds) Called when the initializeReshape(IInputModeContext) method has been called.
protected void	onReshaped(IInputModeContext context, RectD originalBounds, RectD newBounds) Called when the handleReshape(IInputModeContext, RectD, RectD) operation has been performed.
void	reshapeFinished(IInputModeContext context, RectD originalBounds, RectD newBounds) Handles the finish operation and invokes onFinished(IInputModeContext, RectD, RectD).

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstrainedReshapeHandler

protected ConstrainedReshapeHandler(IReshapeHandler wrappedHandler)

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

Parameters:

wrappedHandler - The handler to wrap.

Method Detail

cancelReshape

public final void cancelReshape(IInputModeContext context,
                                RectD originalBounds)

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

Specified by:

cancelReshape in interface IReshapeHandler

Parameters:

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

originalBounds - The value of the coordinate of the Bounds property at the time of initializeReshape(IInputModeContext).

constrainNewBounds

protected abstract RectD constrainNewBounds(IInputModeContext context,
                                            RectD originalBounds,
                                            RectD newBounds)

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

Parameters:

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

originalBounds - The value of the Bounds property at the time of initializeReshape(IInputModeContext).

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

Returns:

The constrained value of newBounds.

getBounds

public final IRectangle getBounds()

Delegates to the WrappedHandler's Bounds property.

Specified by:

getBounds in interface IReshapeHandler

Returns:

The Bounds.

getWrappedHandler

protected final IReshapeHandler getWrappedHandler()

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

Returns:

The wrapped handler.

handleReshape

public final void handleReshape(IInputModeContext context,
                                RectD originalBounds,
                                RectD newBounds)

Handles the reshape operation and subsequently calls onReshaped(IInputModeContext, RectD, RectD).

This method will use the constrainNewBounds(IInputModeContext, RectD, RectD) callback to let subclasses constrain the reshaping.

Specified by:

handleReshape in interface IReshapeHandler

Parameters:

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

originalBounds - The value of the Bounds property at the time of initializeReshape(IInputModeContext).

newBounds - The coordinates in the world coordinate system that the client wants to reshape the item to. Depending on the implementation the Bounds may or may not be modified to reflect the new value.

initializeReshape

public final void initializeReshape(IInputModeContext context)

Initializes the reshape operation and subsequently calls onInitialized(IInputModeContext, RectD).

Specified by:

initializeReshape in interface IReshapeHandler

Parameters:

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

onCanceled

protected void onCanceled(IInputModeContext context,
                          RectD originalBounds)

Called when the cancelReshape(IInputModeContext, RectD) method has been called.

Parameters:

context - The input mode context.

originalBounds - The original bounds.

onFinished

protected void onFinished(IInputModeContext context,
                          RectD originalBounds,
                          RectD newBounds)

Called when the reshapeFinished(IInputModeContext, RectD, RectD) method has been called.

Parameters:

context - The input mode context.

originalBounds - The original bounds.

newBounds - The new bounds.

onInitialized

protected void onInitialized(IInputModeContext context,
                             RectD originalBounds)

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

Parameters:

context - The input mode context.

originalBounds - The original bounds.

onReshaped

protected void onReshaped(IInputModeContext context,
                          RectD originalBounds,
                          RectD newBounds)

Called when the handleReshape(IInputModeContext, RectD, RectD) operation has been performed.

Parameters:

context - The input mode context.

originalBounds - The original Bounds.

newBounds - The new Bounds.

reshapeFinished

public final void reshapeFinished(IInputModeContext context,
                                  RectD originalBounds,
                                  RectD newBounds)

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

Specified by:

reshapeFinished in interface IReshapeHandler

Parameters:

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

originalBounds - The value of the Bounds property at the time of initializeReshape(IInputModeContext).

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