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

Class ImageFigure

java.lang.Object
org.jhotdraw8.fxbase.styleable.AbstractStyleablePropertyBean
org.jhotdraw8.draw.figure.AbstractFigure
org.jhotdraw8.draw.figure.AbstractLeafFigure
org.jhotdraw8.draw.figure.ImageFigure
All Implemented Interfaces:
CompositableFigure, ConnectableFigure, Figure, HideableFigure, ImageableFigure, LockableFigure, ResizableFigure, StyleableFigure, TransformableFigure, TransformCachingFigure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>
public class ImageFigure extends AbstractLeafFigure implements ResizableFigure, TransformableFigure, StyleableFigure, LockableFigure, CompositableFigure, ConnectableFigure, HideableFigure, ImageableFigure
ImageFigure presents a bitmap image on a drawing.
Author:
Werner Randelshofer

  • Field Details

  • Constructor Details

    • ImageFigure

      public ImageFigure()

    • ImageFigure

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

    • ImageFigure

      public ImageFigure(CssRectangle2D rect)

  • Method Details

    • getCssLayoutBounds

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

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

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

    • findConnector

      public @Nullable Connector findConnector(@NonNull javafx.geometry.Point2D p, Figure prototype, double tolerance)
      Description copied from interface: ConnectableFigure
      Gets a connector for this figure at the given location.
      Specified by:
      findConnector in interface ConnectableFigure
      Parameters:
      p - the location of the connector in local coordinates.
      prototype - The connecting figure or null if unknown. This allows for specific connectors for different connection figures.
      tolerance - tolerance in world coordinates
      Returns:
      Returns the connector. Returns null if there is no connector at the given location.

    • getTypeSelector

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

    • getPreferredAspectRatio

      public double getPreferredAspectRatio()
      Description copied from interface: Figure
      Returns the preferred aspect ratio of the figure. The aspect ratio is defined as the height divided by the width of the figure. If a figure does not have a preference it should return its current aspect ratio.
      Specified by:
      getPreferredAspectRatio in interface Figure
      Returns:
      the preferred aspect ratio of the figure.

    • 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