com.itextpdf.layout.renderer

Class AbstractRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

Direct Known Subclasses:

BlockRenderer, ImageRenderer, LineRenderer, RootRenderer, TableRenderer, TabRenderer, TextRenderer

public abstract class AbstractRenderer
extends Object
implements IRenderer

Defines the most common properties and behavior that are shared by most IRenderer implementations. All default Renderers are subclasses of this default implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IRenderer>	childRenderers
static float	EPS
protected boolean	flushed
static float	INF
protected boolean	isLastRendererForModelElement
protected IPropertyContainer	modelElement
protected LayoutArea	occupiedArea
protected IRenderer	parent
protected List<IRenderer>	positionedRenderers
protected Map<Integer,Object>	properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRenderer() Creates a renderer.
protected	AbstractRenderer(AbstractRenderer other)
protected	AbstractRenderer(IElement modelElement) Creates a renderer for the specified layout element.

Method Summary

Modifier and Type	Method and Description
protected void	addAllProperties(Map<Integer,Object> properties)
void	addChild(IRenderer renderer) Adds a child to the current renderer
protected void	alignChildHorizontally(IRenderer childRenderer, float availableWidth)
protected void	applyAbsolutePositioningTranslation(boolean reverse)
protected void	applyAction(PdfDocument document)
protected Rectangle	applyBorderBox(Rectangle rect, boolean reverse)
protected void	applyDestination(PdfDocument document)
protected Rectangle	applyMargins(Rectangle rect, boolean reverse)
protected Rectangle	applyPaddings(Rectangle rect, boolean reverse)
void	deleteOwnProperty(int property) Deletes the own property of this entity.
void	deleteProperty(int property) Deletes property from this very renderer, or in case the property is specified on its model element, the property of the model element is deleted
void	draw(DrawContext drawContext) Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the PdfDocument etc.
void	drawBackground(DrawContext drawContext) Draws a background layer if it is defined by a key Property.BACKGROUND in either the layout element or this IRenderer itself.
void	drawBorder(DrawContext drawContext) Performs the drawing operation for the border of this renderer, if defined by any of the Property.BORDER values in either the layout element or this IRenderer itself.
void	drawChildren(DrawContext drawContext) Performs the drawing operation for all children of this renderer.
Rectangle	getBorderAreaBBox() Gets the border box of a renderer.
protected Border[]	getBorders() Gets borders of the element in the specified order: top, right, bottom, left.
List<IRenderer>	getChildRenderers() Gets the child IRenderers.
T1	getDefaultProperty(int property) Gets the default property from this entity.
protected Float	getFirstYLineRecursively() Gets the first yLine of the nested children recursively.
Rectangle	getInnerAreaBBox()
IPropertyContainer	getModelElement() Gets the model element associated with this renderer.
LayoutArea	getOccupiedArea() Gets the resultant occupied area after the last call to the IRenderer.layout(LayoutContext) method.
Rectangle	getOccupiedAreaBBox() Gets the bounding box that contains all content written to the DrawContext by this IRenderer.
protected Map<Integer,Object>	getOwnProperties()
T1	getOwnProperty(int property) Gets own property from this entity.
T1	getProperty(int key) Gets the property from this entity.
T1	getProperty(int property, T1 defaultValue) Gets a property from this entity or one of its hierarchical parents.
Boolean	getPropertyAsBoolean(int property) Returns a property with a certain key, as a boolean value.
Color	getPropertyAsColor(int property) Returns a property with a certain key, as a color.
Float	getPropertyAsFloat(int property) Returns a property with a certain key, as a floating point value.
PdfFont	getPropertyAsFont(int property) Returns a property with a certain key, as a font object.
Integer	getPropertyAsInteger(int property) Returns a property with a certain key, as an integer value.
boolean	hasOwnProperty(int property) Checks if this entity has the specified property, i.e. if it was set to this very element earlier
boolean	hasProperty(int property) Checks if this entity has the specified property.
List<Rectangle>	initElementAreas(LayoutArea area) Gets all rectangles that this IRenderer can draw upon in the given area.
protected boolean	isFixedLayout()
boolean	isFlushed() Indicates whether this renderer is flushed or not, i.e. if IRenderer.draw(DrawContext) has already been called.
protected boolean	isNotFittingHeight(LayoutArea layoutArea)
protected boolean	isPositioned()
void	move(float dxRight, float dyUp) Moves the renderer subtree by the specified offset.
protected Float	retrieveHeight()
protected Float	retrieveUnitValue(float basePercentValue, int property)
protected Float	retrieveWidth(float parentBoxWidth)
protected AbstractRenderer	setBorders(Border border, int borderNumber)
IRenderer	setParent(IRenderer parent) Explicitly sets this object as the child of another IRenderer in the renderer hierarchy.
void	setProperty(int property, Object value) Sets a property for this entity.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.renderer.IRenderer

getNextRenderer, layout

Field Detail

EPS

public static final float EPS

See Also:

Constant Field Values

INF

public static final float INF

See Also:

Constant Field Values

childRenderers

protected List<IRenderer> childRenderers

positionedRenderers

protected List<IRenderer> positionedRenderers

modelElement

protected IPropertyContainer modelElement

flushed

protected boolean flushed

occupiedArea

protected LayoutArea occupiedArea

parent

protected IRenderer parent

properties

protected Map<Integer,Object> properties

isLastRendererForModelElement

protected boolean isLastRendererForModelElement

Constructor Detail

AbstractRenderer

protected AbstractRenderer()

Creates a renderer.

AbstractRenderer

protected AbstractRenderer(IElement modelElement)

Creates a renderer for the specified layout element.

Parameters:

modelElement - the layout element that will be drawn by this renderer

AbstractRenderer

protected AbstractRenderer(AbstractRenderer other)

Method Detail

addChild

public void addChild(IRenderer renderer)

Description copied from interface: IRenderer

Adds a child to the current renderer

Specified by:

addChild in interface IRenderer

Parameters:

renderer - a child to be added

getModelElement

public IPropertyContainer getModelElement()

Description copied from interface: IRenderer

Gets the model element associated with this renderer.

Specified by:

getModelElement in interface IRenderer

Returns:

the model element, as a container of properties

getChildRenderers

public List<IRenderer> getChildRenderers()

Description copied from interface: IRenderer

Gets the child IRenderers.

Specified by:

getChildRenderers in interface IRenderer

Returns:

a list of direct child renderers of this instance

hasProperty

public boolean hasProperty(int property)

Description copied from interface: IPropertyContainer

Checks if this entity has the specified property. Compared to IPropertyContainer.hasOwnProperty(int), this method can check parent's properties, styles, etc, depending on the origin of the instance

Specified by:

hasProperty in interface IPropertyContainer

Parameters:

property - the property to be checked

Returns:

true if this instance has given property, false otherwise

hasOwnProperty

public boolean hasOwnProperty(int property)

Description copied from interface: IPropertyContainer

Checks if this entity has the specified property, i.e. if it was set to this very element earlier

Specified by:

hasOwnProperty in interface IPropertyContainer

Parameters:

property - the property to be checked

Returns:

true if this instance has given own property, false otherwise

deleteOwnProperty

public void deleteOwnProperty(int property)

Description copied from interface: IPropertyContainer

Deletes the own property of this entity.

Specified by:

deleteOwnProperty in interface IPropertyContainer

Parameters:

property - the property to be deleted

deleteProperty

public void deleteProperty(int property)

Deletes property from this very renderer, or in case the property is specified on its model element, the property of the model element is deleted

Parameters:

property - the property key to be deleted

getProperty

public  T1 getProperty(int key)

Description copied from interface: IPropertyContainer

Gets the property from this entity. Compared to IPropertyContainer.getOwnProperty(int), this method can check parent's properties, styles, etc, depending on the origin of the instance

Specified by:

getProperty in interface IPropertyContainer

Type Parameters:

T1 - the return type associated with the property

Parameters:

key - the property to be retrieved

Returns:

the value of the given property. null will be returned if the property value was not found

getOwnProperty

public  T1 getOwnProperty(int property)

Description copied from interface: IPropertyContainer

Gets own property from this entity. The property must have been set earlier to this entity. If the property is not found, null will be returned.

Specified by:

getOwnProperty in interface IPropertyContainer

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

Returns:

the value of the given own property. null will be returned if the property value was not found

getProperty

public  T1 getProperty(int property,
                           T1 defaultValue)

Description copied from interface: IRenderer

Gets a property from this entity or one of its hierarchical parents. If the property is not found, defaultValue will be returned.

Specified by:

getProperty in interface IRenderer

Type Parameters:

T1 - the return type associated with the property

Parameters:

property - the property to be retrieved

defaultValue - a fallback value

Returns:

the value of the given property

setProperty

public void setProperty(int property,
                        Object value)

Description copied from interface: IPropertyContainer

Sets a property for this entity.

Specified by:

setProperty in interface IPropertyContainer

Parameters:

property - the property to be set

value - the value of the property

getDefaultProperty

public  T1 getDefaultProperty(int property)

Description copied from interface: IPropertyContainer

Gets the default property from this entity.

Specified by:

getDefaultProperty in interface IPropertyContainer

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

getPropertyAsFont

public PdfFont getPropertyAsFont(int property)

Returns a property with a certain key, as a font object.

Parameters:

property - an enum value

Returns:

a PdfFont

getPropertyAsColor

public Color getPropertyAsColor(int property)

Returns a property with a certain key, as a color.

Parameters:

property - an enum value

Returns:

a Color

getPropertyAsFloat

public Float getPropertyAsFloat(int property)

Returns a property with a certain key, as a floating point value.

Parameters:

property - an enum value

Returns:

a Float

getPropertyAsBoolean

public Boolean getPropertyAsBoolean(int property)

Returns a property with a certain key, as a boolean value.

Parameters:

property - an enum value

Returns:

a Boolean

getPropertyAsInteger

public Integer getPropertyAsInteger(int property)

Returns a property with a certain key, as an integer value.

Parameters:

property - an enum value

Returns:

a Integer

toString

public String toString()

Overrides:

toString in class Object

getOccupiedArea

public LayoutArea getOccupiedArea()

Description copied from interface: IRenderer

Gets the resultant occupied area after the last call to the IRenderer.layout(LayoutContext) method.

Specified by:

getOccupiedArea in interface IRenderer

Returns:

LayoutArea instance

draw

public void draw(DrawContext drawContext)

Description copied from interface: IRenderer

Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the PdfDocument etc.

Specified by:

draw in interface IRenderer

Parameters:

drawContext - contains the PdfDocument to which the renderer subtree if flushed, the PdfCanvas on which the renderer subtree is drawn and other additional parameters needed to perform drawing

drawBackground

public void drawBackground(DrawContext drawContext)

Draws a background layer if it is defined by a key Property.BACKGROUND in either the layout element or this IRenderer itself.

Parameters:

drawContext - the context (canvas, document, etc) of this drawing operation.

drawChildren

public void drawChildren(DrawContext drawContext)

Performs the drawing operation for all children of this renderer.

Parameters:

drawContext - the context (canvas, document, etc) of this drawing operation.

drawBorder

public void drawBorder(DrawContext drawContext)

Performs the drawing operation for the border of this renderer, if defined by any of the Property.BORDER values in either the layout element or this IRenderer itself.

Parameters:

drawContext - the context (canvas, document, etc) of this drawing operation.

isFlushed

public boolean isFlushed()

Description copied from interface: IRenderer

Indicates whether this renderer is flushed or not, i.e. if IRenderer.draw(DrawContext) has already been called.

Specified by:

isFlushed in interface IRenderer

Returns:

whether the renderer has been flushed

setParent

public IRenderer setParent(IRenderer parent)

Description copied from interface: IRenderer

Explicitly sets this object as the child of another IRenderer in the renderer hierarchy. Some implementations also use this method internally to create a consistent hierarchy tree.

Specified by:

setParent in interface IRenderer

Parameters:

parent - the object to place higher in the renderer hierarchy

Returns:

by default, this object

move

public void move(float dxRight,
                 float dyUp)

Description copied from interface: IRenderer

Moves the renderer subtree by the specified offset. This method affects occupied area of the renderer.

Specified by:

move in interface IRenderer

Parameters:

dxRight - the x-axis offset in points. Positive value will move the renderer subtree to the right.

dyUp - the y-axis offset in points. Positive value will move the renderer subtree to the top.

initElementAreas

public List<Rectangle> initElementAreas(LayoutArea area)

Gets all rectangles that this IRenderer can draw upon in the given area.

Parameters:

area - a physical area on the DrawContext

Returns:

a list of rectangles

getOccupiedAreaBBox

public Rectangle getOccupiedAreaBBox()

Gets the bounding box that contains all content written to the DrawContext by this IRenderer.

Returns:

the smallest Rectangle that surrounds the content

getBorderAreaBBox

public Rectangle getBorderAreaBBox()

Gets the border box of a renderer. This is a box used to draw borders.

Returns:

border box of a renderer

getInnerAreaBBox

public Rectangle getInnerAreaBBox()

retrieveWidth

protected Float retrieveWidth(float parentBoxWidth)

retrieveHeight

protected Float retrieveHeight()

retrieveUnitValue

protected Float retrieveUnitValue(float basePercentValue,
                                  int property)

getOwnProperties

protected Map<Integer,Object> getOwnProperties()

addAllProperties

protected void addAllProperties(Map<Integer,Object> properties)

getFirstYLineRecursively

protected Float getFirstYLineRecursively()

Gets the first yLine of the nested children recursively. E.g. for a list, this will be the yLine of the first item (if the first item is indeed a paragraph). NOTE: this method will no go further than the first child. Returns null if there is no text found.

applyMargins

protected Rectangle applyMargins(Rectangle rect,
                                 boolean reverse)

applyPaddings

protected Rectangle applyPaddings(Rectangle rect,
                                  boolean reverse)

applyBorderBox

protected Rectangle applyBorderBox(Rectangle rect,
                                   boolean reverse)

applyAbsolutePositioningTranslation

protected void applyAbsolutePositioningTranslation(boolean reverse)

applyDestination

protected void applyDestination(PdfDocument document)

applyAction

protected void applyAction(PdfDocument document)

isNotFittingHeight

protected boolean isNotFittingHeight(LayoutArea layoutArea)

isPositioned

protected boolean isPositioned()

isFixedLayout

protected boolean isFixedLayout()

alignChildHorizontally

protected void alignChildHorizontally(IRenderer childRenderer,
                                      float availableWidth)

getBorders

protected Border[] getBorders()

Gets borders of the element in the specified order: top, right, bottom, left.

Returns:

an array of BorderDrawer objects. In case when certain border isn't set Property.BORDER is used, and if Property.BORDER is also not set then null is returned on position of this border

setBorders

protected AbstractRenderer setBorders(Border border,
                                      int borderNumber)