Package com.itextpdf.layout

Class Document

java.lang.Object
com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement
com.itextpdf.layout.ElementPropertyContainer
com.itextpdf.layout.RootElement<Document>
com.itextpdf.layout.Document
All Implemented Interfaces:
IPropertyContainer, Closeable, AutoCloseable
public class Document extends RootElement<Document>
Document is the default root element when creating a self-sufficient PDF. It mainly operates high-level operations e.g. setting page size and rotation, adding elements, and writing text at specific coordinates. It has no knowledge of the actual PDF concepts and syntax.

A Document's rendering behavior can be modified by extending DocumentRenderer and setting an instance of this newly created with setRenderer(com.itextpdf.layout.renderer.DocumentRenderer).

  • Constructor Details

    • Document

      public Document (PdfDocument pdfDoc)
      Creates a document from a PdfDocument. Initializes the first page with the PdfDocument's current default PageSize.
      Parameters:
      pdfDoc - the in-memory representation of the PDF document

    • Document

      public Document (PdfDocument pdfDoc, PageSize pageSize)
      Creates a document from a PdfDocument with a manually set PageSize.
      Parameters:
      pdfDoc - the in-memory representation of the PDF document
      pageSize - the page size

    • Document

      public Document (PdfDocument pdfDoc, PageSize pageSize, boolean immediateFlush)
      Creates a document from a PdfDocument with a manually set PageSize.
      Parameters:
      pdfDoc - the in-memory representation of the PDF document
      pageSize - the page size
      immediateFlush - if true, write pages and page-related instructions to the PdfDocument as soon as possible.

  • Method Details

    • close

      public void close()
      Closes the document and associated PdfDocument.

    • add

      public Document add (AreaBreak areaBreak)
      Terminates the current element, usually a page. Sets the next element to be the size specified in the argument.
      Parameters:
      areaBreak - an AreaBreak, optionally with a specified size
      Returns:
      this element

    • add

      public Document add (SectionBreak sectionBreak)
      Terminates the current page if it's not the first one in the document. Sets the page size and/or page margins specified in the arguments for the next page.
      Parameters:
      sectionBreak - SectionBreak, optionally with a specified page size and/or page margins
      Returns:
      this same Document instance

    • add

      public Document add (IBlockElement element)
      Description copied from class: RootElement
      Adds an element to the root. The element is immediately placed in the contents.
      Overrides:
      add in class RootElement<Document>
      Parameters:
      element - an element with spacial margins, tabbing, and alignment
      Returns:
      this element
      See Also:

    • getPdfDocument

      public PdfDocument getPdfDocument()
      Gets PDF document.
      Returns:
      the in-memory representation of the PDF document

    • setRenderer

      public void setRenderer (DocumentRenderer documentRenderer)
      Changes the DocumentRenderer at runtime. Use this to customize the Document's IRenderer behavior.
      Parameters:
      documentRenderer - the DocumentRenderer to set

    • flush

      public void flush()
      Forces all registered renderers (including child element renderers) to flush their contents to the content stream.

    • relayout

      public void relayout()
      Performs an entire recalculation of the document flow, taking into account all its current child elements. May become very resource-intensive for large documents.

      Do not use when you have set RootElement.immediateFlush to true.

    • getLeftMargin

      public float getLeftMargin()
      Gets the left margin, measured in points
      Returns:
      a float containing the left margin value

    • setLeftMargin

      public void setLeftMargin (float leftMargin)
      Sets the left margin, measured in points
      Parameters:
      leftMargin - a float containing the new left margin value

    • getRightMargin

      public float getRightMargin()
      Gets the right margin, measured in points
      Returns:
      a float containing the right margin value

    • setRightMargin

      public void setRightMargin (float rightMargin)
      Sets the right margin, measured in points
      Parameters:
      rightMargin - a float containing the new right margin value

    • getTopMargin

      public float getTopMargin()
      Gets the top margin, measured in points
      Returns:
      a float containing the top margin value

    • setTopMargin

      public void setTopMargin (float topMargin)
      Sets the top margin, measured in points
      Parameters:
      topMargin - a float containing the new top margin value

    • getBottomMargin

      public float getBottomMargin()
      Gets the bottom margin, measured in points
      Returns:
      a float containing the bottom margin value

    • setBottomMargin

      public void setBottomMargin (float bottomMargin)
      Sets the bottom margin, measured in points
      Parameters:
      bottomMargin - a float containing the new bottom margin value

    • setMargins

      public void setMargins (float topMargin, float rightMargin, float bottomMargin, float leftMargin)
      Convenience method to set all margins with one method.
      Parameters:
      topMargin - the upper margin
      rightMargin - the right margin
      leftMargin - the left margin
      bottomMargin - the lower margin

    • getPageMargins

      public PageMarginBoxes getPageMargins (int pageNumber)
      Gets page margins by specified page number.
      Parameters:
      pageNumber - number of the page to get margins for
      Returns:
      PageMarginBoxes page margins

    • setPageMargins

      public Document setPageMargins (int pageNumber, PageMarginBoxes margins)
      Sets page margins for page with provided number.
      Parameters:
      pageNumber - number of the page to set margins for
      margins - PageMarginBoxes page margins to set
      Returns:
      this same Document instance

    • setPageMargins

      public Document setPageMargins (Predicate<Integer> condition, PageMarginBoxes margins)
      Sets page margins for page based on provided condition for page number.
      Parameters:
      condition - matching rule with page number as argument
      margins - PageMarginBoxes page margins to set
      Returns:
      this same Document instance

    • setPageMargins

      public Document setPageMargins (Function<Integer,PageMarginBoxes> function)
      Sets page margins for page based on provided function for page number.
      Parameters:
      function - function with page number as argument, return null in case result should be ignored and PageMarginBoxes page margins return value
      Returns:
      this same Document instance

    • isPageMarginsSpecified

      public boolean isPageMarginsSpecified (int pageNumber)
      Checks whether page margins have been specified for the given page number.

      This method returns true if the margins for the page are determined by any of the following mechanisms (in order of precedence):

      1. Explicitly set margins for page number via setPageMargins(int, PageMarginBoxes)
      2. Matching rule set via setPageMargins(Predicate, PageMarginBoxes)
      3. Function set via setPageMargins(Function)

      NOTE: the method returns true even if the value produced by the mechanisms is null. Only when none of the above apply and the default static margins are used, this method returns false.

      Parameters:
      pageNumber - the page number to check
      Returns:
      true if margins for the page are defined explicitly by page number, by matching rule or by function, false otherwise

    • getFootnotesProperties

      public FootnotesProperties getFootnotesProperties()
      Gets FootnotesProperties specified for the document to customize footnotes.
      Returns:
      FootnotesProperties specified for the document

    • setFootnotesProperties

      public void setFootnotesProperties (FootnotesProperties footnotesProperties)
      Sets FootnotesProperties for the document.
      Parameters:
      footnotesProperties - FootnotesProperties to customize footnotes

    • getPageEffectiveArea

      public Rectangle getPageEffectiveArea (PageSize pageSize)
      Returns the area that will actually be used to write on the page, given the current margins. Does not have any side effects on the document.
      Parameters:
      pageSize - the size of the page to
      Returns:
      a Rectangle with the required dimensions and origin point

    • getDefaultProperty

      public  T1 getDefaultProperty (int property)
      Description copied from interface: IPropertyContainer
      Gets the default property from this entity.
      Specified by:
      getDefaultProperty in interface IPropertyContainer
      Overrides:
      getDefaultProperty in class RootElement<Document>
      Type Parameters:
      T1 - the return type associated with the property
      Parameters:
      property - the property to be retrieved
      Returns:
      the default property value. If the default property is not defined, null will be returned

    • ensureRootRendererNotNull

      protected RootRenderer ensureRootRendererNotNull()
      Specified by:
      ensureRootRendererNotNull in class RootElement<Document>

    • checkClosingStatus

      protected void checkClosingStatus()
      Checks whether a method is invoked at the closed document