com.itextpdf.layout.layout

Class TextLayoutResult

java.lang.Object

com.itextpdf.layout.layout.LayoutResult

com.itextpdf.layout.layout.MinMaxWidthLayoutResult

com.itextpdf.layout.layout.TextLayoutResult

public class TextLayoutResult
extends MinMaxWidthLayoutResult

Represents the result of a text layout.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	splitForcedByNewline Indicates whether split was forced by new line symbol in text or not.
protected boolean	wordHasBeenSplit Indicates whether some word was splitted during layout.

Fields inherited from class com.itextpdf.layout.layout.MinMaxWidthLayoutResult

minMaxWidth

Fields inherited from class com.itextpdf.layout.layout.LayoutResult

areaBreak, causeOfNothing, FULL, NOTHING, occupiedArea, overflowRenderer, PARTIAL, splitRenderer, status

Constructor Summary

Constructors

Constructor and Description
TextLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer) Creates the result of {@link com.itextpdf.layout.renderer.TextRenderer#layout(LayoutContext) layouting}.
TextLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause) Creates the result of {@link com.itextpdf.layout.renderer.TextRenderer#layout(LayoutContext) layouting}.

Method Summary

Modifier and Type	Method and Description
boolean	isSplitForcedByNewline() Indicates whether split was forced by new line symbol in rendered text.
boolean	isWordHasBeenSplit() Indicates whether some word in a rendered text was splitted during layout.
TextLayoutResult	setSplitForcedByNewline(boolean isSplitForcedByNewline) Sets isSplitForcedByNewline()
TextLayoutResult	setWordHasBeenSplit(boolean wordHasBeenSplit) Sets wordHasBeenSplit

Methods inherited from class com.itextpdf.layout.layout.MinMaxWidthLayoutResult

getMinMaxWidth, setMinMaxWidth

Methods inherited from class com.itextpdf.layout.layout.LayoutResult

getAreaBreak, getCauseOfNothing, getOccupiedArea, getOverflowRenderer, getSplitRenderer, getStatus, setAreaBreak, setOverflowRenderer, setSplitRenderer, setStatus, toString

Methods inherited from class java.lang.Object

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

Field Detail

wordHasBeenSplit

protected boolean wordHasBeenSplit

Indicates whether some word was splitted during layout.

splitForcedByNewline

protected boolean splitForcedByNewline

Indicates whether split was forced by new line symbol in text or not.

Constructor Detail

TextLayoutResult

public TextLayoutResult(int status,
                        LayoutArea occupiedArea,
                        IRenderer splitRenderer,
                        IRenderer overflowRenderer)

Creates the result of {@link com.itextpdf.layout.renderer.TextRenderer#layout(LayoutContext) layouting}. The LayoutResult.causeOfNothing will be set as null.

Parameters:

status - the status of TextRenderer.layout(LayoutContext)

occupiedArea - the area occupied by the content

splitRenderer - the renderer to draw the splitted part of the content

overflowRenderer - the renderer to draw the overflowed part of the content

TextLayoutResult

public TextLayoutResult(int status,
                        LayoutArea occupiedArea,
                        IRenderer splitRenderer,
                        IRenderer overflowRenderer,
                        IRenderer cause)

Creates the result of {@link com.itextpdf.layout.renderer.TextRenderer#layout(LayoutContext) layouting}.

Parameters:

status - the status of TextRenderer.layout(LayoutContext)

occupiedArea - the area occupied by the content

splitRenderer - the renderer to draw the splitted part of the content

overflowRenderer - the renderer to draw the overflowed part of the content

cause - the first renderer to produce LayoutResult.NOTHING

Method Detail

isWordHasBeenSplit

public boolean isWordHasBeenSplit()

Indicates whether some word in a rendered text was splitted during layout. The value will be set as true if, for example, the rendered words width is bigger than the width of layout area.

Returns:

whether some word was splitted or not.

setWordHasBeenSplit

public TextLayoutResult setWordHasBeenSplit(boolean wordHasBeenSplit)

Sets wordHasBeenSplit

Parameters:

wordHasBeenSplit - indicates that some word was splitted during layout.

Returns:

this layout result the setting was applied on

See Also:

wordHasBeenSplit

isSplitForcedByNewline

public boolean isSplitForcedByNewline()

Indicates whether split was forced by new line symbol in rendered text. The value will be set as true if, for example, the rendered text contains '\n' symbol. This value can also be true even if the text was fully placed, but had line break at the end.

Returns:

whether split was forced by new line or not.

setSplitForcedByNewline

public TextLayoutResult setSplitForcedByNewline(boolean isSplitForcedByNewline)

Sets isSplitForcedByNewline()

Parameters:

isSplitForcedByNewline - indicates that split was forced by new line symbol in rendered text.

Returns:

this layout result the setting was applied on.

See Also:

setSplitForcedByNewline(boolean)