Package org.csstudio.opibuilder.widgets.feedback

Class PointListCreationTool

java.lang.Object
org.eclipse.gef.util.FlagSupport
org.eclipse.gef.tools.AbstractTool
org.eclipse.gef.tools.TargetingTool
org.csstudio.opibuilder.widgets.feedback.PointListCreationTool
All Implemented Interfaces:
org.eclipse.gef.RequestConstants, org.eclipse.gef.Tool
public final class PointListCreationTool extends org.eclipse.gef.tools.TargetingTool
A custom creation tool for PointList dependend widgets. The tool produces a point list, by interpreting each left click as location for a new point.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.eclipse.gef.tools.AbstractTool

    org.eclipse.gef.tools.AbstractTool.Input

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Object
    PROPERTY_CREATION_FACTORY
    Property to be used in AbstractTool#setProperties(java.util.Map) for setFactory(CreationFactory).

    Fields inherited from class org.eclipse.gef.tools.TargetingTool

    MAX_FLAG

    Fields inherited from class org.eclipse.gef.tools.AbstractTool

    MAX_STATE, MOUSE_BUTTON_ANY, MOUSE_BUTTON1, MOUSE_BUTTON2, MOUSE_BUTTON3, PROPERTY_UNLOAD_WHEN_FINISHED, STATE_ACCESSIBLE_DRAG, STATE_ACCESSIBLE_DRAG_IN_PROGRESS, STATE_DRAG, STATE_DRAG_IN_PROGRESS, STATE_INITIAL, STATE_INVALID, STATE_TERMINAL

    Fields inherited from interface org.eclipse.gef.RequestConstants

    REQ_ADD, REQ_ALIGN, REQ_ALIGN_CHILDREN, REQ_CLONE, REQ_CONNECTION_END, REQ_CONNECTION_START, REQ_CREATE, REQ_CREATE_BENDPOINT, REQ_DELETE, REQ_DELETE_DEPENDANT, REQ_DIRECT_EDIT, REQ_MOVE, REQ_MOVE_BENDPOINT, REQ_MOVE_CHILDREN, REQ_OPEN, REQ_ORPHAN, REQ_ORPHAN_CHILDREN, REQ_RECONNECT_SOURCE, REQ_RECONNECT_TARGET, REQ_RESIZE, REQ_RESIZE_CHILDREN, REQ_SELECTION, REQ_SELECTION_HOVER

  • Constructor Summary

    Constructors
    Constructor
    Description
    PointListCreationTool()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    applyProperty(Object key, Object value)
     
    protected org.eclipse.gef.Request
    createTargetRequest()
     
    void
    deactivate()
     
    protected String
    getCommandName()
     
    protected org.eclipse.gef.requests.CreateRequest
    getCreateRequest()
    Cast the target request to a CreateRequest and returns it.
    protected String
    getDebugName()
     
    protected org.eclipse.gef.requests.CreationFactory
    getFactory()
    Returns the creation factory used to create the new EditParts.
    protected org.eclipse.gef.EditPartViewer.Conditional
    getTargetingConditional()
     
    protected boolean
    handleButtonDown(int button)
     
    protected boolean
    handleButtonUp(int button)
     
    protected boolean
    handleDoubleClick(int button)
     
    protected boolean
    handleDragInProgress()
     
    protected boolean
    handleDragStarted()
     
    protected boolean
    handleFocusLost()
     
    protected boolean
    handleHover()
     
    protected boolean
    handleMove()
     
    protected void
    performCreation(int button)
    Executes the current command and selects the newly created object.
    void
    setFactory(org.eclipse.gef.requests.CreationFactory factory)
    Sets the creation factory used to create the new edit parts.
    protected void
    updateTargetRequest()
     

    Methods inherited from class org.eclipse.gef.tools.TargetingTool

    doAutoexpose, eraseTargetFeedback, getAutoexposeHelper, getCommand, getDirection, getExclusionSet, getTargetEditPart, getTargetRequest, handleAutoexpose, handleEnteredEditPart, handleExitingEditPart, handleHoverStop, handleInvalidInput, handleLeavingEditPart, handleViewerExited, isShowingTargetFeedback, isTargetLocked, lockTargetEditPart, resetFlags, resetHover, setAutoexposeHelper, setTargetEditPart, setTargetRequest, showTargetFeedback, unlockTargetEditPart, updateAutoexposeHelper, updateTargetUnderMouse

    Methods inherited from class org.eclipse.gef.tools.AbstractTool

    acceptArrowKey, accGetStep, accStepIncrement, accStepReset, activate, addFeedback, calculateCursor, commitDrag, createOperationSet, debug, executeCommand, executeCurrentCommand, focusGained, focusLost, getCurrentCommand, getCurrentInput, getCurrentViewer, getDebugNameForState, getDefaultCursor, getDisabledCursor, getDomain, getDragMoveDelta, getLocation, getOperationSet, getStartLocation, getState, handleCommandStackChanged, handleDrag, handleFinished, handleFocusGained, handleKeyDown, handleKeyTraversed, handleKeyUp, handleNativeDragFinished, handleNativeDragStarted, handleViewerEntered, isActive, isHoverActive, isInState, isViewerImportant, keyDown, keyTraversed, keyUp, mouseDoubleClick, mouseDown, mouseDrag, mouseHover, mouseMove, mouseUp, mouseWheelScrolled, movedPastThreshold, nativeDragFinished, nativeDragStarted, performViewerMouseWheel, placeMouseInViewer, reactivate, refreshCursor, releaseToolCapture, removeFeedback, setCurrentCommand, setCursor, setDefaultCursor, setDisabledCursor, setEditDomain, setHoverActive, setProperties, setStartLocation, setState, setToolCapture, setUnloadWhenFinished, setViewer, stateTransition, unloadWhenFinished, viewerEntered, viewerExited

    Methods inherited from class org.eclipse.gef.util.FlagSupport

    getFlag, setFlag

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • PROPERTY_CREATION_FACTORY

      public static final Object PROPERTY_CREATION_FACTORY
      Property to be used in AbstractTool#setProperties(java.util.Map) for setFactory(CreationFactory).

  • Constructor Details

    • PointListCreationTool

      public PointListCreationTool()
      Default constructor.

  • Method Details

    • applyProperty

      protected void applyProperty(Object key, Object value)
      Overrides:
      applyProperty in class org.eclipse.gef.tools.AbstractTool

    • createTargetRequest

      protected org.eclipse.gef.Request createTargetRequest()
      Overrides:
      createTargetRequest in class org.eclipse.gef.tools.TargetingTool

    • deactivate

      public void deactivate()
      Specified by:
      deactivate in interface org.eclipse.gef.Tool
      Overrides:
      deactivate in class org.eclipse.gef.tools.TargetingTool

    • getCommandName

      protected String getCommandName()
      Specified by:
      getCommandName in class org.eclipse.gef.tools.AbstractTool

    • getCreateRequest

      protected org.eclipse.gef.requests.CreateRequest getCreateRequest()
      Cast the target request to a CreateRequest and returns it.

    • getDebugName

      protected String getDebugName()
      Overrides:
      getDebugName in class org.eclipse.gef.tools.AbstractTool

    • getFactory

      protected org.eclipse.gef.requests.CreationFactory getFactory()
      Returns the creation factory used to create the new EditParts.

    • handleDoubleClick

      protected boolean handleDoubleClick(int button)
      Overrides:
      handleDoubleClick in class org.eclipse.gef.tools.AbstractTool

    • handleButtonDown

      protected boolean handleButtonDown(int button)
      Overrides:
      handleButtonDown in class org.eclipse.gef.tools.AbstractTool

    • handleButtonUp

      protected boolean handleButtonUp(int button)
      Overrides:
      handleButtonUp in class org.eclipse.gef.tools.AbstractTool

    • handleDragInProgress

      protected boolean handleDragInProgress()
      Overrides:
      handleDragInProgress in class org.eclipse.gef.tools.AbstractTool

    • handleDragStarted

      protected boolean handleDragStarted()
      Overrides:
      handleDragStarted in class org.eclipse.gef.tools.AbstractTool

    • handleFocusLost

      protected boolean handleFocusLost()
      Overrides:
      handleFocusLost in class org.eclipse.gef.tools.AbstractTool

    • handleHover

      protected boolean handleHover()
      Overrides:
      handleHover in class org.eclipse.gef.tools.AbstractTool

    • handleMove

      protected boolean handleMove()
      Overrides:
      handleMove in class org.eclipse.gef.tools.AbstractTool

    • performCreation

      protected void performCreation(int button)
      Executes the current command and selects the newly created object. The button that was released to cause this creation is passed in, but since handleButtonDown(int) goes into the invalid state if the button pressed is not button 1, this will always be button 1.
      Parameters:
      button - the button that was pressed

    • setFactory

      public void setFactory(org.eclipse.gef.requests.CreationFactory factory)
      Sets the creation factory used to create the new edit parts.
      Parameters:
      factory - the factory

    • updateTargetRequest

      protected void updateTargetRequest()
      Overrides:
      updateTargetRequest in class org.eclipse.gef.tools.TargetingTool

    • getTargetingConditional

      protected org.eclipse.gef.EditPartViewer.Conditional getTargetingConditional()
      Overrides:
      getTargetingConditional in class org.eclipse.gef.tools.TargetingTool