Package com.itextpdf.layout.layout
Class LayoutResult
- java.lang.Object
-
- com.itextpdf.layout.layout.LayoutResult
-
- Direct Known Subclasses:
MinMaxWidthLayoutResult
public class LayoutResult extends java.lang.Object
Represents the result of contentlayouting
.
-
-
Field Summary
Fields Modifier and Type Field Description protected AreaBreak
areaBreak
TheAreaBreak
that will be rendered by this object.protected IRenderer
causeOfNothing
The first renderer to produceNOTHING
duringIRenderer.layout(LayoutContext)
.static int
FULL
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was fully placed.static int
NOTHING
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was not placed.protected LayoutArea
occupiedArea
The area occupied by the content during itslayouting
.protected IRenderer
overflowRenderer
The overflow renderer created duringlayouting
.static int
PARTIAL
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was placed partially.protected IRenderer
splitRenderer
The split renderer created duringlayouting
.protected int
status
The status ofIRenderer.layout(LayoutContext)
which indicates whether the content was added or not and, if yes, was it added fully or partially.
-
Constructor Summary
Constructors Constructor Description LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AreaBreak
getAreaBreak()
Gets areaBreak value.IRenderer
getCauseOfNothing()
Gets the first renderer to produceNOTHING
duringIRenderer.layout(LayoutContext)
LayoutArea
getOccupiedArea()
Gets thelayout area
occupied by the content duringlayouting
.IRenderer
getOverflowRenderer()
Gets the overflow renderer created duringlayouting
.IRenderer
getSplitRenderer()
int
getStatus()
Gets the status ofIRenderer.layout(LayoutContext)
.LayoutResult
setAreaBreak(AreaBreak areaBreak)
Sets areaBreak value.void
setOverflowRenderer(IRenderer overflowRenderer)
Sets the overflowrenderer
.void
setSplitRenderer(IRenderer splitRenderer)
Sets the splitrenderer
.void
setStatus(int status)
Sets the status ofIRenderer.layout(LayoutContext)
.java.lang.String
toString()
-
-
-
Field Detail
-
FULL
public static final int FULL
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was fully placed.- See Also:
- Constant Field Values
-
PARTIAL
public static final int PARTIAL
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was placed partially.- See Also:
- Constant Field Values
-
NOTHING
public static final int NOTHING
The status ofIRenderer.layout(LayoutContext)
which indicates that the content was not placed.- See Also:
- Constant Field Values
-
status
protected int status
The status ofIRenderer.layout(LayoutContext)
which indicates whether the content was added or not and, if yes, was it added fully or partially.
-
occupiedArea
protected LayoutArea occupiedArea
The area occupied by the content during itslayouting
. which indicates whether the content was added or not and, if yes, was it added fully or partially.
-
splitRenderer
protected IRenderer splitRenderer
The split renderer created duringlayouting
. This renderer will be used to draw the splitted part of content.
-
overflowRenderer
protected IRenderer overflowRenderer
The overflow renderer created duringlayouting
. This renderer will be used to draw the overflowed part of content.
-
causeOfNothing
protected IRenderer causeOfNothing
The first renderer to produceNOTHING
duringIRenderer.layout(LayoutContext)
.
-
-
Constructor Detail
-
LayoutResult
public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
Creates theresult of {@link IRenderer#layout(LayoutContext) layouting}
. ThecauseOfNothing
will be set as null.- Parameters:
status
- the status ofIRenderer.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
-
LayoutResult
public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
- Parameters:
status
- the status ofIRenderer.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 produceNOTHING
-
-
Method Detail
-
getStatus
public int getStatus()
Gets the status ofIRenderer.layout(LayoutContext)
.- Returns:
- the status
-
setStatus
public void setStatus(int status)
Sets the status ofIRenderer.layout(LayoutContext)
.- Parameters:
status
- the status ofIRenderer.layout(LayoutContext)
-
getOccupiedArea
public LayoutArea getOccupiedArea()
Gets thelayout area
occupied by the content duringlayouting
.- Returns:
- the
layout area
occupied by the content
-
setSplitRenderer
public void setSplitRenderer(IRenderer splitRenderer)
Sets the splitrenderer
.- Parameters:
splitRenderer
- the renderer to draw the splitted part of the content
-
getOverflowRenderer
public IRenderer getOverflowRenderer()
Gets the overflow renderer created duringlayouting
.- Returns:
- the
renderer
-
setOverflowRenderer
public void setOverflowRenderer(IRenderer overflowRenderer)
Sets the overflowrenderer
.- Parameters:
overflowRenderer
- the renderer to draw the overflowed part of the content
-
getAreaBreak
public AreaBreak getAreaBreak()
Gets areaBreak value.- Returns:
- the areaBreak value
-
setAreaBreak
public LayoutResult setAreaBreak(AreaBreak areaBreak)
Sets areaBreak value.- Parameters:
areaBreak
- the areaBreak value- Returns:
- the areaBreak value
-
getCauseOfNothing
public IRenderer getCauseOfNothing()
Gets the first renderer to produceNOTHING
duringIRenderer.layout(LayoutContext)
- Returns:
- the
renderer
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-