RectangleHandle (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.input.RectangleHandle

All Implemented Interfaces:

IMutablePoint, IPoint, IDragHandler, IHandle
```
public class RectangleHandle
extends Object
implements IMutablePoint, IHandle
```
A more sophisticated IHandle implementation that modifies a rectangle.
Implementations of this class work on a mutable rectangle instance for handling drags of the handle. A separate point implementation is used for specifying the position of the handle. As a convenience this class also implements the IMutablePoint interface which modifies the handle's position.

Constructor Summary

Constructors
Constructor and Description
`RectangleHandle(HandlePositions position, IMutableRectangle rectangle)` Subclass constructor that creates a handle for the given position using the location instance as the `Location` for the handle.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelDrag(IInputModeContext context, PointD originalLocation)` Delegates the original values to `set(double, double)`.
`void`	`dragFinished(IInputModeContext context, PointD originalLocation, PointD newLocation)` This implementation does nothing.
`Cursor`	`getCursor()` Gets the cursor to display when the mouse hovers over or drags this handle.
`IPoint`	`getLocation()` Returns a view of the center of the handle.
`ISize`	`getMaximumSize()` Gets the maximum size allowed for the reshapeable.
`IRectangle`	`getMinimumEnclosedArea()` Gets the minimum enclosed area that needs to be encompassed by this reshapeable.
`ISize`	`getMinimumSize()` Gets the minimum size allowed for the reshapeable.
`protected HandlePositions`	`getPosition()` The position of the handle.
`protected IMutableRectangle`	`getRectangle()` The rectangle instance to modify.
`HandleTypes`	`getType()` Gets the type of the handle that can be used by the rendering engine to render types differently.
`double`	`getX()` Gets the x coordinate.
`double`	`getY()` Gets the y coordinate.
`void`	`handleMove(IInputModeContext context, PointD originalLocation, PointD newLocation)` Delegates to `set(double, double)`.
`void`	`initializeDrag(IInputModeContext context)` This implementation does nothing.
`void`	`moveBy(PointD delta)` Delegates the work to the reshapeable.
`void`	`set(double x, double y)` Delegates to `moveBy(PointD)`.
`void`	`setCursor(Cursor value)` Sets the cursor to display when the mouse hovers over or drags this handle.
`void`	`setMaximumSize(ISize value)` Sets the maximum size allowed for the reshapeable.
`void`	`setMinimumEnclosedArea(IRectangle value)` Sets the minimum enclosed area that needs to be encompassed by this reshapeable.
`void`	`setMinimumSize(ISize value)` Sets the minimum size allowed for the reshapeable.
`void`	`setType(HandleTypes value)` Sets the type of the handle that can be used by the rendering engine to render types differently.
`void`	`setX(double value)` Sets the x coordinate.
`void`	`setY(double value)` Sets the y coordinate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.geometry.IMutablePoint
relocate, relocate, relocate

Methods inherited from interface com.yworks.yfiles.geometry.IPoint
distanceTo, toPointD

- Constructor Detail
  - RectangleHandle
```
public RectangleHandle(HandlePositions position,
                       IMutableRectangle rectangle)
```
    Subclass constructor that creates a handle for the given position using the location instance as the Location for the handle.
    The instance modifies the instances using the reshapeable interface and reads the current state using the rect. The handle will automatically trim changes of the rectangle to the specified minimum and maximum size.
    
    Parameters:
    
    position - The position of the handle.
    
    rectangle - The rectangle to change.
- Method Detail
  - cancelDrag
```
public void cancelDrag(IInputModeContext context,
                       PointD originalLocation)
```
    Delegates the original values to set(double, double).
    
    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 IDragHandler.initializeDrag(IInputModeContext).
  - dragFinished
```
public void dragFinished(IInputModeContext context,
                         PointD originalLocation,
                         PointD newLocation)
```
    This implementation does nothing.
    
    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 IDragHandler.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 IDragHandler.handleMove(IInputModeContext, PointD, PointD)
  - getCursor
```
public final Cursor getCursor()
```
    Gets the cursor to display when the mouse hovers over or drags this handle.
    
    Specified by:
    
    getCursor in interface IHandle
    
    Returns:
    
    The Cursor.
    
    See Also:
    
    setCursor(Cursor)
  - getLocation
```
public final IPoint getLocation()
```
    Returns a view of the center of the handle.
    The point describes the current world coordinate of the element that can be modified by this handle.
    
    Specified by:
    
    getLocation in interface IDragHandler
    
    Returns:
    
    The Location.
  - getMaximumSize
```
public final ISize getMaximumSize()
```
    Gets the maximum size allowed for the reshapeable.
    The value is stored by reference. The default is SizeD.INFINITE.
    
    Returns:
    
    The MaximumSize.
    
    See Also:
    
    setMaximumSize(ISize)
  - getMinimumEnclosedArea
```
public final IRectangle getMinimumEnclosedArea()
```
    Gets the minimum enclosed area that needs to be encompassed by this reshapeable.
    The value is stored by reference. The default is SizeD.ZERO, which does not restrict the area at all.
    
    Returns:
    
    The MinimumEnclosedArea.
    
    See Also:
    
    setMinimumEnclosedArea(IRectangle)
  - getMinimumSize
```
public final ISize getMinimumSize()
```
    Gets the minimum size allowed for the reshapeable.
    The value is stored by reference. The default is SizeD.ZERO.
    
    Returns:
    
    The MinimumSize.
    
    See Also:
    
    setMinimumSize(ISize)
  - getPosition
```
protected final HandlePositions getPosition()
```
    The position of the handle.
    
    Returns:
    
    The Position.
  - getRectangle
```
protected final IMutableRectangle getRectangle()
```
    The rectangle instance to modify.
    
    Returns:
    
    The Rectangle.
  - getType
```
public final HandleTypes getType()
```
    Gets the type of the handle that can be used by the rendering engine to render types differently.
    
    Specified by:
    
    getType in interface IHandle
    
    Returns:
    
    The Type.
    
    See Also:
    
    setType(HandleTypes)
  - getX
```
public final double getX()
```
    Gets the x coordinate.
    The setter delegates to moveBy(PointD)
    
    Specified by:
    
    getX in interface IMutablePoint
    
    Specified by:
    
    getX in interface IPoint
    
    Returns:
    
    The X.
    
    See Also:
    
    setX(double)
  - getY
```
public final double getY()
```
    Gets the y coordinate.
    The setter delegates to moveBy(PointD)
    
    Specified by:
    
    getY in interface IMutablePoint
    
    Specified by:
    
    getY in interface IPoint
    
    Returns:
    
    The Y.
    
    See Also:
    
    setY(double)
  - handleMove
```
public void handleMove(IInputModeContext context,
                       PointD originalLocation,
                       PointD newLocation)
```
    Delegates to set(double, double).
    
    Specified by:
    
    handleMove 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 IDragHandler.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 void initializeDrag(IInputModeContext context)
```
    This implementation does nothing.
    
    Specified by:
    
    initializeDrag in interface IDragHandler
    
    Parameters:
    
    context - The context to retrieve information about the drag from.
  - moveBy
```
public void moveBy(PointD delta)
```
    Delegates the work to the reshapeable.
  - set
```
public void set(double x,
                double y)
```
    Delegates to moveBy(PointD).
  - setCursor
```
public final void setCursor(Cursor value)
```
    Sets the cursor to display when the mouse hovers over or drags this handle.
    
    Parameters:
    
    value - The Cursor to set.
    
    See Also:
    
    getCursor()
  - setMaximumSize
```
public final void setMaximumSize(ISize value)
```
    Sets the maximum size allowed for the reshapeable.
    The value is stored by reference. The default is SizeD.INFINITE.
    
    Parameters:
    
    value - The MaximumSize to set.
    
    See Also:
    
    getMaximumSize()
  - setMinimumEnclosedArea
```
public final void setMinimumEnclosedArea(IRectangle value)
```
    Sets the minimum enclosed area that needs to be encompassed by this reshapeable.
    The value is stored by reference. The default is SizeD.ZERO, which does not restrict the area at all.
    
    Parameters:
    
    value - The MinimumEnclosedArea to set.
    
    See Also:
    
    getMinimumEnclosedArea()
  - setMinimumSize
```
public final void setMinimumSize(ISize value)
```
    Sets the minimum size allowed for the reshapeable.
    The value is stored by reference. The default is SizeD.ZERO.
    
    Parameters:
    
    value - The MinimumSize to set.
    
    See Also:
    
    getMinimumSize()
  - setType
```
public final void setType(HandleTypes value)
```
    Sets the type of the handle that can be used by the rendering engine to render types differently.
    
    Parameters:
    
    value - The Type to set.
    
    See Also:
    
    getType()
  - setX
```
public final void setX(double value)
```
    Sets the x coordinate.
    The setter delegates to moveBy(PointD)
    
    Specified by:
    
    setX in interface IMutablePoint
    
    Parameters:
    
    value - The X to set.
    
    See Also:
    
    getX()
  - setY
```
public final void setY(double value)
```
    Sets the y coordinate.
    The setter delegates to moveBy(PointD)
    
    Specified by:
    
    setY in interface IMutablePoint
    
    Parameters:
    
    value - The Y to set.
    
    See Also:
    
    getY()

Class RectangleHandle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.geometry.IMutablePoint

Methods inherited from interface com.yworks.yfiles.geometry.IPoint

Constructor Detail

RectangleHandle

Method Detail

cancelDrag

dragFinished

getCursor

getLocation

getMaximumSize

getMinimumEnclosedArea

getMinimumSize

getPosition

getRectangle

getType

getX

getY

handleMove

initializeDrag

moveBy

set

setCursor

setMaximumSize

setMinimumEnclosedArea

setMinimumSize

setType

setX

setY