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
protected static float	EPS The maximum difference between Rectangle coordinates to consider rectangles equal
protected boolean	flushed
protected static float	INF The infinity value which is used while layouting
protected boolean	isLastRendererForModelElement
protected IPropertyContainer	modelElement
protected LayoutArea	occupiedArea
static float	OVERLAP_EPSILON
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, Rectangle currentArea)
protected boolean	allowLastYLineRecursiveExtraction()
protected void	applyAbsolutePosition(Rectangle parentRect)
protected void	applyAction(PdfDocument document)
Rectangle	applyBorderBox(Rectangle rect, boolean reverse) Applies the border box of the renderer on the given rectangle If the border of a certain side is null, the side will remain as it was.
protected Rectangle	applyBorderBox(Rectangle rect, Border[] borders, boolean reverse) Applies the given border box (borders) on the given rectangle
protected void	applyDestination(PdfDocument document)
protected void	applyDestinationsAndAnnotation(DrawContext drawContext)
protected void	applyLinkAnnotation(PdfDocument document)
Rectangle	applyMargins(Rectangle rect, boolean reverse) Applies margins of the renderer on the given rectangle
protected Rectangle	applyMargins(Rectangle rect, UnitValue[] margins, boolean reverse) Applies given margins on the given rectangle
Rectangle	applyPaddings(Rectangle rect, boolean reverse) Applies paddings of the renderer on the given rectangle
protected Rectangle	applyPaddings(Rectangle rect, UnitValue[] paddings, boolean reverse) Applies given paddings on the given rectangle
protected void	applyRelativePositioningTranslation(boolean reverse)
protected void	beginElementOpacityApplying(DrawContext drawContext)
protected void	beginTransformationIfApplied(PdfCanvas canvas)
protected Rectangle	calculateAbsolutePdfBBox() Calculates the bounding box of the content in the coordinate system of the pdf entity on which content is placed, e.g.
protected Rectangle	calculateBBox(List<Point> points) Calculates bounding box around points.
protected float[]	calculateShiftToPositionBBoxOfPointsAt(float left, float top, List<Point> points) This method calculates the shift needed to be applied to the points in order to position upper and left borders of their bounding box at the given lines.
protected boolean	clipBackgroundArea(DrawContext drawContext, Rectangle outerBorderBox)
protected boolean	clipBackgroundArea(DrawContext drawContext, Rectangle outerBorderBox, boolean considerBordersBeforeClipping)
protected boolean	clipBorderArea(DrawContext drawContext, Rectangle outerBorderBox)
static PdfFormXObject	createXObject(AbstractLinearGradientBuilder linearGradientBuilder, Rectangle xObjectArea, PdfDocument document) Create a PdfFormXObject with the given area and containing a linear gradient inside.
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.
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.
protected void	endElementOpacityApplying(DrawContext drawContext)
protected void	endTransformationIfApplied(PdfCanvas canvas)
protected Rectangle	getBackgroundArea(Rectangle occupiedAreaWithMargins) Evaluate the actual background
Rectangle	getBorderAreaBBox() Gets the border box of a renderer.
protected BorderRadius[]	getBorderRadii() Gets border radii of the element in the specified order: top-left, top-right, bottom-right, bottom-left.
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()
protected Float	getLastYLineRecursively()
protected UnitValue[]	getMargins() Returns margins of the renderer
MinMaxWidth	getMinMaxWidth() Calculates min and max width values for current renderer.
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.
protected UnitValue[]	getPaddings() Returns paddings of the renderer
IRenderer	getParent() Gets the parent IRenderer.
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.
Float	getPropertyAsFloat(int property, Float defaultValue) 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.
TransparentColor	getPropertyAsTransparentColor(int property) Returns a property with a certain key, as a TransparentColor.
UnitValue	getPropertyAsUnitValue(int property) Returns a property with a certain key, as a unit value.
protected boolean	hasAbsoluteUnitValue(int property) Check if corresponding property has point value.
boolean	hasOwnOrModelProperty(int property) Checks if this renderer or its model element have the specified property, i.e.
boolean	hasOwnProperty(int property) Checks if this entity has the specified property, i.e.
boolean	hasProperty(int property) Checks if this entity has the specified property.
protected boolean	hasRelativeUnitValue(int property) Check if corresponding property has relative value.
List<Rectangle>	initElementAreas(LayoutArea area) Gets all rectangles that this IRenderer can draw upon in the given area.
protected boolean	isAbsolutePosition()
protected static boolean	isBorderBoxSizing(IRenderer renderer)
boolean	isFirstOnRootArea()
protected boolean	isFixedLayout() Indicates whether the renderer's position is fixed or not.
boolean	isFlushed() Indicates whether this renderer is flushed or not, i.e.
protected boolean	isKeepTogether()
protected boolean	isNotFittingHeight(LayoutArea layoutArea)
protected boolean	isNotFittingLayoutArea(LayoutArea layoutArea)
protected boolean	isNotFittingWidth(LayoutArea layoutArea)
protected static boolean	isOverflowFit(OverflowPropertyValue rendererOverflowProperty)
protected boolean	isOverflowProperty(OverflowPropertyValue equalsTo, int overflowProperty)
protected static boolean	isOverflowProperty(OverflowPropertyValue equalsTo, IRenderer renderer, int overflowProperty)
protected static boolean	isOverflowProperty(OverflowPropertyValue equalsTo, OverflowPropertyValue rendererOverflowProperty)
protected boolean	isPositioned() Indicates whether the renderer's position is fixed or not.
protected boolean	isRelativePosition()
protected boolean	isStaticLayout()
void	move(float dxRight, float dyUp) Moves the renderer subtree by the specified offset.
protected List<Point>	rectangleToPointsList(Rectangle rect)
protected Float	retrieveHeight() Retrieves the element's fixed content box height, if it's set.
protected Float	retrieveMaxHeight() Retrieve element's content box max-ehight, if it's set.
protected Float	retrieveMaxWidth(float parentBoxWidth) Retrieves element's fixed content box max width, if it's set.
protected Float	retrieveMinHeight() Retrieves element's content box min-height, if it's set.
protected Float	retrieveMinWidth(float parentBoxWidth) Retrieves element's fixed content box max width, if it's set.
protected Float	retrieveUnitValue(float baseValue, int property)
protected Float	retrieveUnitValue(float baseValue, int property, boolean pointOnly)
protected Float	retrieveWidth(float parentBoxWidth) Retrieves element's fixed content box width, if it's set.
protected AbstractRenderer	setBorders(Border border, int borderNumber)
protected boolean	setMinMaxWidthBasedOnFixedWidth(MinMaxWidth minMaxWidth)
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() Returns a string representation of the renderer.
protected List<Point>	transformPoints(List<Point> points, AffineTransform transform)
protected void	updateHeight(UnitValue updatedHeight) Updates fixed content box height value for this renderer.
protected void	updateHeightsOnSplit(boolean wasHeightClipped, AbstractRenderer splitRenderer, AbstractRenderer overflowRenderer)
protected void	updateMaxHeight(UnitValue updatedMaxHeight) Updates content box max-height value for this renderer.
protected void	updateMinHeight(UnitValue updatedMinHeight) Updates content box min-height value for this renderer.
protected void	updateWidth(UnitValue updatedWidthValue) Updates fixed content box width value for this renderer.

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

OVERLAP_EPSILON

public static final float OVERLAP_EPSILON

See Also:

Constant Field Values

EPS

protected static final float EPS

The maximum difference between Rectangle coordinates to consider rectangles equal

See Also:

Constant Field Values

INF

protected static final float INF

The infinity value which is used while layouting

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)

Adds a child to the current renderer

Specified by:

addChild in interface IRenderer

Parameters:

renderer - a child to be added

getModelElement

public IPropertyContainer getModelElement()

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()

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)

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)

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

hasOwnOrModelProperty

public boolean hasOwnOrModelProperty(int property)

Checks if this renderer or its model element have the specified property, i.e. if it was set to this very element or its very model element earlier.

Parameters:

property - the property to be checked

Returns:

true if this instance or its model element have given own property, false otherwise

deleteOwnProperty

public void deleteOwnProperty(int property)

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)

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)

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)

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)

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)

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

getPropertyAsTransparentColor

public TransparentColor getPropertyAsTransparentColor(int property)

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

Parameters:

property - an enum value

Returns:

a TransparentColor

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

getPropertyAsFloat

public Float getPropertyAsFloat(int property,
                                Float defaultValue)

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

Parameters:

property - an enum value

defaultValue - default value to be returned if property is not found

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

getPropertyAsUnitValue

public UnitValue getPropertyAsUnitValue(int property)

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

Parameters:

property - an enum value

Returns:

a UnitValue

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()

Returns a string representation of the renderer.

Overrides:

toString in class Object

Returns:

a String

See Also:

Object.toString()

getOccupiedArea

public LayoutArea getOccupiedArea()

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)

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

beginElementOpacityApplying

protected void beginElementOpacityApplying(DrawContext drawContext)

endElementOpacityApplying

protected void endElementOpacityApplying(DrawContext drawContext)

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.

createXObject

public static PdfFormXObject createXObject(AbstractLinearGradientBuilder linearGradientBuilder,
                                           Rectangle xObjectArea,
                                           PdfDocument document)

Create a PdfFormXObject with the given area and containing a linear gradient inside.

Parameters:

linearGradientBuilder - the linear gradient builder

xObjectArea - the result object area

document - the pdf document

Returns:

the xObject with a specified area and a linear gradient

getBackgroundArea

protected Rectangle getBackgroundArea(Rectangle occupiedAreaWithMargins)

Evaluate the actual background

Parameters:

occupiedAreaWithMargins - the current occupied area with applied margins

Returns:

the actual background area

clipBorderArea

protected boolean clipBorderArea(DrawContext drawContext,
                                 Rectangle outerBorderBox)

clipBackgroundArea

protected boolean clipBackgroundArea(DrawContext drawContext,
                                     Rectangle outerBorderBox)

clipBackgroundArea

protected boolean clipBackgroundArea(DrawContext drawContext,
                                     Rectangle outerBorderBox,
                                     boolean considerBordersBeforeClipping)

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()

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

Specified by:

isFlushed in interface IRenderer

Returns:

whether the renderer has been flushed

See Also:

draw(com.itextpdf.layout.renderer.DrawContext)

setParent

public IRenderer setParent(IRenderer parent)

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

getParent

public IRenderer getParent()

Gets the parent IRenderer.

Specified by:

getParent in interface IRenderer

Returns:

direct parent renderer of this instance

move

public void move(float dxRight,
                 float dyUp)

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()

applyMargins

public Rectangle applyMargins(Rectangle rect,
                              boolean reverse)

Applies margins of the renderer on the given rectangle

Parameters:

rect - a rectangle margins will be applied on.

reverse - indicates whether margins will be applied inside (in case of false) or outside (in case of true) the rectangle.

Returns:

a border box of the renderer

See Also:

getMargins()

applyBorderBox

public Rectangle applyBorderBox(Rectangle rect,
                                boolean reverse)

Applies the border box of the renderer on the given rectangle If the border of a certain side is null, the side will remain as it was.

Parameters:

rect - a rectangle the border box will be applied on.

reverse - indicates whether the border box will be applied inside (in case of false) or outside (in case of false) the rectangle.

Returns:

a border box of the renderer

See Also:

getBorders()

applyPaddings

public Rectangle applyPaddings(Rectangle rect,
                               boolean reverse)

Applies paddings of the renderer on the given rectangle

Parameters:

rect - a rectangle paddings will be applied on.

reverse - indicates whether paddings will be applied inside (in case of false) or outside (in case of false) the rectangle.

Returns:

a border box of the renderer

See Also:

getPaddings()

isFirstOnRootArea

public boolean isFirstOnRootArea()

applyDestinationsAndAnnotation

protected void applyDestinationsAndAnnotation(DrawContext drawContext)

isBorderBoxSizing

protected static boolean isBorderBoxSizing(IRenderer renderer)

isOverflowProperty

protected boolean isOverflowProperty(OverflowPropertyValue equalsTo,
                                     int overflowProperty)

isOverflowProperty

protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo,
                                            IRenderer renderer,
                                            int overflowProperty)

isOverflowProperty

protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo,
                                            OverflowPropertyValue rendererOverflowProperty)

isOverflowFit

protected static boolean isOverflowFit(OverflowPropertyValue rendererOverflowProperty)

retrieveWidth

protected Float retrieveWidth(float parentBoxWidth)

Retrieves element's fixed content box width, if it's set. Takes into account Property.BOX_SIZING, Property.MIN_WIDTH, and Property.MAX_WIDTH properties.

Parameters:

parentBoxWidth - width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter.

Returns:

element's fixed content box width or null if it's not set.

See Also:

hasAbsoluteUnitValue(int)

retrieveMaxWidth

protected Float retrieveMaxWidth(float parentBoxWidth)

Retrieves element's fixed content box max width, if it's set. Takes into account Property.BOX_SIZING and Property.MIN_WIDTH properties.

Parameters:

parentBoxWidth - width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter.

Returns:

element's fixed content box max width or null if it's not set.

See Also:

hasAbsoluteUnitValue(int)

retrieveMinWidth

protected Float retrieveMinWidth(float parentBoxWidth)

Retrieves element's fixed content box max width, if it's set. Takes into account Property.BOX_SIZING property value.

Parameters:

parentBoxWidth - width of the parent element content box. If element has relative width, it will be calculated relatively to this parameter.

Returns:

element's fixed content box max width or null if it's not set.

See Also:

hasAbsoluteUnitValue(int)

updateWidth

protected void updateWidth(UnitValue updatedWidthValue)

Updates fixed content box width value for this renderer. Takes into account Property.BOX_SIZING property value.

Parameters:

updatedWidthValue - element's new fixed content box width.

retrieveHeight

protected Float retrieveHeight()

Retrieves the element's fixed content box height, if it's set. Takes into account Property.BOX_SIZING, Property.MIN_HEIGHT, and Property.MAX_HEIGHT properties.

Returns:

element's fixed content box height or null if it's not set.

updateHeight

protected void updateHeight(UnitValue updatedHeight)

Updates fixed content box height value for this renderer. Takes into account Property.BOX_SIZING property value.

Parameters:

updatedHeight - element's new fixed content box height, shall be not null.

retrieveMaxHeight

protected Float retrieveMaxHeight()

Retrieve element's content box max-ehight, if it's set. Takes into account Property.BOX_SIZING property value.

Returns:

element's content box max-height or null if it's not set.

updateMaxHeight

protected void updateMaxHeight(UnitValue updatedMaxHeight)

Updates content box max-height value for this renderer. Takes into account Property.BOX_SIZING property value.

Parameters:

updatedMaxHeight - element's new content box max-height, shall be not null.

retrieveMinHeight

protected Float retrieveMinHeight()

Retrieves element's content box min-height, if it's set. Takes into account Property.BOX_SIZING property value.

Returns:

element's content box min-height or null if it's not set.

updateMinHeight

protected void updateMinHeight(UnitValue updatedMinHeight)

Updates content box min-height value for this renderer. Takes into account Property.BOX_SIZING property value.

Parameters:

updatedMinHeight - element's new content box min-height, shall be not null.

retrieveUnitValue

protected Float retrieveUnitValue(float baseValue,
                                  int property)

retrieveUnitValue

protected Float retrieveUnitValue(float baseValue,
                                  int property,
                                  boolean pointOnly)

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:

the first yline of the nested children, null if there is no text found

getLastYLineRecursively

protected Float getLastYLineRecursively()

allowLastYLineRecursiveExtraction

protected boolean allowLastYLineRecursiveExtraction()

applyMargins

protected Rectangle applyMargins(Rectangle rect,
                                 UnitValue[] margins,
                                 boolean reverse)

Applies given margins on the given rectangle

Parameters:

rect - a rectangle margins will be applied on.

margins - the margins to be applied on the given rectangle

reverse - indicates whether margins will be applied inside (in case of false) or outside (in case of true) the rectangle.

Returns:

a border box of the renderer

getMargins

protected UnitValue[] getMargins()

Returns margins of the renderer

Returns:

a float[] margins of the renderer

getPaddings

protected UnitValue[] getPaddings()

Returns paddings of the renderer

Returns:

a float[] paddings of the renderer

applyPaddings

protected Rectangle applyPaddings(Rectangle rect,
                                  UnitValue[] paddings,
                                  boolean reverse)

Applies given paddings on the given rectangle

Parameters:

rect - a rectangle paddings will be applied on.

paddings - the paddings to be applied on the given rectangle

reverse - indicates whether paddings will be applied inside (in case of false) or outside (in case of false) the rectangle.

Returns:

a border box of the renderer

applyBorderBox

protected Rectangle applyBorderBox(Rectangle rect,
                                   Border[] borders,
                                   boolean reverse)

Applies the given border box (borders) on the given rectangle

Parameters:

rect - a rectangle paddings will be applied on.

borders - the borders to be applied on the given rectangle

reverse - indicates whether the border box will be applied inside (in case of false) or outside (in case of false) the rectangle.

Returns:

a border box of the renderer

applyAbsolutePosition

protected void applyAbsolutePosition(Rectangle parentRect)

applyRelativePositioningTranslation

protected void applyRelativePositioningTranslation(boolean reverse)

applyDestination

protected void applyDestination(PdfDocument document)

applyAction

protected void applyAction(PdfDocument document)

applyLinkAnnotation

protected void applyLinkAnnotation(PdfDocument document)

updateHeightsOnSplit

protected void updateHeightsOnSplit(boolean wasHeightClipped,
                                    AbstractRenderer splitRenderer,
                                    AbstractRenderer overflowRenderer)

getMinMaxWidth

public MinMaxWidth getMinMaxWidth()

Calculates min and max width values for current renderer.

Returns:

instance of MinMaxWidth

setMinMaxWidthBasedOnFixedWidth

protected boolean setMinMaxWidthBasedOnFixedWidth(MinMaxWidth minMaxWidth)

isNotFittingHeight

protected boolean isNotFittingHeight(LayoutArea layoutArea)

isNotFittingWidth

protected boolean isNotFittingWidth(LayoutArea layoutArea)

isNotFittingLayoutArea

protected boolean isNotFittingLayoutArea(LayoutArea layoutArea)

isPositioned

protected boolean isPositioned()

Indicates whether the renderer's position is fixed or not.

Returns:

a boolean

isFixedLayout

protected boolean isFixedLayout()

Indicates whether the renderer's position is fixed or not.

Returns:

a boolean

isStaticLayout

protected boolean isStaticLayout()

isRelativePosition

protected boolean isRelativePosition()

isAbsolutePosition

protected boolean isAbsolutePosition()

isKeepTogether

protected boolean isKeepTogether()

alignChildHorizontally

protected void alignChildHorizontally(IRenderer childRenderer,
                                      Rectangle currentArea)

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

getBorderRadii

protected BorderRadius[] getBorderRadii()

Gets border radii of the element in the specified order: top-left, top-right, bottom-right, bottom-left.

Returns:

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

setBorders

protected AbstractRenderer setBorders(Border border,
                                      int borderNumber)

calculateAbsolutePdfBBox

protected Rectangle calculateAbsolutePdfBBox()

Calculates the bounding box of the content in the coordinate system of the pdf entity on which content is placed, e.g. document page or form xObject. This is particularly useful for the cases when element is nested in the rotated element.

Returns:

a Rectangle which is a bbox of the content not relative to the parent's layout area but rather to the some pdf entity coordinate system.

calculateBBox

protected Rectangle calculateBBox(List<Point> points)

Calculates bounding box around points.

Parameters:

points - list of the points calculated bbox will enclose.

Returns:

array of float values which denote left, bottom, right, top lines of bbox in this specific order

rectangleToPointsList

protected List<Point> rectangleToPointsList(Rectangle rect)

transformPoints

protected List<Point> transformPoints(List<Point> points,
                                      AffineTransform transform)

calculateShiftToPositionBBoxOfPointsAt

protected float[] calculateShiftToPositionBBoxOfPointsAt(float left,
                                                         float top,
                                                         List<Point> points)

This method calculates the shift needed to be applied to the points in order to position upper and left borders of their bounding box at the given lines.

Parameters:

left - x coordinate at which points bbox left border is to be aligned

top - y coordinate at which points bbox upper border is to be aligned

points - the points, which bbox will be aligned at the given position

Returns:

array of two floats, where first element denotes x-coordinate shift and the second element denotes y-coordinate shift which are needed to align points bbox at the given lines.

hasAbsoluteUnitValue

protected boolean hasAbsoluteUnitValue(int property)

Check if corresponding property has point value.

Parameters:

property - Property

Returns:

false if property value either null, or percent, otherwise true.

hasRelativeUnitValue

protected boolean hasRelativeUnitValue(int property)

Check if corresponding property has relative value.

Parameters:

property - Property

Returns:

false if property value either null, or point, otherwise true.

beginTransformationIfApplied

protected void beginTransformationIfApplied(PdfCanvas canvas)

endTransformationIfApplied

protected void endTransformationIfApplied(PdfCanvas canvas)