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

Class LayerFigure

java.lang.Object
org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean
org.jhotdraw8.draw.figure.AbstractFigure
org.jhotdraw8.draw.figure.AbstractCompositeFigure
org.jhotdraw8.draw.figure.LayerFigure
All Implemented Interfaces:
CompositableFigure, Figure, HideableFigure, Layer, LockableFigure, NonTransformableFigure, StyleableFigure, TransformCachingFigure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>
public class LayerFigure extends AbstractCompositeFigure implements Layer, StyleableFigure, HideableFigure, LockableFigure, NonTransformableFigure, CompositableFigure
LayerFigure.
Author:
Werner Randelshofer

  • Constructor Details

    • LayerFigure

      public LayerFigure()

  • Method Details

    • reshapeInLocal

      public void reshapeInLocal(@NonNull javafx.scene.transform.Transform transform)
      Description copied from interface: Figure
      Attempts to change the local bounds of the figure.

      The figure may choose to only partially change its local bounds.

      Specified by:
      reshapeInLocal in interface Figure
      Specified by:
      reshapeInLocal in interface NonTransformableFigure
      Parameters:
      transform - the desired transformation in local coordinates

    • reshapeInLocal

      public void reshapeInLocal(@NonNull CssSize x, @NonNull CssSize y, @NonNull CssSize width, @NonNull CssSize height)
      Description copied from interface: Figure
      Attempts to change the local bounds of the figure.

      See {#link #reshapeInLocal(Transform)} for a description of this method.

      This method takes parameters as CssSizes. This can be used to avoid rounding errors when the figure is reshaped in non-pixel units.

      This method can forward a call to Figure.reshapeInLocal(Transform) using the following code: 

      
 void reshapeInLocal(@NonNull CssSize x, @NonNull CssSize y, @NonNull CssSize width, @NonNull CssSize height) {
   Transform tx = Transforms.createReshapeTransform(getCssBoundsInLocal(), x, y, width, height);
   reshapeInLocal(tx);
 }
      Specified by:
      reshapeInLocal in interface Figure
      Parameters:
      x - desired x-position in parent coordinates
      y - desired y-position in parent coordinates
      width - desired width in parent coordinates, may be negative
      height - desired height in parent coordinates, may be negative

    • 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(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)

    • updateNodeWithErrorMessage

      public void updateNodeWithErrorMessage(@NonNull RenderContext ctx, List<javafx.scene.Node> childNodes, javafx.geometry.Bounds clipBounds)

    • createNode

      public @NonNull javafx.scene.Node createNode(@NonNull RenderContext ctx)
      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(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:
      ctx - the renderer which will use the node
      Returns:
      the newly created node

    • checkNewParent

      protected void checkNewParent(@Nullable Figure newValue)
      This method throws an illegal argument exception if the new parent is not an instance of Drawing.
      Parameters:
      newValue - the desired parent

    • isSelectable

      public boolean isSelectable()
      Layer figures always return false for isSelectable.
      Specified by:
      isSelectable in interface Figure
      Specified by:
      isSelectable in interface Layer
      Specified by:
      isSelectable in interface LockableFigure
      Returns:
      false

    • createHandles

      public void createHandles(@NonNull HandleType handleType, @NonNull List<Handle> list)
      Layers never create handles.
      Specified by:
      createHandles in interface Figure
      Parameters:
      handleType - The desired handle type
      list - The handles.

    • isSuitableChild

      public boolean isSuitableChild(@NonNull Figure newChild)
      Description copied from interface: Figure
      This method returns whether the provided figure is a suitable child for this figure.
      Specified by:
      isSuitableChild in interface Figure
      Specified by:
      isSuitableChild in interface TreeNode<Figure>
      Parameters:
      newChild - The new child figure.
      Returns:
      true if newChild is an acceptable child

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getBoundsInLocal

      public @NonNull javafx.geometry.Bounds getBoundsInLocal()
      A layer always has the following bounds [0,0,MAX_VALUE,MAX_VALUE].
      Specified by:
      getBoundsInLocal in interface Figure
      Overrides:
      getBoundsInLocal in class AbstractCompositeFigure
      Returns:
      [0, 0, MAX_VALUE, MAX_VALUE].