Package com.itextpdf.layout.properties.margins

Class PageMarginBoxes

java.lang.Object
com.itextpdf.layout.properties.margins.PageMarginBoxes
public class PageMarginBoxes extends Object
Class to store information about all page margin boxes for a single page.

  • Constructor Details

  • Method Details

    • draw

      public static void draw (IRenderer marginRenderer, Rectangle marginRect, DocumentRenderer documentRenderer, PdfDocument document, int pageNumber, String marginBoxName)
      Draws all page margins for the page specified via page number.
      Parameters:
      marginRenderer - renderer for the margin content to draw
      marginRect - page margin box rectangle
      documentRenderer - document renderer to use as parent for margin renderer
      document - PdfDocument to which content is written
      pageNumber - page number
      marginBoxName - string value representing margin box name (defining its position on the page)

    • createRendererFromElement

      public static IRenderer createRendererFromElement (IElement element, DocumentRenderer documentRenderer, PdfDocument pdfDocument)
      Creates renderer from element excluding page breaks and adds tagging tree hints.
      Parameters:
      element - IElement to create renderer for
      documentRenderer - document renderer to use as parent for margin renderer
      pdfDocument - PdfDocument to which content is written
      Returns:
      created IRenderer

    • getPageMarginContent

      public PageMarginContent getPageMarginContent (MarginBoxName marginBoxName)
      Gets page margin content PageMarginContent by margin box name.
      Parameters:
      marginBoxName - MarginBoxName margin box name to get content for
      Returns:
      page margin content PageMarginContent by margin box name

    • getMarginSizes

      public float[] getMarginSizes()
      Gets page margin sizes in top, right, bottom, left order.
      Returns:
      array of float top, right, bottom, left margin sizes

    • setMarginSizes

      public PageMarginBoxes setMarginSizes (float[] marginSizes)
      Sets page margin sizes in top, right, bottom, left order.
      Parameters:
      marginSizes - array of float top, right, bottom, left margin sizes
      Returns:
      this same PageMarginBoxes instance

    • layout

      public float[] layout (DocumentRenderer documentRenderer, int pageNumber, Rectangle pageSize)
      Layouts all page margins to calculate their occupied area and page margin sizes.
      Parameters:
      documentRenderer - DocumentRenderer renderer for the document to which content will be written
      pageNumber - page number
      pageSize - page size
      Returns:
      float array of top, right, bottom, left margin sizes

    • draw

      public void draw (DocumentRenderer documentRenderer, PdfDocument document, int pageNumber)
      Draws all page margins for the page specified via page number.
      Parameters:
      documentRenderer - document renderer to use as parent for margin renderer
      document - PdfDocument to which content is written
      pageNumber - page number

    • setPageMarginTagRole

      protected void setPageMarginTagRole (IElement element)
      Sets the role of the page margin element to use in the document tag tree.
      Parameters:
      element - IElement to set role for

    • equals

      public boolean equals (Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object