com.helger.pdflayout.render

Class RenderingContext

java.lang.Object

com.helger.pdflayout.render.RenderingContext

@NotThreadSafe
public final class RenderingContext
extends Object

This class contains the context for rendering a single element onto the PDF.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
RenderingContext(ERenderingElementType eElementType, PDPageContentStreamWithCache aCS, boolean bDebugMode, float fStartLeft, float fStartTop, float fWidth, float fHeight)
RenderingContext(RenderingContext aCtx, float fStartLeft, float fStartTop, float fWidth, float fHeight)

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.ext.ICommonsOrderedMap<String,String>	getAllPlaceholders()
PDPageContentStreamWithCache	getContentStream()
org.apache.pdfbox.pdmodel.PDDocument	getDocument()
ERenderingElementType	getElementType()
float	getHeight()
String	getPlaceholder(String sName) Get the placeholder value with the specified name.
int	getPlaceholderAsInt(String sName, int nDefault)
float	getStartLeft()
float	getStartTop()
float	getWidth()
boolean	isDebugMode()
RenderingContext	setPlaceholder(String sName, int nValue)
RenderingContext	setPlaceholder(String sName, String sValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RenderingContext

public RenderingContext(@Nonnull
                        RenderingContext aCtx,
                        float fStartLeft,
                        float fStartTop,
                        float fWidth,
                        float fHeight)

Parameters:

aCtx - Context to copy settings from. May not be null.

fStartLeft - Absolute page x-start position with element x-margin but without element x-padding

fStartTop - Absolute page y-start position with element y-margin but without element y-padding

fWidth - width without margin but including x-padding of the surrounding element

fHeight - height without margin but including y-padding of the surrounding element

RenderingContext

public RenderingContext(@Nonnull
                        ERenderingElementType eElementType,
                        @Nonnull
                        PDPageContentStreamWithCache aCS,
                        boolean bDebugMode,
                        float fStartLeft,
                        float fStartTop,
                        float fWidth,
                        float fHeight)

Parameters:

eElementType - Element type. May not be null.

aCS - Page content stream. May not be null.

bDebugMode - debug mode?

fStartLeft - Absolute page x-start position with element x-margin and x-border but without element x-padding

fStartTop - Absolute page y-start position with element y-margin and y-border but without element y-padding

fWidth - width without margin and border but including padding of the surrounding element

fHeight - width without margin and border but including padding of the surrounding element

Method Detail

getElementType

@Nonnull
public ERenderingElementType getElementType()

Returns:

The type of the element currently rendered. Never null .

getContentStream

@Nonnull
public PDPageContentStreamWithCache getContentStream()

Returns:

The current content stream to write to. Never null.

getDocument

@Nonnull
public org.apache.pdfbox.pdmodel.PDDocument getDocument()

Returns:

The underlying PDF document. Never null.

isDebugMode

public boolean isDebugMode()

Returns:

true if debug output should be emitted into the PDF, false otherwise.

getPlaceholder

@Nullable
public String getPlaceholder(String sName)

Get the placeholder value with the specified name.

Parameters:

sName - The name to search. May be null.

Returns:

null if no such placeholder exists.

getPlaceholderAsInt

public int getPlaceholderAsInt(@Nullable
                               String sName,
                               int nDefault)

getAllPlaceholders

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsOrderedMap<String,String> getAllPlaceholders()

setPlaceholder

@Nonnull
public RenderingContext setPlaceholder(@Nonnull @Nonempty
                                                 String sName,
                                                 int nValue)

setPlaceholder

@Nonnull
public RenderingContext setPlaceholder(@Nonnull @Nonempty
                                                 String sName,
                                                 @Nonnull
                                                 String sValue)

getStartLeft

public float getStartLeft()

Returns:

Absolute page x-start position with element x-margin but without element x-padding

getStartTop

public float getStartTop()

Returns:

Absolute page y-start position with element y-margin but without element y-padding

getWidth

public float getWidth()

Returns:

width without margin but including padding of the surrounding element

getHeight

public float getHeight()

Returns:

width without margin but including padding of the surrounding element