IReshapeHandler

Interface for an object that can be interactively reshaped in a CanvasComponent

Inheritance Hierarchy

IReshapeHandler

Remarks

Items can be reshaped interactively and an instance of this class can be used to handle that process. A reshape operation will be initialized by a call to initializeReshape, then zero or more handleReshape calls follow, and the operation will be finalized by a call to either reshapeFinished or cancelReshape. Note that implementations of this class will only be used during interactive reshape operations.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.input.IReshapeHandler

Properties

bounds

: IRectangle

Gets a view of the bounds of the item.

Remarks

The rectangle describes the current world coordinate of the element that can be modified by this handler.

Methods

cancelReshape

(context: IInputModeContext, originalBounds: Rect)

Called by clients to indicate that the reshaping has been canceled by the user.

Remarks

This method may be called after the initial initializeReshape and zero or more invocations of handleReshape. Implementations should reset the bounds of the items they modify to their initial state. Alternatively to this method the reshapeFinished method might be called.

Parameters

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

context - IInputModeContext: The context to retrieve information about the reshaping from.
originalBounds - Rect: The value of the coordinate of the bounds property at the time of initializeReshape.

handleReshape

(context: IInputModeContext, originalBounds: Rect, newBounds: Rect)

Called by clients to indicate that the element has been dragged and its position should be updated.

Remarks

This method may be called more than once after an initial initializeReshape and will the final call will be followed by either one reshapeFinished or one cancelReshape call.

Parameters

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

context - IInputModeContext: The context to retrieve information about the reshaping from.
originalBounds - Rect: The value of the bounds property at the time of initializeReshape.
newBounds - Rect: The coordinates of the bounds in the world coordinate system that the client wants the shape to be at. Depending on the implementation the bounds may or may not be modified to reflect the new value.

initializeReshape

(context: IInputModeContext)

Called by clients to indicate that the element is going to be reshaped.

Remarks

This call will be followed by one or more calls to handleReshape, and a final reshapeFinished or cancelReshape.

Parameters

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

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

reshapeFinished

(context: IInputModeContext, originalBounds: Rect, newBounds: Rect)

Called by clients to indicate that the reshaping has just been finished.

Remarks

This method may be called after the initial initializeReshape and zero or more invocations of handleReshape. Alternatively to this method the cancelReshape method might be called.

Parameters

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

context - IInputModeContext: The context to retrieve information about the drag from.
originalBounds - Rect: The value of the coordinate of the bounds property at the time of initializeReshape.
newBounds - Rect: The coordinates of the bounds in the world coordinate system that the client wants the shape 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

Static Methods

create

() : IReshapeHandler

Creates an implementation of the interface IReshapeHandler from the given definition.

Remarks

The given object must contain exactly the abstract members of the IReshapeHandler 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.

ParametersOptions Overload

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

initializeReshape - function(IInputModeContext):void: Called by clients to indicate that the element is going to be reshaped.
This property holds the implementation for initializeReshape.
handleReshape - function(IInputModeContext, Rect, Rect):void: Called by clients to indicate that the element has been dragged and its position should be updated.
This property holds the implementation for handleReshape.
cancelReshape - function(IInputModeContext, Rect):void: Called by clients to indicate that the reshaping has been canceled by the user.
This property holds the implementation for cancelReshape.
reshapeFinished - function(IInputModeContext, Rect, Rect):void: Called by clients to indicate that the reshaping has just been finished.
This property holds the implementation for reshapeFinished.
bounds - IRectangle: Gets a view of the bounds of the item.
This property holds the implementation for bounds.

Returns

↪IReshapeHandler: An instance of the IReshapeHandler interface based on the given definition.

IReshapeHandler

Remarks

Type Details

See Also

Properties

bounds

Remarks

Methods

cancelReshape

Remarks

Parameters

See Also

handleReshape

Remarks

Parameters

See Also

initializeReshape

Remarks

Parameters

See Also

reshapeFinished

Remarks

Parameters

See Also

Static Methods

create

Remarks

ParametersOptions Overload

Returns