Packagecom.yworks.canvas.input
Interfacepublic interface IHandle extends IDragHandler
Implementors CompoundMovePortHandle, ConstrainedHandle, EdgeEndMoveHandle, PointHandle, PortLocationModelParameterHandle, RectangleHandle, ReshapeHandlerHandle, ReshapeableHandle

Interface for a handle that can be displayed in a CanvasComponent 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 center to render a visual handle that can be dragged using the mouse. A drag will trigger the invocation of initializeDrag, zero or more handleMove calls, and will be finalized by either dragFinished or cancelDrag.



Public Properties
 PropertyDefined By
  cursor : Cursor
[read-only] Provides the cursor to display when the mouse hovers over or drags this handle.
IHandle
  type : uint
[read-only] Returns the type of the handle that can be used by the rendering engine to render types differently.
IHandle
 Inheritedx : Number
[read-only] Returns the x coordinate of the current position of the element.
IDragHandler
 Inheritedy : Number
[read-only] Returns the y coordinate of the current position of the element.
IDragHandler
Public Methods
 MethodDefined By
 Inherited
cancelDrag(context:IInputModeContext, originalX:Number, originalY:Number):void
Called by clients to indicate that the dragging has been canceled by the user.
IDragHandler
 Inherited
dragFinished(context:IInputModeContext, originalX:Number, originalY:Number, newX:Number, newY:Number):void
Called by clients to indicate that the repositioning has just been finished.
IDragHandler
 Inherited
handleMove(context:IInputModeContext, originalX:Number, originalY:Number, newX:Number, newY:Number):Boolean
Called by clients to indicate that the element has been dragged and its position should be updated.
IDragHandler
 Inherited
Called by clients to indicate that the element is going to be dragged.
IDragHandler
Property Detail
cursorproperty
cursor:Cursor  [read-only]

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


Implementation
    public function get cursor():Cursor
typeproperty 
type:uint  [read-only]

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


Implementation
    public function get type():uint