com.helger.pdflayout.render.RenderingContext 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.render;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import org.apache.pdfbox.pdmodel.PDDocument;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.ext.CommonsLinkedHashMap;
import com.helger.commons.collection.ext.ICommonsOrderedMap;
import com.helger.commons.string.StringParser;
import com.helger.pdflayout.pdfbox.PDPageContentStreamWithCache;
/**
* This class contains the context for rendering a single element onto the PDF.
*
* @author Philip Helger
*/
@NotThreadSafe
public final class RenderingContext
{
private final ERenderingElementType m_eElementType;
private final PDPageContentStreamWithCache m_aCS;
private final boolean m_bDebugMode;
private final float m_fStartLeft;
private final float m_fStartTop;
private final float m_fWidth;
private final float m_fHeight;
private final ICommonsOrderedMap m_aPlaceholders = new CommonsLinkedHashMap<> ();
/**
* @param aCtx
* Context to copy settings from. May not be null.
* @param fStartLeft
* Absolute page x-start position with element x-margin but without
* element x-padding
* @param fStartTop
* Absolute page y-start position with element y-margin but without
* element y-padding
* @param fWidth
* width without margin but including x-padding of the surrounding
* element
* @param fHeight
* height without margin but including y-padding of the surrounding
* element
*/
public RenderingContext (@Nonnull final RenderingContext aCtx,
final float fStartLeft,
final float fStartTop,
final float fWidth,
final float fHeight)
{
this (aCtx.getElementType (),
aCtx.getContentStream (),
aCtx.isDebugMode (),
fStartLeft,
fStartTop,
fWidth,
fHeight);
m_aPlaceholders.putAll (aCtx.m_aPlaceholders);
}
/**
* @param eElementType
* Element type. May not be null.
* @param aCS
* Page content stream. May not be null.
* @param bDebugMode
* debug mode?
* @param fStartLeft
* Absolute page x-start position with element x-margin and x-border
* but without element x-padding
* @param fStartTop
* Absolute page y-start position with element y-margin and y-border
* but without element y-padding
* @param fWidth
* width without margin and border but including padding of the
* surrounding element
* @param fHeight
* width without margin and border but including padding of the
* surrounding element
*/
public RenderingContext (@Nonnull final ERenderingElementType eElementType,
@Nonnull final PDPageContentStreamWithCache aCS,
final boolean bDebugMode,
final float fStartLeft,
final float fStartTop,
final float fWidth,
final float fHeight)
{
ValueEnforcer.notNull (eElementType, "ElementType");
ValueEnforcer.notNull (aCS, "ContentStream");
m_eElementType = eElementType;
m_aCS = aCS;
m_bDebugMode = bDebugMode;
m_fStartLeft = fStartLeft;
m_fStartTop = fStartTop;
m_fWidth = fWidth;
m_fHeight = fHeight;
}
/**
* @return The type of the element currently rendered. Never null
* .
*/
@Nonnull
public ERenderingElementType getElementType ()
{
return m_eElementType;
}
/**
* @return The current content stream to write to. Never null.
*/
@Nonnull
public PDPageContentStreamWithCache getContentStream ()
{
return m_aCS;
}
/**
* @return The underlying PDF document. Never null.
*/
@Nonnull
public PDDocument getDocument ()
{
return m_aCS.getDocument ();
}
/**
* @return true if debug output should be emitted into the PDF,
* false otherwise.
*/
public boolean isDebugMode ()
{
return m_bDebugMode;
}
/**
* Get the placeholder value with the specified name.
*
* @param sName
* The name to search. May be null.
* @return null if no such placeholder exists.
*/
@Nullable
public String getPlaceholder (final String sName)
{
return m_aPlaceholders.get (sName);
}
public int getPlaceholderAsInt (@Nullable final String sName, final int nDefault)
{
return StringParser.parseInt (getPlaceholder (sName), nDefault);
}
@Nonnull
@ReturnsMutableCopy
public ICommonsOrderedMap getAllPlaceholders ()
{
return m_aPlaceholders.getClone ();
}
@Nonnull
public RenderingContext setPlaceholder (@Nonnull @Nonempty final String sName, final int nValue)
{
return setPlaceholder (sName, Integer.toString (nValue));
}
@Nonnull
public RenderingContext setPlaceholder (@Nonnull @Nonempty final String sName, @Nonnull final String sValue)
{
ValueEnforcer.notEmpty (sName, "Name");
ValueEnforcer.notNull (sValue, "Value");
m_aPlaceholders.put (sName, sValue);
return this;
}
/**
* @return Absolute page x-start position with element x-margin but without
* element x-padding
*/
public float getStartLeft ()
{
return m_fStartLeft;
}
/**
* @return Absolute page y-start position with element y-margin but without
* element y-padding
*/
public float getStartTop ()
{
return m_fStartTop;
}
/**
* @return width without margin but including padding of the surrounding
* element
*/
public float getWidth ()
{
return m_fWidth;
}
/**
* @return width without margin but including padding of the surrounding
* element
*/
public float getHeight ()
{
return m_fHeight;
}
}