com.itextpdf.layout.Document Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2023 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see
* A {@link Document}'s rendering behavior can be modified by extending
* {@link DocumentRenderer} and setting an instance of this newly created with
* {@link #setRenderer(com.itextpdf.layout.renderer.DocumentRenderer) }.
*/
public class Document extends RootElement {
/**
* Creates a document from a {@link PdfDocument}. Initializes the first page
* with the {@link PdfDocument}'s current default {@link PageSize}.
*
* @param pdfDoc the in-memory representation of the PDF document
*/
public Document(PdfDocument pdfDoc) {
this(pdfDoc, pdfDoc.getDefaultPageSize());
}
/**
* Creates a document from a {@link PdfDocument} with a manually set {@link
* PageSize}.
*
* @param pdfDoc the in-memory representation of the PDF document
* @param pageSize the page size
*/
public Document(PdfDocument pdfDoc, PageSize pageSize) {
this(pdfDoc, pageSize, true);
}
/**
* Creates a document from a {@link PdfDocument} with a manually set {@link
* PageSize}.
*
* @param pdfDoc the in-memory representation of the PDF document
* @param pageSize the page size
* @param immediateFlush if true, write pages and page-related instructions
* to the {@link PdfDocument} as soon as possible.
*/
public Document(PdfDocument pdfDoc, PageSize pageSize, boolean immediateFlush) {
super();
this.pdfDocument = pdfDoc;
this.pdfDocument.setDefaultPageSize(pageSize);
this.immediateFlush = immediateFlush;
}
/**
* Closes the document and associated PdfDocument.
*/
@Override
public void close() {
if (rootRenderer != null) {
rootRenderer.close();
}
pdfDocument.close();
}
/**
* Terminates the current element, usually a page. Sets the next element
* to be the size specified in the argument.
*
* @param areaBreak an {@link AreaBreak}, optionally with a specified size
* @return this element
*/
public Document add(AreaBreak areaBreak) {
checkClosingStatus();
childElements.add(areaBreak);
ensureRootRendererNotNull().addChild(areaBreak.createRendererSubTree());
if (immediateFlush) {
childElements.remove(childElements.size() - 1);
}
return this;
}
@Override
public Document add(IBlockElement element) {
checkClosingStatus();
super.add(element);
if (element instanceof ILargeElement) {
((ILargeElement) element).setDocument(this);
((ILargeElement) element).flushContent();
}
return this;
}
/**
* Gets PDF document.
*
* @return the in-memory representation of the PDF document
*/
public PdfDocument getPdfDocument() {
return pdfDocument;
}
/**
* Changes the {@link DocumentRenderer} at runtime. Use this to customize
* the Document's {@link IRenderer} behavior.
*
* @param documentRenderer the DocumentRenderer to set
*/
public void setRenderer(DocumentRenderer documentRenderer) {
this.rootRenderer = documentRenderer;
}
/**
* Forces all registered renderers (including child element renderers) to
* flush their contents to the content stream.
*/
public void flush() {
rootRenderer.flush();
}
/**
* 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 {@link #immediateFlush} to true.
*/
public void relayout() {
if (immediateFlush) {
throw new IllegalStateException("Operation not supported with immediate flush");
}
if (rootRenderer instanceof DocumentRenderer) {
((DocumentRenderer) rootRenderer).getTargetCounterHandler().prepareHandlerToRelayout();
}
IRenderer nextRelayoutRenderer = rootRenderer != null ? rootRenderer.getNextRenderer() : null;
if (nextRelayoutRenderer == null || !(nextRelayoutRenderer instanceof RootRenderer)) {
nextRelayoutRenderer = new DocumentRenderer(this, immediateFlush);
}
// Even though #relayout() only makes sense when immediateFlush=false and therefore no elements
// should have been written to document, still empty pages are created during layout process
// because we need to know the effective page size which may differ from page to page.
// Therefore, we remove all the pages that might have been created before proceeding to relayout elements.
while (pdfDocument.getNumberOfPages() > 0) {
pdfDocument.removePage(pdfDocument.getNumberOfPages());
}
rootRenderer = (RootRenderer) nextRelayoutRenderer;
for (IElement element : childElements) {
createAndAddRendererSubTree(element);
}
}
/**
* Gets the left margin, measured in points
*
* @return a float containing the left margin value
*/
public float getLeftMargin() {
Float property = this.getProperty(Property.MARGIN_LEFT);
return (float) (property != null ? property : this.getDefaultProperty(Property.MARGIN_LEFT));
}
/**
* Sets the left margin, measured in points
*
* @param leftMargin a float containing the new left margin value
*/
public void setLeftMargin(float leftMargin) {
setProperty(Property.MARGIN_LEFT, leftMargin);
}
/**
* Gets the right margin, measured in points
*
* @return a float containing the right margin value
*/
public float getRightMargin() {
Float property = this.getProperty(Property.MARGIN_RIGHT);
return (float) (property != null ? property : this.getDefaultProperty(Property.MARGIN_RIGHT));
}
/**
* Sets the right margin, measured in points
*
* @param rightMargin a float containing the new right margin value
*/
public void setRightMargin(float rightMargin) {
setProperty(Property.MARGIN_RIGHT, rightMargin);
}
/**
* Gets the top margin, measured in points
*
* @return a float containing the top margin value
*/
public float getTopMargin() {
Float property = this.getProperty(Property.MARGIN_TOP);
return (float) (property != null ? property : this.getDefaultProperty(Property.MARGIN_TOP));
}
/**
* Sets the top margin, measured in points
*
* @param topMargin a float containing the new top margin value
*/
public void setTopMargin(float topMargin) {
setProperty(Property.MARGIN_TOP, topMargin);
}
/**
* Gets the bottom margin, measured in points
*
* @return a float containing the bottom margin value
*/
public float getBottomMargin() {
Float property = this.getProperty(Property.MARGIN_BOTTOM);
return (float) (property != null ? property : this.getDefaultProperty(Property.MARGIN_BOTTOM));
}
/**
* Sets the bottom margin, measured in points
*
* @param bottomMargin a float containing the new bottom margin value
*/
public void setBottomMargin(float bottomMargin) {
setProperty(Property.MARGIN_BOTTOM, bottomMargin);
}
/**
* Convenience method to set all margins with one method.
*
* @param topMargin the upper margin
* @param rightMargin the right margin
* @param leftMargin the left margin
* @param bottomMargin the lower margin
*/
public void setMargins(float topMargin, float rightMargin, float bottomMargin, float leftMargin) {
setTopMargin(topMargin);
setRightMargin(rightMargin);
setBottomMargin(bottomMargin);
setLeftMargin(leftMargin);
}
/**
* 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.
*
* @param pageSize the size of the page to
* @return a {@link Rectangle} with the required dimensions and origin point
*/
public Rectangle getPageEffectiveArea(PageSize pageSize) {
float x = pageSize.getLeft() + getLeftMargin();
float y = pageSize.getBottom() + getBottomMargin();
float width = pageSize.getWidth() - getLeftMargin() - getRightMargin();
float height = pageSize.getHeight() - getBottomMargin() - getTopMargin();
return new Rectangle(x, y, width, height);
}
@Override
public T1 getDefaultProperty(int property) {
switch (property) {
case Property.MARGIN_BOTTOM:
case Property.MARGIN_LEFT:
case Property.MARGIN_RIGHT:
case Property.MARGIN_TOP:
return (T1) (Object) 36f;
default:
return super.getDefaultProperty(property);
}
}
@Override
protected RootRenderer ensureRootRendererNotNull() {
if (rootRenderer == null)
rootRenderer = new DocumentRenderer(this, immediateFlush);
return rootRenderer;
}
/**
* Checks whether a method is invoked at the closed document
*/
protected void checkClosingStatus() {
if (getPdfDocument().isClosed()) {
throw new PdfException(LayoutExceptionMessageConstant.DOCUMENT_CLOSED_IT_IS_IMPOSSIBLE_TO_EXECUTE_ACTION);
}
}
}