Package com.inductiveautomation.ignition.designer.designable

Interface IHandle

All Known Implementing Classes:
AbstractShapeHandle, AbstractShapeTool.AbstractShapeControls.AbstractShapeManipulationHandle, RotationControls.AbstractRotationHandle, RotationControls.NERotationHandle, RotationControls.NWRotationHandle, RotationControls.RotationAnchorHandle, RotationControls.SERotationHandle, RotationControls.SWRotationHandle, ScaleControls.AbstractResizeHandle, ScaleControls.EResizeHandle, ScaleControls.NEResizeHandle, ScaleControls.NResizeHandle, ScaleControls.NWResizeHandle, ScaleControls.SEResizeHandle, ScaleControls.SResizeHandle, ScaleControls.SWResizeHandle, ScaleControls.WResizeHandle
public interface IHandle
An IHandle represents a draggable control used to manipulate a component.

  • Method Summary

    Modifier and Type
    Method
    Description
    Rectangle
    getBounds(DesignPanel panel)
    Return the bounds of this handle, in 2d (zoomed) space.
    String
    getStatusBarText(int inputMask)
    Called on mouseover and during drag to get the status bar text for the handle.
    void
    onClick(int inputMask)
    The mouse was clicked within the handle's bounds.
    void
    onDrag(double dX, double dY, int inputMask)
    Called while the handle is being dragged.
    void
    onDragEnd(double dX, double dY, int inputMask)
    The drag event is complete (mouse has been released).
    void
    onDragStart(double dX, double dY, int inputMask)
    The handle has started to be dragged.
    void
    paintHandle(Graphics2D g, boolean mouseOver, boolean drag)
    Gives the handle a chance to paint itself on the given graphics object.

  • Method Details

    • getStatusBarText

      String getStatusBarText(int inputMask)
      Called on mouseover and during drag to get the status bar text for the handle.

    • paintHandle

      void paintHandle(Graphics2D g, boolean mouseOver, boolean drag)
      Gives the handle a chance to paint itself on the given graphics object.

    • onDragStart

      void onDragStart(double dX, double dY, int inputMask)
      The handle has started to be dragged.
      Parameters:
      dX - The distance along the horizontal axis away from the drag starting point. (Unzoomed, logical)
      dY - The distance along the vertical axis away from the drag starting point. (Unzoomed, logical)
      inputMask - The extended modifiers from the underlying mouse drag (see MouseEvent.getModifiersEx().)

    • onDrag

      void onDrag(double dX, double dY, int inputMask)
      Called while the handle is being dragged.
      Parameters:
      dX - The distance along the horizontal axis away from the drag starting point. (Unzoomed, logical)
      dY - The distance along the vertical axis away from the drag starting point. (Unzoomed, logical)
      inputMask - The extended modifiers from the underlying mouse drag (see MouseEvent.getModifiersEx().)

    • onDragEnd

      void onDragEnd(double dX, double dY, int inputMask)
      The drag event is complete (mouse has been released).
      Parameters:
      dX - The distance along the horizontal axis away from the drag starting point. (Unzoomed, logical)
      dY - The distance along the vertical axis away from the drag starting point. (Unzoomed, logical)
      inputMask - The extended modifiers from the underlying mouse drag (see MouseEvent.getModifiersEx().)

    • onClick

      void onClick(int inputMask)
      The mouse was clicked within the handle's bounds.

    • getBounds

      Rectangle getBounds(DesignPanel panel)
      Return the bounds of this handle, in 2d (zoomed) space.