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

Interface Page

All Superinterfaces:
Figure, PropertyBean, StyleableBean, StyleablePropertyBean, TreeNode<Figure>
All Known Implementing Classes:
PageFigure
public interface Page extends Figure
Defines a page layout for printing.

The layout may be used for multiple pages, for example for continuous form paper.

The parent of a page must be a Layer. A page may have children.

Author:
Werner Randelshofer

  • Field Details

    • PAPERS

      static final List<javafx.print.Paper> PAPERS
      List of all available papers.

  • Method Details

    • createPageNode

      @NonNull javafx.scene.Node createPageNode(int internalPageNumber)
      Returns a node which will be placed on the paper.
      Parameters:
      internalPageNumber - the internal page number
      Returns:
      a new node

    • createPaper

      default javafx.print.Paper createPaper(int internalPageNumber)
      Creates a paper for the specified page.
      Parameters:
      internalPageNumber - the internal page number
      Returns:
      the internal page number

    • getNumberOfSubPages

      int getNumberOfSubPages()
      Returns the number of sub-pages defined by this page.
      Returns:
      number of internal pages

    • getPageBounds

      @NonNull javafx.geometry.Bounds getPageBounds(int internalPageNumber)
      Returns the bounds for the page content.
      Parameters:
      internalPageNumber - the internal page number
      Returns:
      the clipping region

    • getPageClip

      @NonNull javafx.scene.shape.Shape getPageClip(int internalPageNumber)
      Returns the clip for the page content.
      Parameters:
      internalPageNumber - the internal page number
      Returns:
      the clipping region

    • getPageTransform

      javafx.scene.transform.Transform getPageTransform(int internalPageNumber)
      Returns a transform which will position the drawing contents inside the clip on the page.
      Parameters:
      internalPageNumber - the internal page number
      Returns:
      the transform

    • getPaperSize

      CssDimension2D getPaperSize()
      Returns the paper size.
      Returns:
      the page size

    • isAllowsChildren

      default boolean isAllowsChildren()
      Description copied from interface: Figure
      Whether children may be added to this figure.
      Specified by:
      isAllowsChildren in interface Figure
      Returns:
      true if getChildren are allowed

    • isSuitableParent

      default 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 TreeNode<Figure>
      Parameters:
      newParent - The new parent figure.
      Returns:
      true if newParent is an acceptable parent