Module org.jhotdraw8.draw
Package org.jhotdraw8.draw.tool

Class AbstractTool

java.lang.Object
org.jhotdraw8.application.AbstractDisableable
org.jhotdraw8.draw.tool.AbstractTool
All Implemented Interfaces:
Tool, PropertyBean, Disableable
Direct Known Subclasses:
AbstractCreationTool, ConnectionTool, SelectionTool, TextEditingTool
public abstract class AbstractTool extends AbstractDisableable implements Tool
AbstractAction.
Author:
Werner Randelshofer

  • Property Details

    • drawingView

      public javafx.beans.property.ObjectProperty<DrawingView> drawingViewProperty
      The active view.
      Specified by:
      drawingViewProperty in interface Tool
      Returns:
      the drawingView property, with getBean() returning this tool, and getLabel() returning DRAWING_VIEW_PROPERTY.
      See Also:

    • drawingEditor

      public javafx.beans.property.ObjectProperty<DrawingEditor> drawingEditorProperty
      The active editor.
      Specified by:
      drawingEditorProperty in interface Tool
      Returns:
      the drawingView property, with getBean() returning this tool, and getLabel() returning DRAWING_VIEW_PROPERTY.
      See Also:

    • focused

      public javafx.beans.property.ReadOnlyBooleanProperty focusedProperty
      Specified by:
      focusedProperty in interface Tool
      See Also:

  • Field Details

    • eventPane

      protected final javafx.scene.layout.BorderPane eventPane

    • drawPane

      protected final javafx.scene.layout.BorderPane drawPane

    • node

      protected final javafx.scene.layout.StackPane node

    • undoHelper

      protected final UndoableEditHelper undoHelper

  • Constructor Details

    • AbstractTool

      public AbstractTool(String name, @Nullable Resources rsrc)
      Creates a new instance.
      Parameters:
      name - the id of the tool
      rsrc - iff nonnull, the resource is applied to the tool

  • Method Details

    • getProperties

      public final javafx.collections.ObservableMap<Key<?>,Object> getProperties()
      Specified by:
      getProperties in interface PropertyBean

    • drawingViewProperty

      public javafx.beans.property.ObjectProperty<DrawingView> drawingViewProperty()
      The active view.
      Specified by:
      drawingViewProperty in interface Tool
      Returns:
      the drawingView property

    • drawingEditorProperty

      public javafx.beans.property.ObjectProperty<DrawingEditor> drawingEditorProperty()
      The active editor.
      Specified by:
      drawingEditorProperty in interface Tool
      Returns:
      the drawingEditor property

    • applyResources

      protected void applyResources(Resources rsrc)

    • getNode

      public javafx.scene.Node getNode()
      Description copied from interface: Tool
      Returns the node which presents the tool and which handles input events.
      Specified by:
      getNode in interface Tool
      Returns:
      a node

    • stopEditing

      protected void stopEditing()

    • editDelete

      public void editDelete()
      Deletes the selection. Depending on the tool, this could be selected figures, selected points or selected text.
      Specified by:
      editDelete in interface Tool

    • editCut

      public void editCut()
      Cuts the selection into the clipboard. Depending on the tool, this could be selected figures, selected points or selected text.
      Specified by:
      editCut in interface Tool

    • editCopy

      public void editCopy()
      Copies the selection into the clipboard. Depending on the tool, this could be selected figures, selected points or selected text.
      Specified by:
      editCopy in interface Tool

    • editDuplicate

      public void editDuplicate()
      Duplicates the selection. Depending on the tool, this could be selected figures, selected points or selected text.
      Specified by:
      editDuplicate in interface Tool

    • editPaste

      public void editPaste()
      Pastes the contents of the clipboard. Depending on the tool, this could be selected figures, selected points or selected text.
      Specified by:
      editPaste in interface Tool

    • onMouseMoved

      protected void onMouseMoved(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMouseDragged

      protected void onMouseDragged(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMouseExited

      protected void onMouseExited(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMouseEntered

      protected void onMouseEntered(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMouseReleased

      protected void onMouseReleased(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMousePressed

      protected void onMousePressed(javafx.scene.input.MouseEvent event, DrawingView view)

    • onMouseClicked

      protected void onMouseClicked(javafx.scene.input.MouseEvent event, DrawingView view)

    • onKeyPressed

      protected void onKeyPressed(javafx.scene.input.KeyEvent event, DrawingView view)

    • onKeyReleased

      protected void onKeyReleased(javafx.scene.input.KeyEvent event, DrawingView view)

    • onKeyTyped

      protected void onKeyTyped(javafx.scene.input.KeyEvent event, DrawingView view)

    • activate

      public void activate(DrawingEditor editor)
      This implementation sets the help text on the drawing view.
      Specified by:
      activate in interface Tool
      Parameters:
      editor - the editor

    • deactivate

      public void deactivate(DrawingEditor editor)
      This implementation is empty.
      Specified by:
      deactivate in interface Tool
      Parameters:
      editor - the editor

    • addToolListener

      public void addToolListener(org.jhotdraw8.base.event.Listener<ToolEvent> listener)
      Description copied from interface: Tool
      Adds a listener for this tool.
      Specified by:
      addToolListener in interface Tool
      Parameters:
      listener - a listener

    • removeToolListener

      public void removeToolListener(org.jhotdraw8.base.event.Listener<ToolEvent> listener)
      Description copied from interface: Tool
      Removes a listener for this tool.
      Specified by:
      removeToolListener in interface Tool
      Parameters:
      listener - a previously added listener

    • fire

      protected void fire(ToolEvent event)

    • onZoom

      protected void onZoom(javafx.scene.input.ZoomEvent event, DrawingView dv)

    • onZoomStarted

      protected void onZoomStarted(javafx.scene.input.ZoomEvent event, DrawingView dv)

    • onZoomFinished

      protected void onZoomFinished(javafx.scene.input.ZoomEvent event, DrawingView dv)

    • fireToolStarted

      protected void fireToolStarted()

    • fireToolDone

      protected void fireToolDone()

    • requestFocus

      protected void requestFocus()

    • focusedProperty

      public javafx.beans.property.ReadOnlyBooleanProperty focusedProperty()
      Specified by:
      focusedProperty in interface Tool
      Returns:
      the focused property

    • forwardUndoableEdit

      protected void forwardUndoableEdit(UndoableEditEvent event)