com.yworks.yfiles.view.input

Interface IHandle

All Superinterfaces:

IDragHandler

All Known Implementing Classes:

ConstrainedHandle, PortLocationModelParameterHandle, PortRelocationHandle, RectangleHandle, ReshapeHandlerHandle

public interface IHandle
extends IDragHandler

Interface for a handle that can be displayed in a CanvasControl as a UI element for the user to modify the contents of the control.

Handles can be dragged with the mouse and will thereby modify their context. Typically client code will use the Location to render a visual handle that can be dragged using the mouse. A drag will trigger the invocation of IDragHandler.initializeDrag(IInputModeContext), zero or more IDragHandler.handleMove(IInputModeContext, com.yworks.yfiles.geometry.PointD, com.yworks.yfiles.geometry.PointD) calls, and will be finalized by either IDragHandler.dragFinished(IInputModeContext, com.yworks.yfiles.geometry.PointD, com.yworks.yfiles.geometry.PointD) or IDragHandler.cancelDrag(IInputModeContext, com.yworks.yfiles.geometry.PointD).

See Also:

HandleInputMode, IDragHandler

Method Summary

Modifier and Type	Method and Description
Cursor	getCursor() Provides the cursor to display when the mouse hovers over or drags this handle.
HandleTypes	getType() Returns the type of the handle that can be used by the rendering engine to render types differently.

Methods inherited from interface com.yworks.yfiles.view.input.IDragHandler

cancelDrag, dragFinished, getLocation, handleMove, initializeDrag

Method Detail

getCursor

Cursor getCursor()

Provides the cursor to display when the mouse hovers over or drags this handle.

Returns:

The Cursor.

getType

HandleTypes getType()

Returns the type of the handle that can be used by the rendering engine to render types differently.

Returns:

The Type.