com.itextpdf.layout.renderer

Class LineRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.LineRenderer

All Implemented Interfaces:

IPropertyContainer, IRenderer

public class LineRenderer
extends AbstractRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineRenderer.RendererGlyph

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	levels
protected float	maxAscent
protected float	maxDescent

Fields inherited from class com.itextpdf.layout.renderer.AbstractRenderer

childRenderers, EPS, flushed, INF, isLastRendererForModelElement, modelElement, occupiedArea, OVERLAP_EPSILON, parent, positionedRenderers, properties

Constructor Summary

Constructors

Constructor and Description
LineRenderer()

Method Summary

Modifier and Type	Method and Description
protected LineRenderer	adjustChildrenYLine()
protected void	applyLeading(float deltaY)
protected int	baseCharactersCount() Returns the number of base characters, i.e.
boolean	containsImage()
protected LineRenderer	createOverflowRenderer()
protected LineRenderer	createSplitRenderer()
void	drawChildren(DrawContext drawContext) Performs the drawing operation for all children of this renderer.
protected Float	getFirstYLineRecursively() Gets the first yLine of the nested children recursively.
protected Float	getLastYLineRecursively()
float	getLeadingValue(Leading leading)
float	getMaxAscent()
float	getMaxDescent()
MinMaxWidth	getMinMaxWidth() Calculates min and max width values for current renderer.
IRenderer	getNextRenderer() Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.
protected int	getNumberOfSpaces()
float	getYLine()
void	justify(float width)
LayoutResult	layout(LayoutContext layoutContext) This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e.
protected int	length() Gets the total lengths of characters in this line.
protected Float	retrieveResolvedDeclaredHeight() Retrieve the resolved height declaration.
protected LineRenderer[]	split()
String	toString() Returns a string representation of the renderer.
protected LineRenderer	trimLast()

Methods inherited from class com.itextpdf.layout.renderer.AbstractRenderer

addAllProperties, addChild, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyPaddings, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateBBox, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createXObject, deleteOwnProperty, deleteProperty, draw, drawBackground, drawBorder, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderAreaBBox, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getInnerAreaBBox, getMargins, getMinMaxWidth, getModelElement, getOccupiedArea, getOccupiedAreaBBox, getOwnProperties, getOwnProperty, getPaddings, getParent, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, hasAbsoluteUnitValue, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, move, rectangleToPointsList, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class java.lang.Object

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

Field Detail

maxAscent

protected float maxAscent

maxDescent

protected float maxDescent

levels

protected byte[] levels

Constructor Detail

LineRenderer

public LineRenderer()

Method Detail

layout

public LayoutResult layout(LayoutContext layoutContext)

Description copied from interface: IRenderer

This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.

Parameters:

layoutContext - the description of layout area and any other additional information

Returns:

result of the layout process

getMaxAscent

public float getMaxAscent()

getMaxDescent

public float getMaxDescent()

getYLine

public float getYLine()

getLeadingValue

public float getLeadingValue(Leading leading)

drawChildren

public void drawChildren(DrawContext drawContext)

Description copied from class: AbstractRenderer

Performs the drawing operation for all children of this renderer.

Overrides:

drawChildren in class AbstractRenderer

Parameters:

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

getNextRenderer

public IRenderer getNextRenderer()

Description copied from interface: IRenderer

Gets a new instance of this class to be used as a next renderer, after this renderer is used, if IRenderer.layout(LayoutContext) is called more than once.

Returns:

new renderer instance

getFirstYLineRecursively

protected Float getFirstYLineRecursively()

Description copied from class: AbstractRenderer

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 not go further than the first child.

Overrides:

getFirstYLineRecursively in class AbstractRenderer

Returns:

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

getLastYLineRecursively

protected Float getLastYLineRecursively()

Overrides:

getLastYLineRecursively in class AbstractRenderer

justify

public void justify(float width)

getNumberOfSpaces

protected int getNumberOfSpaces()

length

protected int length()

Gets the total lengths of characters in this line. Other elements (images, tables) are not taken into account.

Returns:

the total lengths of characters in this line.

baseCharactersCount

protected int baseCharactersCount()

Returns the number of base characters, i.e. non-mark characters

Returns:

the number of base non-mark characters

toString

public String toString()

Description copied from class: AbstractRenderer

Returns a string representation of the renderer.

Overrides:

toString in class AbstractRenderer

Returns:

a String

See Also:

Object.toString()

createSplitRenderer

protected LineRenderer createSplitRenderer()

createOverflowRenderer

protected LineRenderer createOverflowRenderer()

split

protected LineRenderer[] split()

adjustChildrenYLine

protected LineRenderer adjustChildrenYLine()

applyLeading

protected void applyLeading(float deltaY)

trimLast

protected LineRenderer trimLast()

containsImage

public boolean containsImage()

getMinMaxWidth

public MinMaxWidth getMinMaxWidth()

Description copied from class: AbstractRenderer

Calculates min and max width values for current renderer.

Overrides:

getMinMaxWidth in class AbstractRenderer

Returns:

instance of MinMaxWidth

retrieveResolvedDeclaredHeight

protected Float retrieveResolvedDeclaredHeight()

Retrieve the resolved height declaration. If it has a relative height declaration, AbstractRenderer.retrieveHeight() is called.

Overrides:

retrieveResolvedDeclaredHeight in class AbstractRenderer

Returns:

null if no height declaration is set on the parent, or if its own height declaration cannot be resolved. The float value of the resolved height otherwise