Module org.jhotdraw8.draw
Package org.jhotdraw8.draw.figure

Class AbstractElbowLineConnectionWithMarkersFigure

java.lang.Object
org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean
org.jhotdraw8.draw.figure.AbstractFigure
org.jhotdraw8.draw.figure.AbstractLeafFigure
org.jhotdraw8.draw.figure.AbstractLineConnectionFigure
org.jhotdraw8.draw.figure.AbstractElbowLineConnectionWithMarkersFigure
All Implemented Interfaces:
ConnectingFigure, Figure, LineConnectingFigure, NonTransformableFigure, PathIterableFigure, TransformCachingFigure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>
public abstract class AbstractElbowLineConnectionWithMarkersFigure extends AbstractLineConnectionFigure implements PathIterableFigure
AbstractElbowLineConnectionWithMarkersFigure draws a straight line or an elbow line from start to end.

A subclass can hardcode the markers, or can implement one or multiple "markerable" interfaces that allow user-defineable markers: MarkerStartableFigure, MarkerEndableFigure, MarkerSegmentableFigure, MarkerMidableFigure.

Author:
Werner Randelshofer

  • Constructor Details

    • AbstractElbowLineConnectionWithMarkersFigure

      public AbstractElbowLineConnectionWithMarkersFigure()

    • AbstractElbowLineConnectionWithMarkersFigure

      public AbstractElbowLineConnectionWithMarkersFigure(@NonNull javafx.geometry.Point2D start, @NonNull javafx.geometry.Point2D end)

    • AbstractElbowLineConnectionWithMarkersFigure

      public AbstractElbowLineConnectionWithMarkersFigure(double startX, double startY, double endX, double endY)

  • Method Details

    • createNode

      public @NonNull javafx.scene.Node createNode(@NonNull RenderContext drawingView)
      Description copied from interface: Figure
      This method is invoked by a RenderContext, when it needs a node to create a JavaFX scene graph for a figure.

      A typical implementation should look like this: 

      
 public Node createNode(@NonNull RenderContext v) {
 return new ...desired subclass of Node...();
 }

      A figure may be rendered with multiple RenderContexts simultaneously. Each RenderContext uses this method to instantiate a JavaFX node for the figure and associate it to the figure.

      This method must create a new instance because returning an already existing instance may cause undesired side effects on other RenderContexts.

      Note that by convention this method may only be invoked by a RenderContext object.

      Specified by:
      createNode in interface Figure
      Parameters:
      drawingView - the renderer which will use the node
      Returns:
      the newly created node

    • createHandles

      public void createHandles(@NonNull HandleType handleType, @NonNull List<Handle> list)
      Description copied from interface: Figure
      Creates handles of the specified level and adds them to the provided list.
      Specified by:
      createHandles in interface Figure
      Parameters:
      handleType - The desired handle type
      list - The handles.

    • updateLineNode

      protected void updateLineNode(@NonNull RenderContext ctx, @NonNull javafx.scene.shape.Polyline node)
      This method can be overridden by a subclass to apply styles to the line node.
      Parameters:
      ctx - the context
      node - the node

    • updateStartMarkerNode

      protected void updateStartMarkerNode(@NonNull RenderContext ctx, @NonNull javafx.scene.shape.Path node)
      This method can be overridden by a subclass to apply styles to the marker node.
      Parameters:
      ctx - the context
      node - the node

    • updateEndMarkerNode

      protected void updateEndMarkerNode(@NonNull RenderContext ctx, @NonNull javafx.scene.shape.Path node)
      This method can be overridden by a subclass to apply styles to the marker node.
      Parameters:
      ctx - the context
      node - the node

    • updateNode

      public void updateNode(@NonNull RenderContext ctx, @NonNull javafx.scene.Node node)
      Description copied from interface: Figure
      This method is invoked by a RenderContext, when it needs to update the node which represents the scene graph in the figure.

      A figure which is composed from child figures, must addChild the nodes of its getChildren to its node. This ensures that coordinate space transformations of the composed figure are properly propagated to its getChildren. 

       public void updateNode(@NonNull RenderContext rc, Node n) {
     ObservableList<Node> group = ((Group) n).getChildren();
 group.clear();
 for (Figure child : children()) {
 group.addChild(rc.getNode(child));
 }

      A figure may be shown in multiple RenderContexts. Each RenderContext uses this method to update the a JavaFX node for the figure.

      Note that the figure must retrieve the JavaFX node from other figures from the render context by invoking rc.getNode(child) rather than creating new nodes using child.createNode(rc). This convention allows to implement a cache in the render context for the Java FX node. Also, render contexts like a drawing view need to associate input events on Java FX nodes to the corresponding figure.

      This figure does not keep track of changes that require node updates. DrawingModel to manage node updates.

      Specified by:
      updateNode in interface Figure
      Parameters:
      ctx - the render context
      node - the node which was created with Figure.createNode(org.jhotdraw8.draw.render.RenderContext)

    • updateMarkerNode

      protected void updateMarkerNode(@NonNull RenderContext ctx, @NonNull javafx.scene.Group group, @NonNull javafx.scene.shape.Path markerNode, @NonNull PointAndDerivative pd, @Nullable String svgString, double markerScaleFactor)

    • getPathIterator

      public @NonNull PathIterator getPathIterator(@NonNull RenderContext ctx, @Nullable AffineTransform tx)
      Specified by:
      getPathIterator in interface PathIterableFigure

    • getStrokeCutStart

      public abstract double getStrokeCutStart(@NonNull RenderContext ctx)

    • getStrokeCutEnd

      public abstract double getStrokeCutEnd(@NonNull RenderContext ctx)

    • getMarkerStartShape

      public abstract @Nullable String getMarkerStartShape()

    • getMarkerStartScaleFactor

      public abstract double getMarkerStartScaleFactor()

    • getMarkerEndShape

      public abstract @Nullable String getMarkerEndShape()

    • getMarkerEndScaleFactor

      public abstract double getMarkerEndScaleFactor()

    • getElbowOffset

      public abstract @Nullable CssSize getElbowOffset()
      The offset of the elbow from the end of the line.

      If the value is null, or less or equal 0, then a straight line is drawn instead of an elbow.

      Returns:
      an offset

    • layout

      public void layout(@NonNull RenderContext ctx)
      Description copied from interface: Figure
      Updates the layout of this figure, based on the layout of its children and the layout of observed layout subjects.

      If the layout of this figure depends on the layout of other figures, then calling layout on this figure will only result in the correct result, if layout of the other figures has been performed first.

      A figure does not keep track of changes that require layout updates. Use DrawingModel to manage layout updates.

      The default implementation is empty.

      To layout a drawing use Drawing.layoutAll(RenderContext).

      Specified by:
      layout in interface Figure
      Parameters:
      ctx - the render context (optional)