Package 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 linelayouting
.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<IRenderer>
floatsOverflowedToNextPage
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 Description LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<IRenderer>
getFloatsOverflowedToNextPage()
Gets the list of floats overflowed to next page.boolean
isSplitForcedByNewline()
Indicates whether split was forced by new line symbol in rendered text.void
setFloatsOverflowedToNextPage(java.util.List<IRenderer> floatsOverflowedToNextPage)
Sets the list of floats overflowed to next page.LineLayoutResult
setSplitForcedByNewline(boolean isSplitForcedByNewline)
Sets a flat that split was forced by new line symbol in rendered text.-
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
-
-
-
-
Field Detail
-
splitForcedByNewline
protected boolean splitForcedByNewline
Indicates whether split was forced by new line symbol or not.
-
floatsOverflowedToNextPage
private java.util.List<IRenderer> floatsOverflowedToNextPage
-
-
Constructor Detail
-
LineLayoutResult
public LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
Creates theresult of {@link com.itextpdf.layout.renderer.LineRenderer#layout(LayoutContext) layouting}
. TheLayoutResult.causeOfNothing
will be set as null.- Parameters:
status
- the status ofLineRenderer.layout(LayoutContext)
occupiedArea
- the area occupied by the contentsplitRenderer
- the renderer to draw the splitted part of the contentoverflowRenderer
- the renderer to draw the overflowed part of the content
-
LineLayoutResult
public LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
Creates theresult of {@link com.itextpdf.layout.renderer.LineRenderer#layout(LayoutContext) layouting}
.- Parameters:
status
- the status ofLineRenderer.layout(LayoutContext)
occupiedArea
- the area occupied by the contentsplitRenderer
- the renderer to draw the splitted part of the contentoverflowRenderer
- the renderer to draw the overflowed part of the contentcause
- the first renderer to produceLayoutResult.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 a flat that split was forced by new line symbol in rendered text.- Parameters:
isSplitForcedByNewline
- indicates that split was forced by new line symbol in rendered text.- Returns:
this layout result
the setting was applied on.
-
getFloatsOverflowedToNextPage
public java.util.List<IRenderer> getFloatsOverflowedToNextPage()
Gets the list of floats overflowed to next page.- Returns:
- list of floats overflowed to next page
-
setFloatsOverflowedToNextPage
public void setFloatsOverflowedToNextPage(java.util.List<IRenderer> floatsOverflowedToNextPage)
Sets the list of floats overflowed to next page.- Parameters:
floatsOverflowedToNextPage
- the floats overflowed to next page
-
-