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

Class SliceFigure

java.lang.Object
org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean
org.jhotdraw8.draw.figure.AbstractFigure
org.jhotdraw8.draw.figure.AbstractLeafFigure
org.jhotdraw8.draw.figure.SliceFigure
All Implemented Interfaces:
Figure, HideableFigure, LockableFigure, ResizableFigure, Slice, StyleableFigure, TransformableFigure, TransformCachingFigure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>
public class SliceFigure extends AbstractLeafFigure implements Slice, TransformableFigure, ResizableFigure, HideableFigure, LockableFigure, StyleableFigure
This is a special figure which is used to segment a drawing into tiles, when exporting it using the BitmapExportOutputFormat.

This figure renders only with rendering intent RenderingIntent.EDITOR.

Author:
Werner Randelshofer

  • Field Details

  • Constructor Details

    • SliceFigure

      public SliceFigure()

    • SliceFigure

      public SliceFigure(double x, double y, double width, double height)

    • SliceFigure

      public SliceFigure(@NonNull javafx.geometry.Rectangle2D rect)

  • Method Details

    • 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.

    • getLayoutBounds

      public @NonNull javafx.geometry.Bounds getLayoutBounds()
      Description copied from interface: Figure
      The bounds that should be used for transformations of this figure.

      The bounds are given in the untransformed local coordinate space of the figure.

      This method may use caching and return incorrect results if the cache is stale. Invoke Figure.layout(org.jhotdraw8.draw.render.RenderContext) if you are not sure that the cache is valid.

      Specified by:
      getLayoutBounds in interface Figure
      Returns:
      the local bounds

    • getCssLayoutBounds

      public @NonNull CssRectangle2D getCssLayoutBounds()
      Specified by:
      getCssLayoutBounds in interface Figure

    • getSliceOrigin

      public javafx.geometry.Point2D getSliceOrigin()
      Description copied from interface: Slice
      For vector graphics output. Specifies where the origin of the coordinate system in the exported slice is. By default, this is the top left corner of the slice.
      Specified by:
      getSliceOrigin in interface Slice
      Returns:
      origin of coordinate system

    • 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

    • 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

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

    • getTypeSelector

      public @NonNull String getTypeSelector()
      Specified by:
      getTypeSelector in interface StyleableBean

    • isSuitableParent

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

    • getBoundsInLocal

      public @NonNull javafx.geometry.Bounds getBoundsInLocal()
      Description copied from interface: Figure
      The bounds of this figure in local coordinates, including space required for a non-zero stroke.
      Specified by:
      getBoundsInLocal in interface Figure
      Returns:
      the local bounds