Package 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
,MulticolRenderer
,RootRenderer
,TableRenderer
,TabRenderer
,TextRenderer
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
FieldsModifier and TypeFieldDescriptionprivate static final int
private static final int
private static final int
private static final int
private static final int
(package private) static final int
The common ordering index of bottom side in arrays of four elements which define top, right, bottom, left sides values (e.g.private static final Tuple2
<String, PdfDictionary> protected static final float
The maximum difference betweenRectangle
coordinates to consider rectangles equalprotected boolean
protected static final float
The infinity value which is used while layoutingprotected boolean
(package private) static final int
The common ordering index of left side in arrays of four elements which define top, right, bottom, left sides values (e.g.protected IPropertyContainer
protected LayoutArea
static final float
protected IRenderer
(package private) static final int
The common ordering index of right side in arrays of four elements which define top, right, bottom, left sides values (e.g.(package private) static final int
The common ordering index of top side in arrays of four elements which define top, right, bottom, left sides values (e.g. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates a renderer.protected
AbstractRenderer
(IElement modelElement) Creates a renderer for the specified layout element.protected
AbstractRenderer
(AbstractRenderer other) Creates a new renderer based on an instance of another renderer. -
Method Summary
Modifier and TypeMethodDescription(package private) void
addAllChildRenderers
(int index, List<IRenderer> children) Inserts the specified collection ofrenderers
at the specified space of children list and update their parent links tothis
.(package private) void
addAllChildRenderers
(List<IRenderer> children) Add the specified collection ofrenderers
to the end of children list and update their parent links tothis
.protected void
addAllProperties
(Map<Integer, Object> properties) void
Adds a child to the current renderer(package private) void
addChildRenderer
(IRenderer child) Add the specifiedrenderer
to the end of children list and update its parent link tothis
.private void
adjustPositionedRendererLayoutBoxWidth
(IRenderer renderer, Rectangle fullBbox, Float left, Float right) protected void
alignChildHorizontally
(IRenderer childRenderer, Rectangle currentArea) protected boolean
protected void
applyAbsolutePosition
(Rectangle parentRect) (package private) void
applyAbsolutePositionIfNeeded
(LayoutContext layoutContext) protected void
applyAction
(PdfDocument document) private Rectangle
applyBackgroundBoxProperty
(Rectangle rectangle, BackgroundBox clip) 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 rectangleprotected void
applyDestination
(PdfDocument document) protected void
applyDestinationsAndAnnotation
(DrawContext drawContext) protected void
applyLinkAnnotation
(PdfDocument document) applyMargins
(Rectangle rect, boolean reverse) Applies margins of the renderer on the given rectangleprotected Rectangle
applyMargins
(Rectangle rect, UnitValue[] margins, boolean reverse) Applies given margins on the given rectangle(package private) Rectangle
applyMarginsBordersPaddings
(Rectangle rect, boolean reverse) Applies margins, borders and paddings of the renderer on the given rectangle.applyPaddings
(Rectangle rect, boolean reverse) Applies paddings of the renderer on the given rectangleprotected Rectangle
applyPaddings
(Rectangle rect, UnitValue[] paddings, boolean reverse) Applies given paddings to the given rectangle.protected void
applyRelativePositioningTranslation
(boolean reverse) protected void
beginElementOpacityApplying
(DrawContext drawContext) ApplyProperty.OPACITY
property if specified by setting corresponding values in graphic state dictionary opacity will be applied to all elements drawn after calling this method and before callingendElementOpacityApplying(DrawContext)
()}.protected void
protected Rectangle
Calculates the bounding box of the content in the coordinate system of the pdf entity on which content is placed, e.g.(package private) static float
calculateAdditionalWidth
(AbstractRenderer renderer) protected Rectangle
calculateBBox
(List<Point> points) Calculates bounding box around points.(package private) static float
calculatePaddingBorderHeight
(AbstractRenderer renderer) (package private) static float
calculatePaddingBorderWidth
(AbstractRenderer renderer) private float[]
calculateRadii
(BorderRadius[] radii, Rectangle area, boolean horizontal) Calculates the element corner's border radii.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.private boolean
clipArea
(DrawContext drawContext, Rectangle outerBorderBox, boolean clipOuter, boolean clipInner, boolean considerBordersBeforeOuterClipping, boolean considerBordersBeforeInnerClipping) protected boolean
clipBackgroundArea
(DrawContext drawContext, Rectangle outerBorderBox) protected boolean
clipBackgroundArea
(DrawContext drawContext, Rectangle outerBorderBox, boolean considerBordersBeforeClipping) protected boolean
clipBorderArea
(DrawContext drawContext, Rectangle outerBorderBox) private void
clipInnerArea
(PdfCanvas canvas, float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY, float[] borderWidths) private void
clipOuterArea
(PdfCanvas canvas, float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY) (package private) FontCharacteristics
private AffineTransform
This method createsAffineTransform
instance that could be used to transform content inside the occupied area, considering the centre of the occupiedArea as the origin of a coordinate system for transformation.static PdfFormXObject
createXObject
(AbstractLinearGradientBuilder linearGradientBuilder, Rectangle xObjectArea, PdfDocument document) Create aPdfFormXObject
with the given area and containing a linear gradient inside.private float[]
decreaseBorderRadiiWithBorders
(float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY) 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 deletedvoid
draw
(DrawContext drawContext) Flushes the renderer subtree contents, i.e.void
drawBackground
(DrawContext drawContext) Draws a background layer if it is defined by a keyProperty.BACKGROUND
in either the layout element or thisIRenderer
itself.private void
drawBackgroundImage
(BackgroundImage backgroundImage, DrawContext drawContext, Rectangle backgroundArea) private boolean
drawBackgroundImagesList
(List<BackgroundImage> backgroundImagesList, boolean backgroundAreaIsClipped, DrawContext drawContext, Rectangle backgroundArea) void
drawBorder
(DrawContext drawContext) Performs the drawing operation for the border of this renderer, if defined by any of theProperty.BORDER
values in either the layout element or thisIRenderer
itself.void
drawChildren
(DrawContext drawContext) Performs the drawing operation for allchildren
of this renderer.private void
drawColorBackground
(Background background, DrawContext drawContext, Rectangle colorBackgroundArea) private static void
drawPdfXObject
(Rectangle imageRectangle, BackgroundImage backgroundImage, DrawContext drawContext, PdfXObject backgroundXObject, Rectangle backgroundArea, Rectangle originBackgroundArea) private static void
drawPdfXObjectHorizontally
(Rectangle imageRectangle, BackgroundImage backgroundImage, DrawContext drawContext, PdfXObject backgroundXObject, Rectangle backgroundArea, boolean firstDraw, float xWhitespace) (package private) void
drawPositionedChildren
(DrawContext drawContext) protected void
endElementOpacityApplying
(DrawContext drawContext) protected void
endTransformationIfApplied
(PdfCanvas canvas) (package private) Float
Gets intrinsic aspect ratio for this renderer.protected Rectangle
getBackgroundArea
(Rectangle occupiedAreaWithMargins) Evaluate the actual backgroundGets the border box of a renderer.protected BorderRadius[]
Gets border radii of the element in the specified order: top-left, top-right, bottom-right, bottom-left.private static BorderRadius[]
getBorderRadii
(IRenderer renderer) protected Border[]
Gets borders of the element in the specified order: top, right, bottom, left.(package private) static Border[]
getBorders
(IRenderer renderer) Gets the childIRenderer
s.private static PdfStructElem
getCurrentStructElem
(PdfDocument document) <T1> T1
getDefaultProperty
(int property) Gets the default property from this entity.protected Float
Gets the first yLine of the nested children recursively.protected Float
protected UnitValue[]
Returns margins of the renderer [0] - top; [1] - right; [2] - bottom; [3] - leftprivate static UnitValue[]
getMargins
(IRenderer renderer) Calculates min and max width values for current renderer.Gets the model element associated with this renderer.Gets the resultant occupied area after the last call to theIRenderer.layout(LayoutContext)
method.Gets the bounding box that contains all content written to theDrawContext
by thisIRenderer
.<T1> T1
getOwnProperty
(int property) Gets own property from this entity.protected UnitValue[]
Returns paddings of the renderer [0] - top; [1] - right; [2] - bottom; [3] - leftprivate static UnitValue[]
getPaddings
(IRenderer renderer) Gets the parentIRenderer
.(package private) PdfDocument
Gets pdf document from root renderers.<T1> T1
getProperty
(int key) Gets the property from this entity.<T1> T1
getProperty
(int property, T1 defaultValue) Gets a property from this entity or one of its hierarchical parents.getPropertyAsBoolean
(int property) Returns a property with a certain key, as a boolean value.getPropertyAsColor
(int property) Returns a property with a certain key, as a color.getPropertyAsFloat
(int property) Returns a property with a certain key, as a floating point value.getPropertyAsFloat
(int property, Float defaultValue) Returns a property with a certain key, as a floating point value.(package private) static Float
getPropertyAsFloat
(IRenderer renderer, int property) getPropertyAsFont
(int property) Returns a property with a certain key, as a font object.getPropertyAsInteger
(int property) Returns a property with a certain key, as an integer value.getPropertyAsTransparentColor
(int property) Returns a property with a certain key, as aTransparentColor
.getPropertyAsUnitValue
(int property) Returns a property with a certain key, as a unit value.(package private) static UnitValue
getPropertyAsUnitValue
(IRenderer renderer, int property) Returns the property of the renderer as a UnitValue if it exists and is a UnitValue, null otherwise(package private) RootRenderer
protected boolean
hasAbsoluteUnitValue
(int property) Check if corresponding property has point value.(package private) boolean
Checks if this renderer has intrinsic aspect ratio.boolean
hasOwnOrModelProperty
(int property) Checks if this renderer or its model element have the specified property, i.e.private static boolean
hasOwnOrModelProperty
(IRenderer renderer, int property) 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.initElementAreas
(LayoutArea area) Gets all rectangles that thisIRenderer
can draw upon in the given area.protected boolean
protected static boolean
isBorderBoxSizing
(IRenderer renderer) boolean
(package private) boolean
isFirstOnRootArea
(boolean checkRootAreaOnly) protected boolean
Indicates whether the renderer's position is fixed or not.boolean
Indicates whether this renderer is flushed or not, i.e.protected boolean
(package private) boolean
isKeepTogether
(IRenderer causeOfNothing) 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, OverflowPropertyValue rendererOverflowProperty) protected static boolean
isOverflowProperty
(OverflowPropertyValue equalsTo, IRenderer renderer, int overflowProperty) protected boolean
Indicates whether the renderer's position is fixed or not.protected boolean
protected boolean
(package private) boolean
logWarningIfGetNextRendererNotOverridden
(Class<?> baseClass, Class<?> rendererClass) void
move
(float dxRight, float dyUp) Moves the renderer subtree by the specified offset.(package private) static boolean
noAbsolutePositionInfo
(IRenderer renderer) (package private) void
preparePositionedRendererAndAreaForLayout
(IRenderer childPositionedRenderer, Rectangle fullBbox, Rectangle parentBbox) (package private) static void
processWaitingDrawing
(IRenderer child, Transform transformProp, List<IRenderer> waitingDrawing) (package private) boolean
removeAllChildRenderers
(Collection<IRenderer> children) Remove the childrenrenderers
which are contains in the specified collection.(package private) IRenderer
removeChildRenderer
(int index) Remove the childrenderer
at the specified place.private void
removeThisFromParent
(IRenderer toRemove) private void
removeThisFromParents
(Collection<IRenderer> children) (package private) <T> T
replaceOwnProperty
(int property, T replacementValue) Replaces given property own value with the given value.(package private) PdfFont
Gets any validPdfFont
for this renderer, based onProperty.FONT
,Property.FONT_PROVIDER
andProperty.FONT_SET
properties.(package private) PdfFont
resolveFirstPdfFont
(String[] font, FontProvider provider, FontCharacteristics fc, FontSet additionalFonts) Get first validPdfFont
for this renderer, based on given font-families, font provider and font characteristics.private Float
Retrieve the direct parent's absolute height propertyprotected Float
Retrieves the element's fixed content box height, if it's set.protected Float
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
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.private Float
Retrieve the parent's resolved height declaration.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.(package private) <T> void
returnBackOwnProperty
(int property, T prevValue) Returns back own value of the given property.protected AbstractRenderer
setBorders
(Border border, int borderNumber) (package private) IRenderer
setChildRenderer
(int index, IRenderer child) Update the childrenderer
at the specified place with the specified one.(package private) void
setChildRenderers
(List<IRenderer> children) Set the specified collection ofrenderers
as the children forthis
element.protected boolean
setMinMaxWidthBasedOnFixedWidth
(MinMaxWidth minMaxWidth) Explicitly sets this object as the child of anotherIRenderer
in the renderer hierarchy.void
setProperty
(int property, Object value) Sets a property for this entity.(package private) void
setThisAsParent
(Collection<IRenderer> children) Sets currentAbstractRenderer
as parent to renderers in specified collection.(package private) void
toString()
Returns a string representation of the renderer.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) (package private) void
updateHeightsOnSplit
(float usedHeight, boolean wasHeightClipped, AbstractRenderer splitRenderer, AbstractRenderer overflowRenderer, boolean enlargeOccupiedAreaOnHeightWasClipped) 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.private void
updateMinHeightForAbsolutelyPositionedRenderer
(IRenderer renderer, Rectangle parentRendererBox, Float top, Float bottom) 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 Details
-
OVERLAP_EPSILON
public static final float OVERLAP_EPSILON- See Also:
-
EPS
protected static final float EPSThe maximum difference betweenRectangle
coordinates to consider rectangles equal- See Also:
-
INF
protected static final float INFThe infinity value which is used while layouting- See Also:
-
TOP_SIDE
static final int TOP_SIDEThe common ordering index of top side in arrays of four elements which define top, right, bottom, left sides values (e.g. margins, borders, paddings).- See Also:
-
RIGHT_SIDE
static final int RIGHT_SIDEThe common ordering index of right side in arrays of four elements which define top, right, bottom, left sides values (e.g. margins, borders, paddings).- See Also:
-
BOTTOM_SIDE
static final int BOTTOM_SIDEThe common ordering index of bottom side in arrays of four elements which define top, right, bottom, left sides values (e.g. margins, borders, paddings).- See Also:
-
LEFT_SIDE
static final int LEFT_SIDEThe common ordering index of left side in arrays of four elements which define top, right, bottom, left sides values (e.g. margins, borders, paddings).- See Also:
-
ARC_RIGHT_DEGREE
private static final int ARC_RIGHT_DEGREE- See Also:
-
ARC_TOP_DEGREE
private static final int ARC_TOP_DEGREE- See Also:
-
ARC_LEFT_DEGREE
private static final int ARC_LEFT_DEGREE- See Also:
-
ARC_BOTTOM_DEGREE
private static final int ARC_BOTTOM_DEGREE- See Also:
-
ARC_QUARTER_CLOCKWISE_EXTENT
private static final int ARC_QUARTER_CLOCKWISE_EXTENT- See Also:
-
CHECK_TUPLE2_TYPE
-
childRenderers
-
positionedRenderers
-
modelElement
-
flushed
protected boolean flushed -
occupiedArea
-
parent
-
properties
-
isLastRendererForModelElement
protected boolean isLastRendererForModelElement
-
-
Constructor Details
-
AbstractRenderer
protected AbstractRenderer()Creates a renderer. -
AbstractRenderer
Creates a renderer for the specified layout element.- Parameters:
modelElement
- the layout element that will be drawn by this renderer
-
AbstractRenderer
Creates a new renderer based on an instance of another renderer.- Parameters:
other
- renderer from which to copy essential properties
-
-
Method Details
-
addChild
Adds a child to the current renderer -
getModelElement
Gets the model element associated with this renderer.- Specified by:
getModelElement
in interfaceIRenderer
- Returns:
- the model element, as a
container of properties
-
getChildRenderers
Gets the childIRenderer
s.- Specified by:
getChildRenderers
in interfaceIRenderer
- 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 toIPropertyContainer.hasOwnProperty(int)
, this method can check parent's properties, styles, etc, depending on the origin of the instance- Specified by:
hasProperty
in interfaceIPropertyContainer
- 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 interfaceIPropertyContainer
- 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 interfaceIPropertyContainer
- 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> T1 getProperty(int key) Gets the property from this entity. Compared toIPropertyContainer.getOwnProperty(int)
, this method can check parent's properties, styles, etc, depending on the origin of the instance- Specified by:
getProperty
in interfaceIPropertyContainer
- 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> 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 interfaceIPropertyContainer
- 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> 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 interfaceIRenderer
- Type Parameters:
T1
- the return type associated with the property- Parameters:
property
- the property to be retrieveddefaultValue
- a fallback value- Returns:
- the value of the given property
-
setProperty
Sets a property for this entity.- Specified by:
setProperty
in interfaceIPropertyContainer
- Parameters:
property
- the property to be setvalue
- the value of the property
-
getDefaultProperty
public <T1> T1 getDefaultProperty(int property) Gets the default property from this entity.- Specified by:
getDefaultProperty
in interfaceIPropertyContainer
- 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
Returns a property with a certain key, as a font object.- Parameters:
property
- anenum value
- Returns:
- a
PdfFont
-
getPropertyAsColor
Returns a property with a certain key, as a color.- Parameters:
property
- anenum value
- Returns:
- a
Color
-
getPropertyAsTransparentColor
Returns a property with a certain key, as aTransparentColor
.- Parameters:
property
- anenum value
- Returns:
- a
TransparentColor
-
getPropertyAsFloat
Returns a property with a certain key, as a floating point value.- Parameters:
property
- anenum value
- Returns:
- a
Float
-
getPropertyAsFloat
Returns a property with a certain key, as a floating point value.- Parameters:
property
- anenum value
defaultValue
- default value to be returned if property is not found- Returns:
- a
Float
-
getPropertyAsBoolean
Returns a property with a certain key, as a boolean value.- Parameters:
property
- anenum value
- Returns:
- a
Boolean
-
getPropertyAsUnitValue
Returns a property with a certain key, as a unit value.- Parameters:
property
- anenum value
- Returns:
- a
UnitValue
-
getPropertyAsInteger
Returns a property with a certain key, as an integer value.- Parameters:
property
- anenum value
- Returns:
- a
Integer
-
toString
Returns a string representation of the renderer. -
getOccupiedArea
Gets the resultant occupied area after the last call to theIRenderer.layout(LayoutContext)
method.- Specified by:
getOccupiedArea
in interfaceIRenderer
- Returns:
LayoutArea
instance
-
draw
Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to thePdfDocument
etc.- Specified by:
draw
in interfaceIRenderer
- Parameters:
drawContext
- contains thePdfDocument
to which the renderer subtree if flushed, thePdfCanvas
on which the renderer subtree is drawn and other additional parameters needed to perform drawing
-
beginElementOpacityApplying
ApplyProperty.OPACITY
property if specified by setting corresponding values in graphic state dictionary opacity will be applied to all elements drawn after calling this method and before callingendElementOpacityApplying(DrawContext)
()}.- Parameters:
drawContext
- the context (canvas, document, etc) of this drawing operation.
-
endElementOpacityApplying
- Parameters:
drawContext
- the context (canvas, document, etc) of this drawing operation.
-
drawBackground
Draws a background layer if it is defined by a keyProperty.BACKGROUND
in either the layout element or thisIRenderer
itself.- Parameters:
drawContext
- the context (canvas, document, etc) of this drawing operation.
-
drawColorBackground
private void drawColorBackground(Background background, DrawContext drawContext, Rectangle colorBackgroundArea) -
applyBackgroundBoxProperty
-
drawBackgroundImagesList
private boolean drawBackgroundImagesList(List<BackgroundImage> backgroundImagesList, boolean backgroundAreaIsClipped, DrawContext drawContext, Rectangle backgroundArea) -
drawBackgroundImage
private void drawBackgroundImage(BackgroundImage backgroundImage, DrawContext drawContext, Rectangle backgroundArea) -
drawPdfXObject
private static void drawPdfXObject(Rectangle imageRectangle, BackgroundImage backgroundImage, DrawContext drawContext, PdfXObject backgroundXObject, Rectangle backgroundArea, Rectangle originBackgroundArea) -
drawPdfXObjectHorizontally
private static void drawPdfXObjectHorizontally(Rectangle imageRectangle, BackgroundImage backgroundImage, DrawContext drawContext, PdfXObject backgroundXObject, Rectangle backgroundArea, boolean firstDraw, float xWhitespace) -
createXObject
public static PdfFormXObject createXObject(AbstractLinearGradientBuilder linearGradientBuilder, Rectangle xObjectArea, PdfDocument document) Create aPdfFormXObject
with the given area and containing a linear gradient inside.- Parameters:
linearGradientBuilder
- the linear gradient builderxObjectArea
- the result object areadocument
- the pdf document- Returns:
- the xObject with a specified area and a linear gradient
-
getBackgroundArea
Evaluate the actual background- Parameters:
occupiedAreaWithMargins
- the current occupied area with applied margins- Returns:
- the actual background area
-
clipBorderArea
-
clipBackgroundArea
-
clipBackgroundArea
protected boolean clipBackgroundArea(DrawContext drawContext, Rectangle outerBorderBox, boolean considerBordersBeforeClipping) -
clipArea
private boolean clipArea(DrawContext drawContext, Rectangle outerBorderBox, boolean clipOuter, boolean clipInner, boolean considerBordersBeforeOuterClipping, boolean considerBordersBeforeInnerClipping) -
clipOuterArea
private void clipOuterArea(PdfCanvas canvas, float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY) -
clipInnerArea
private void clipInnerArea(PdfCanvas canvas, float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY, float[] borderWidths) -
decreaseBorderRadiiWithBorders
private float[] decreaseBorderRadiiWithBorders(float[] horizontalRadii, float[] verticalRadii, float[] outerBox, float[] cornersX, float[] cornersY) -
drawChildren
Performs the drawing operation for allchildren
of this renderer.- Parameters:
drawContext
- the context (canvas, document, etc) of this drawing operation.
-
drawBorder
Performs the drawing operation for the border of this renderer, if defined by any of theProperty.BORDER
values in either the layout element or thisIRenderer
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. ifdraw(DrawContext)
has already been called. -
setParent
Explicitly sets this object as the child of anotherIRenderer
in the renderer hierarchy. Some implementations also use this method internally to create a consistent hierarchy tree. -
getParent
Gets the parentIRenderer
. -
move
public void move(float dxRight, float dyUp) Moves the renderer subtree by the specified offset. This method affects occupied area of the renderer. -
initElementAreas
Gets all rectangles that thisIRenderer
can draw upon in the given area.- Parameters:
area
- a physical area on theDrawContext
- Returns:
- a list of
rectangles
-
getOccupiedAreaBBox
Gets the bounding box that contains all content written to theDrawContext
by thisIRenderer
.- Returns:
- the smallest
Rectangle
that surrounds the content
-
getBorderAreaBBox
Gets the border box of a renderer. This is a box used to draw borders.- Returns:
- border box of a renderer
-
getInnerAreaBBox
-
applyMarginsBordersPaddings
Applies margins, borders and paddings of the renderer on the given rectangle.- Parameters:
rect
- a rectangle margins, borders and paddings will be applied on.reverse
- indicates whether margins, borders and paddings will be applied inside (in case of false) or outside (in case of true) the rectangle.- Returns:
- a
border box
of the renderer
-
applyMargins
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:
-
applyBorderBox
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 true) the rectangle.- Returns:
- a
border box
of the renderer - See Also:
-
applyPaddings
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 true) the rectangle.- Returns:
- a
border box
of the renderer - See Also:
-
isFirstOnRootArea
public boolean isFirstOnRootArea() -
applyDestinationsAndAnnotation
-
isBorderBoxSizing
-
isOverflowProperty
-
isOverflowProperty
protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo, IRenderer renderer, int overflowProperty) -
isOverflowProperty
protected static boolean isOverflowProperty(OverflowPropertyValue equalsTo, OverflowPropertyValue rendererOverflowProperty) -
isOverflowFit
-
replaceOwnProperty
<T> T replaceOwnProperty(int property, T replacementValue) Replaces given property own value with the given value.- Type Parameters:
T
- the type associated with the property- Parameters:
property
- the property to be replacedreplacementValue
- the value with which property will be replaced- Returns:
- previous property value
-
returnBackOwnProperty
<T> void returnBackOwnProperty(int property, T prevValue) Returns back own value of the given property.- Type Parameters:
T
- the type associated with the property- Parameters:
property
- the property to be returned backprevValue
- the value which will be returned back
-
hasAspectRatio
boolean hasAspectRatio()Checks if this renderer has intrinsic aspect ratio.- Returns:
- true, if aspect ratio is defined for this renderer, false otherwise
-
getAspectRatio
Float getAspectRatio()Gets intrinsic aspect ratio for this renderer.- Returns:
- aspect ratio, if it is defined for this renderer, null otherwise
-
processWaitingDrawing
-
retrieveWidth
Retrieves element's fixed content box width, if it's set. Takes into accountProperty.BOX_SIZING
,Property.MIN_WIDTH
, andProperty.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:
-
retrieveMaxWidth
Retrieves element's fixed content box max width, if it's set. Takes into accountProperty.BOX_SIZING
andProperty.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:
-
retrieveMinWidth
Retrieves element's fixed content box max width, if it's set. Takes into accountProperty.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:
-
updateWidth
Updates fixed content box width value for this renderer. Takes into accountProperty.BOX_SIZING
property value.- Parameters:
updatedWidthValue
- element's new fixed content box width.
-
retrieveHeight
Retrieves the element's fixed content box height, if it's set. Takes into accountProperty.BOX_SIZING
,Property.MIN_HEIGHT
, andProperty.MAX_HEIGHT
properties.- Returns:
- element's fixed content box height or null if it's not set.
-
calculateRadii
Calculates the element corner's border radii.- Parameters:
radii
- defines border radii of the elementarea
- defines the area of the elementhorizontal
- defines whether horizontal or vertical radii should be calculated- Returns:
- the element corner's border radii.
-
updateHeight
Updates fixed content box height value for this renderer. Takes into accountProperty.BOX_SIZING
property value.- Parameters:
updatedHeight
- element's new fixed content box height, shall be not null.
-
retrieveMaxHeight
Retrieve element's content box max-ehight, if it's set. Takes into accountProperty.BOX_SIZING
property value.- Returns:
- element's content box max-height or null if it's not set.
-
updateMaxHeight
Updates content box max-height value for this renderer. Takes into accountProperty.BOX_SIZING
property value.- Parameters:
updatedMaxHeight
- element's new content box max-height, shall be not null.
-
retrieveMinHeight
Retrieves element's content box min-height, if it's set. Takes into accountProperty.BOX_SIZING
property value.- Returns:
- element's content box min-height or null if it's not set.
-
updateMinHeight
Updates content box min-height value for this renderer. Takes into accountProperty.BOX_SIZING
property value.- Parameters:
updatedMinHeight
- element's new content box min-height, shall be not null.
-
retrieveUnitValue
-
retrieveUnitValue
-
getOwnProperties
-
addAllProperties
-
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
-
allowLastYLineRecursiveExtraction
protected boolean allowLastYLineRecursiveExtraction() -
applyMargins
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 rectanglereverse
- 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
Returns margins of the renderer [0] - top; [1] - right; [2] - bottom; [3] - left- Returns:
- a
float[]
margins of the renderer
-
getPaddings
Returns paddings of the renderer [0] - top; [1] - right; [2] - bottom; [3] - left- Returns:
- a
float[]
paddings of the renderer
-
applyPaddings
Applies given paddings to the given rectangle.- Parameters:
rect
- a rectangle paddings will be applied on.paddings
- the paddings to be applied on the given rectanglereverse
- indicates whether paddings will be applied inside (in case of false) or outside (in case of true) the rectangle.- Returns:
- a
border box
of the renderer
-
applyBorderBox
Applies the given border box (borders) on the given rectangle- Parameters:
rect
- a rectangle paddings will be applied on.borders
- theborders
to be applied on the given rectanglereverse
- 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
-
applyRelativePositioningTranslation
protected void applyRelativePositioningTranslation(boolean reverse) -
applyDestination
-
applyAction
-
applyLinkAnnotation
-
retrieveResolvedParentDeclaredHeight
Retrieve the parent's resolved height declaration. If the parent has a relative height declaration, it will check it's parent recursively,- Returns:
- null if no height declaration is set on the parent, or if it's own height declaration cannot be resolved The float value of the resolved height otherwiser
-
retrieveDirectParentDeclaredHeight
Retrieve the direct parent's absolute height property- Returns:
- the direct parent's absolute height property value if it exists, null otherwise
-
updateHeightsOnSplit
protected void updateHeightsOnSplit(boolean wasHeightClipped, AbstractRenderer splitRenderer, AbstractRenderer overflowRenderer) -
updateHeightsOnSplit
void updateHeightsOnSplit(float usedHeight, boolean wasHeightClipped, AbstractRenderer splitRenderer, AbstractRenderer overflowRenderer, boolean enlargeOccupiedAreaOnHeightWasClipped) -
getMinMaxWidth
Calculates min and max width values for current renderer.- Returns:
- instance of
MinMaxWidth
-
setMinMaxWidthBasedOnFixedWidth
-
isNotFittingHeight
-
isNotFittingWidth
-
isNotFittingLayoutArea
-
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() -
isKeepTogether
-
alignChildHorizontally
-
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 ifProperty.BORDER
is also not set thennull
is returned on position of this border
-
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 ifProperty.BORDER_RADIUS
is also not set thennull
is returned on position of this border radius
-
setBorders
-
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
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
-
transformPoints
-
calculateShiftToPositionBBoxOfPointsAt
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 alignedtop
- y coordinate at which points bbox upper border is to be alignedpoints
- 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.
-
isFirstOnRootArea
boolean isFirstOnRootArea(boolean checkRootAreaOnly) -
getPdfDocument
PdfDocument getPdfDocument()Gets pdf document from root renderers.- Returns:
- PdfDocument, or null if there are no document
-
getRootRenderer
RootRenderer getRootRenderer() -
calculateAdditionalWidth
-
noAbsolutePositionInfo
-
getPropertyAsFloat
-
getPropertyAsUnitValue
Returns the property of the renderer as a UnitValue if it exists and is a UnitValue, null otherwise- Parameters:
renderer
- renderer to retrieve the property fromproperty
- key for the property to retrieve- Returns:
- A UnitValue if the property is present and is a UnitValue, null otherwise
-
shrinkOccupiedAreaForAbsolutePosition
void shrinkOccupiedAreaForAbsolutePosition() -
drawPositionedChildren
-
createFontCharacteristics
FontCharacteristics createFontCharacteristics() -
resolveFirstPdfFont
PdfFont resolveFirstPdfFont()Gets any validPdfFont
for this renderer, based onProperty.FONT
,Property.FONT_PROVIDER
andProperty.FONT_SET
properties. This method will not change font property of renderer. Also it is not guarantied that returned font will contain all glyphs used in renderer or its children.This method is usually needed for evaluating some layout characteristics like ascender or descender.
- Returns:
- a valid
PdfFont
instance based on rendererProperty.FONT
property.
-
resolveFirstPdfFont
PdfFont resolveFirstPdfFont(String[] font, FontProvider provider, FontCharacteristics fc, FontSet additionalFonts) Get first validPdfFont
for this renderer, based on given font-families, font provider and font characteristics. This method will not change font property of renderer. Also it is not guarantied that returned font will contain all glyphs used in renderer or its children.This method is usually needed for evaluating some layout characteristics like ascender or descender.
- Returns:
- a valid
PdfFont
instance based on rendererProperty.FONT
property.
-
getBorders
-
applyAbsolutePositionIfNeeded
-
preparePositionedRendererAndAreaForLayout
-
updateMinHeightForAbsolutelyPositionedRenderer
-
adjustPositionedRendererLayoutBoxWidth
-
calculatePaddingBorderWidth
-
calculatePaddingBorderHeight
-
createTransformationInsideOccupiedArea
This method createsAffineTransform
instance that could be used to transform content inside the occupied area, considering the centre of the occupiedArea as the origin of a coordinate system for transformation.- Returns:
AffineTransform
that transforms the content and places it inside occupied area.
-
beginTransformationIfApplied
-
endTransformationIfApplied
-
addChildRenderer
Add the specifiedrenderer
to the end of children list and update its parent link tothis
.- Parameters:
child
- thechild renderer
to be add
-
addAllChildRenderers
Add the specified collection ofrenderers
to the end of children list and update their parent links tothis
.- Parameters:
children
- the collection ofchild renderers
to be add
-
addAllChildRenderers
Inserts the specified collection ofrenderers
at the specified space of children list and update their parent links tothis
.- Parameters:
index
- index at which to insert the first element from the specified collectionchildren
- the collection ofchild renderers
to be add
-
setChildRenderers
Set the specified collection ofrenderers
as the children forthis
element. That meant that the old collection would be cleaned, all parent links in old children tothis
would be erased (i.e. set tonull
) and then the specified list of children would be added similar toaddAllChildRenderers(List)
.- Parameters:
children
- the collection of childrenrenderers
to be set
-
removeChildRenderer
Remove the childrenderer
at the specified place. If the removed renderer has the parent link set tothis
and it would not present in the children list after removal, then the parent link of the removed renderer would be erased (i.e. set tonull
.- Parameters:
index
- the index of the renderer to be removed- Returns:
- the removed renderer
-
removeAllChildRenderers
Remove the childrenrenderers
which are contains in the specified collection. If some of the removed renderers has the parent link set tothis
, then the parent link of the removed renderer would be erased (i.e. set tonull
.- Parameters:
children
- the collections of renderers to be removed from children list- Returns:
true
if the children list has been changed
-
setChildRenderer
Update the childrenderer
at the specified place with the specified one. If the removed renderer has the parent link set tothis
, then it would be erased (i.e. set tonull
).- Parameters:
index
- the index of the renderer to be updatedchild
- the renderer to be set- Returns:
- the removed renderer
-
setThisAsParent
Sets currentAbstractRenderer
as parent to renderers in specified collection.- Parameters:
children
- the collection of renderers to set the parent renderer on
-
logWarningIfGetNextRendererNotOverridden
-
removeThisFromParent
-
removeThisFromParents
-
getMargins
-
getBorderRadii
-
getPaddings
-
hasOwnOrModelProperty
-
getCurrentStructElem
-