com.helger.pdflayout.PageLayoutPDF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-pdf-layout Show documentation
Show all versions of ph-pdf-layout Show documentation
Library for creating nicely layouted PDF documents based on PDFBox
/**
* Copyright (C) 2014-2016 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.pdflayout;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Calendar;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.WillClose;
import javax.annotation.concurrent.NotThreadSafe;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDDocumentInformation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.ext.CommonsArrayList;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.io.stream.StreamHelper;
import com.helger.commons.state.EChange;
import com.helger.commons.string.StringHelper;
import com.helger.commons.vendor.VendorInfo;
import com.helger.pdflayout.element.PLPageSet;
import com.helger.pdflayout.element.PLPageSet.PageSetPrepareResult;
import com.helger.pdflayout.render.PreparationContextGlobal;
/**
* Main class for creating layouted PDFs. This class contains the meta data as
* well as a list of {@link PLPageSet} objects that represent a set of pages
* with a consistent layouting scheme.
*
* @author Philip Helger
*/
@NotThreadSafe
public class PageLayoutPDF
{
private static final Logger s_aLogger = LoggerFactory.getLogger (PageLayoutPDF.class);
private String m_sDocumentAuthor;
private Calendar m_aDocumentCreationDate;
private String m_sDocumentCreator;
private String m_sDocumentTitle;
private String m_sDocumentKeywords;
private String m_sDocumentSubject;
private boolean m_bDebug = false;
private final ICommonsList m_aPageSets = new CommonsArrayList<> ();
/**
* Constructor. Initializes Author, CreationDate and Creator from class
* {@link VendorInfo}.
*/
public PageLayoutPDF ()
{
m_sDocumentAuthor = VendorInfo.getVendorName () + " " + VendorInfo.getVendorURLWithoutProtocol ();
m_aDocumentCreationDate = Calendar.getInstance ();
m_sDocumentCreator = VendorInfo.getVendorName ();
}
/**
* @return debug mode is active. This will draw additional box lines on the
* PDF.
*/
public boolean isDebug ()
{
return m_bDebug;
}
/**
* @param bDebug
* true to enable PDF debug mode, false to
* disable it.
* @return this for chaining
*/
@Nonnull
public PageLayoutPDF setDebug (final boolean bDebug)
{
m_bDebug = bDebug;
return this;
}
@Nullable
public String getDocumentAuthor ()
{
return m_sDocumentAuthor;
}
public void setDocumentAuthor (@Nullable final String sDocumentAuthor)
{
m_sDocumentAuthor = sDocumentAuthor;
}
@Nullable
public Calendar getDocumentCreationDate ()
{
return m_aDocumentCreationDate;
}
public void setDocumentCreationDate (@Nullable final Calendar aDocumentCreationDate)
{
m_aDocumentCreationDate = aDocumentCreationDate;
}
@Nullable
public String getDocumentCreator ()
{
return m_sDocumentCreator;
}
public void setDocumentCreator (@Nullable final String sDocumentCreator)
{
m_sDocumentCreator = sDocumentCreator;
}
@Nullable
public String getDocumentTitle ()
{
return m_sDocumentTitle;
}
public void setDocumentTitle (@Nullable final String sDocumentTitle)
{
m_sDocumentTitle = sDocumentTitle;
}
@Nullable
public String getDocumentKeywords ()
{
return m_sDocumentKeywords;
}
public void setDocumentKeywords (@Nullable final String sDocumentKeywords)
{
m_sDocumentKeywords = sDocumentKeywords;
}
@Nullable
public String getDocumentSubject ()
{
return m_sDocumentSubject;
}
public void setDocumentSubject (@Nullable final String sDocumentSubject)
{
m_sDocumentSubject = sDocumentSubject;
}
@Nonnull
@ReturnsMutableCopy
public ICommonsList getAllPageSets ()
{
return m_aPageSets.getClone ();
}
/**
* Add a new page set
*
* @param aPageSet
* The page set to be added. May not be null.
*/
public void addPageSet (@Nonnull final PLPageSet aPageSet)
{
ValueEnforcer.notNull (aPageSet, "PageSet");
m_aPageSets.add (aPageSet);
}
@Nonnull
public EChange removePageSet (@Nullable final PLPageSet aPageSet)
{
return m_aPageSets.removeObject (aPageSet);
}
/**
* Render this layout to an OutputStream.
*
* @param aOS
* The output stream to write to. May not be null. Is
* closed automatically.
* @throws PDFCreationException
* In case of an error
*/
public void renderTo (@Nonnull @WillClose final OutputStream aOS) throws PDFCreationException
{
renderTo ((IPDDocumentCustomizer) null, aOS);
}
/**
* Render this layout to an OutputStream.
*
* @param aCustomizer
* The customizer to be invoked before the document is written to the
* stream. May be null.
* @param aOS
* The output stream to write to. May not be null. Is
* closed automatically.
* @throws PDFCreationException
* In case of an error
*/
public void renderTo (@Nullable final IPDDocumentCustomizer aCustomizer,
@Nonnull @WillClose final OutputStream aOS) throws PDFCreationException
{
ValueEnforcer.notNull (aOS, "OutputStream");
// Small consistency check to avoid creating empty, invalid PDFs
int nTotalElements = 0;
for (final PLPageSet aPageSet : m_aPageSets)
nTotalElements += aPageSet.getElementCount ();
if (nTotalElements == 0)
throw new PDFCreationException ("All page sets are empty!");
// create a new document
try (final PDDocument aDoc = new PDDocument (); final OutputStream aBufferedOS = StreamHelper.getBuffered (aOS))
{
// Set document properties
{
final PDDocumentInformation aProperties = new PDDocumentInformation ();
if (StringHelper.hasText (m_sDocumentAuthor))
aProperties.setAuthor (m_sDocumentAuthor);
if (m_aDocumentCreationDate != null)
aProperties.setCreationDate (m_aDocumentCreationDate);
if (StringHelper.hasText (m_sDocumentCreator))
aProperties.setCreator (m_sDocumentCreator);
if (StringHelper.hasText (m_sDocumentTitle))
aProperties.setTitle (m_sDocumentTitle);
if (StringHelper.hasText (m_sDocumentKeywords))
aProperties.setKeywords (m_sDocumentKeywords);
if (StringHelper.hasText (m_sDocumentSubject))
aProperties.setSubject (m_sDocumentSubject);
aProperties.setProducer (PLConfig.PROJECT_NAME + " " + PLConfig.PROJECT_VERSION + " - " + PLConfig.PROJECT_URL);
// add the created properties
aDoc.setDocumentInformation (aProperties);
}
// Prepare all page sets
final PreparationContextGlobal aGlobalCtx = new PreparationContextGlobal (aDoc);
final PageSetPrepareResult [] aPRs = new PageSetPrepareResult [m_aPageSets.size ()];
int nPageSetIndex = 0;
int nTotalPageCount = 0;
for (final PLPageSet aPageSet : m_aPageSets)
{
final PageSetPrepareResult aPR = aPageSet.prepareAllPages (aGlobalCtx);
aPRs[nPageSetIndex] = aPR;
nTotalPageCount += aPR.getPageCount ();
nPageSetIndex++;
}
// Start applying all page sets - real rendering
nPageSetIndex = 0;
int nTotalPageIndex = 0;
for (final PLPageSet aPageSet : m_aPageSets)
{
final PageSetPrepareResult aPR = aPRs[nPageSetIndex];
aPageSet.renderAllPages (aPR, aDoc, m_bDebug, nPageSetIndex, nTotalPageIndex, nTotalPageCount);
// Inc afterwards
nTotalPageIndex += aPR.getPageCount ();
nPageSetIndex++;
}
// Customize the whole document (optional)
if (aCustomizer != null)
aCustomizer.customizeDocument (aDoc);
// save document to output stream
aDoc.save (aBufferedOS);
if (s_aLogger.isDebugEnabled ())
s_aLogger.debug ("PDF successfully created");
}
catch (final IOException ex)
{
throw new PDFCreationException ("IO Error", ex);
}
catch (final Throwable t)
{
throw new PDFCreationException ("Internal error", t);
}
}
}