public class LayoutResult extends Object
layouting
.
Modifier and Type | Field and Description |
---|---|
protected AreaBreak |
areaBreak |
protected IRenderer |
causeOfNothing
The first renderer to produce NOTHING during IRenderer.layout(LayoutContext) .
|
static int |
FULL
The status of IRenderer.layout(LayoutContext) which indicates that the content was fully placed.
|
static int |
NOTHING
The status of IRenderer.layout(LayoutContext) which indicates that the content was not placed.
|
protected LayoutArea |
occupiedArea
The area occupied by the content during its layouting .
|
protected IRenderer |
overflowRenderer
The overflow renderer created during layouting .
|
static int |
PARTIAL
The status of IRenderer.layout(LayoutContext) which indicates that the content was placed partially.
|
protected IRenderer |
splitRenderer
The split renderer created during layouting .
|
protected int |
status
The status of IRenderer.layout(LayoutContext) which indicates whether the content was added or not and, if yes, was it added fully or partially.
|
Constructor and Description |
---|
LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
|
LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
|
Modifier and Type | Method and Description |
---|---|
AreaBreak |
getAreaBreak() |
IRenderer |
getCauseOfNothing()
Gets the first renderer to produce NOTHING during IRenderer.layout(LayoutContext)
|
LayoutArea |
getOccupiedArea()
Gets the layout area occupied by the content during layouting .
|
IRenderer |
getOverflowRenderer()
Gets the overflow renderer created during layouting .
|
IRenderer |
getSplitRenderer()
|
int |
getStatus()
Gets the status of IRenderer.layout(LayoutContext) .
|
LayoutResult |
setAreaBreak(AreaBreak areaBreak) |
void |
setOverflowRenderer(IRenderer overflowRenderer)
Sets the overflow renderer .
|
void |
setSplitRenderer(IRenderer splitRenderer)
Sets the split renderer .
|
void |
setStatus(int status)
Sets the status of IRenderer.layout(LayoutContext) .
|
String |
toString() |
public static final int FULL
IRenderer.layout(LayoutContext)
which indicates that the content was fully placed.
public static final int PARTIAL
IRenderer.layout(LayoutContext)
which indicates that the content was placed partially.
public static final int NOTHING
IRenderer.layout(LayoutContext)
which indicates that the content was not placed.
protected int status
IRenderer.layout(LayoutContext)
which indicates whether the content was added or not and, if yes, was it added fully or partially.
protected LayoutArea occupiedArea
layouting
. which indicates whether the content was added or not and, if yes, was it added fully or partially.
protected IRenderer splitRenderer
layouting
. This renderer will be used to draw the splitted part of content.
protected IRenderer overflowRenderer
layouting
. This renderer will be used to draw the overflowed part of content.
protected AreaBreak areaBreak
protected IRenderer causeOfNothing
NOTHING
during IRenderer.layout(LayoutContext)
.
public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
result of {@link IRenderer#layout(LayoutContext) layouting}
. The causeOfNothing
will be set as null.
status
- the status of IRenderer.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
public LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
status
- the status of IRenderer.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 NOTHING
public int getStatus()
IRenderer.layout(LayoutContext)
.
public void setStatus(int status)
IRenderer.layout(LayoutContext)
.
status
-
public LayoutArea getOccupiedArea()
layout area
occupied by the content during layouting
.
layout area
occupied by the content
public void setSplitRenderer(IRenderer splitRenderer)
renderer
.
splitRenderer
-
public IRenderer getOverflowRenderer()
layouting
.
renderer
public void setOverflowRenderer(IRenderer overflowRenderer)
renderer
.
overflowRenderer
-
public AreaBreak getAreaBreak()
public LayoutResult setAreaBreak(AreaBreak areaBreak)
public IRenderer getCauseOfNothing()
NOTHING
during IRenderer.layout(LayoutContext)
renderer
Copyright © 1998–2020 iText Group NV. All rights reserved.