com.itextpdf.layout.layout

Class LineLayoutResult

java.lang.Object

com.itextpdf.layout.layout.LayoutResult

com.itextpdf.layout.layout.MinMaxWidthLayoutResult

com.itextpdf.layout.layout.LineLayoutResult

public class LineLayoutResult
extends MinMaxWidthLayoutResult

Represents the result of a line layouting.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	splitForcedByNewline Indicates whether split was forced by new line symbol or not.

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
LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer) Creates the result of {@link com.itextpdf.layout.renderer.LineRenderer#layout(LayoutContext) layouting}.
LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause) Creates the result of {@link com.itextpdf.layout.renderer.LineRenderer#layout(LayoutContext) layouting}.

Method Summary

Modifier and Type	Method and Description
List<IRenderer>	getFloatsOverflowedToNextPage()
boolean	isSplitForcedByNewline() Indicates whether split was forced by new line symbol in rendered text.
void	setFloatsOverflowedToNextPage(List<IRenderer> floatsOverflowedToNextPage)
LineLayoutResult	setSplitForcedByNewline(boolean isSplitForcedByNewline) Sets setSplitForcedByNewline(boolean)

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

splitForcedByNewline

protected boolean splitForcedByNewline

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

Constructor Detail

LineLayoutResult

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

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

Parameters:

status - the status of LineRenderer.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

LineLayoutResult

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

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

Parameters:

status - the status of LineRenderer.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

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 of one of the child renderers contains '\n' symbol.

Returns:

whether split was forced by new line or not

setSplitForcedByNewline

public LineLayoutResult setSplitForcedByNewline(boolean isSplitForcedByNewline)

Sets setSplitForcedByNewline(boolean)

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)

getFloatsOverflowedToNextPage

public List<IRenderer> getFloatsOverflowedToNextPage()

setFloatsOverflowedToNextPage

public void setFloatsOverflowedToNextPage(List<IRenderer> floatsOverflowedToNextPage)