Package com.itextpdf.layout.layout

Class LayoutResult

java.lang.Object

com.itextpdf.layout.layout.LayoutResult

Direct Known Subclasses:

MinMaxWidthLayoutResult

       public class LayoutResult extends Object
      

Represents the result of content layouting.

Field Summary

Fields

Modifier and Type	Field	Description
protected AreaBreak	areaBreak	The AreaBreak that will be rendered by this object.
protected IRenderer	causeOfNothing	The first renderer to produce NOTHING during IRenderer.layout(LayoutContext).
static final int	FULL	The status of IRenderer.layout(LayoutContext) which indicates that the content was fully placed.
static final 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 final 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 Summary

Constructors

Constructor	Description
LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)	Creates the result of layouting.
LayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)	Creates the result of layouting.

Method Summary

Modifier and Type	Method	Description
AreaBreak	getAreaBreak()	Gets areaBreak value.
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()	Gets the split renderer created during layouting.
int	getStatus()	Gets the status of IRenderer.layout(LayoutContext).
LayoutResult	setAreaBreak(AreaBreak areaBreak)	Sets areaBreak value.
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()

Methods inherited from class java.lang.Object

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

Field Details

FULL

             public static final int FULL
            

The status of IRenderer.layout(LayoutContext) which indicates that the content was fully placed.

See Also:

• Constant Field Values

PARTIAL

             public static final int PARTIAL
            

The status of IRenderer.layout(LayoutContext) which indicates that the content was placed partially.

See Also:

• Constant Field Values

NOTHING

             public static final int NOTHING
            

The status of IRenderer.layout(LayoutContext) which indicates that the content was not placed.

See Also:

• Constant Field Values

status

             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.

occupiedArea

             protected LayoutArea occupiedArea
            

The area occupied by the content during its layouting. 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 during layouting. This renderer will be used to draw the splitted part of content.

overflowRenderer

             protected IRenderer overflowRenderer
            

The overflow renderer created during layouting. This renderer will be used to draw the overflowed part of content.

areaBreak

             protected AreaBreak areaBreak
            

The AreaBreak that will be rendered by this object.

causeOfNothing

             protected IRenderer causeOfNothing
            

The first renderer to produce NOTHING during IRenderer.layout(LayoutContext).

Constructor Details

LayoutResult

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

Creates the result of layouting. The causeOfNothing will be set as null.

Parameters:

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

LayoutResult

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

Creates the result of layouting.

Parameters:

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

Method Details

getStatus

             public int getStatus()
            

Gets the status of IRenderer.layout(LayoutContext).

Returns:

the status

setStatus

             public void setStatus
             (int status)
            

Sets the status of IRenderer.layout(LayoutContext).

Parameters:

status - the status of IRenderer.layout(LayoutContext)

getOccupiedArea

             public LayoutArea getOccupiedArea()
            

Gets the layout area occupied by the content during layouting.

Returns:

the layout area occupied by the content

getSplitRenderer

             public IRenderer getSplitRenderer()
            

Gets the split renderer created during layouting.

Returns:

the renderer

setSplitRenderer

             public void setSplitRenderer
             (IRenderer splitRenderer)
            

Sets the split renderer.

Parameters:

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

getOverflowRenderer

             public IRenderer getOverflowRenderer()
            

Gets the overflow renderer created during layouting.

Returns:

the renderer

setOverflowRenderer

             public void setOverflowRenderer
             (IRenderer overflowRenderer)
            

Sets the overflow renderer.

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 produce NOTHING during IRenderer.layout(LayoutContext)

Returns:

the renderer

toString

             public String toString()
            

Overrides:

toString in class Object