Package com.itextpdf.layout.renderer

Class AreaBreakRenderer

java.lang.Object
com.itextpdf.layout.renderer.AbstractBreakRenderer
com.itextpdf.layout.renderer.AreaBreakRenderer
All Implemented Interfaces:
IPropertyContainer, IRenderer
public class AreaBreakRenderer extends AbstractBreakRenderer
Renderer for the AreaBreak layout element. Will terminate the current content area and initialize a new one.

  • Field Details

  • Constructor Details

    • AreaBreakRenderer

      public AreaBreakRenderer (AreaBreak areaBreak)
      Creates an AreaBreakRenderer.
      Parameters:
      areaBreak - the AreaBreak that will be rendered by this object

  • Method Details

    • addChild

      public void addChild (IRenderer renderer)
      Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area.
      Parameters:
      renderer - a child to be added

    • layout

      public LayoutResult layout (LayoutContext layoutContext)
      Description copied from interface: IRenderer
      This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.
      Parameters:
      layoutContext - the description of layout area and any other additional information
      Returns:
      result of the layout process

    • draw

      public void draw (DrawContext drawContext)
      Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area.
      Parameters:
      drawContext - contains the PdfDocument to which the renderer subtree if flushed, the PdfCanvas on which the renderer subtree is drawn and other additional parameters needed to perform drawing

    • getOccupiedArea

      public LayoutArea getOccupiedArea()
      Throws an UnsupportedOperationException if not ignored, because instances of this class are only used for terminating the current content area.
      Returns:
      LayoutArea instance

    • getModelElement

      public IPropertyContainer getModelElement()
      Description copied from interface: IRenderer
      Gets the model element associated with this renderer.
      Returns:
      the model element, as a container of properties

    • move

      public void move (float dx, float dy)
      Logs a warning about unexpected use of AreaBreakRenderer if not ignored, because instances of this class are only used for terminating the current content area.
      Parameters:
      dx - the x-axis offset in points. Positive value will move the renderer subtree to the right.
      dy - the y-axis offset in points. Positive value will move the renderer subtree to the top.

    • getNextRenderer

      public IRenderer getNextRenderer()
      Description copied from interface: IRenderer
      Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.
      Returns:
      new renderer instance