iText 7 7.1.9 API
iText.Layout.Layout.LayoutResult Class Reference

Represents the result of content layouting. More...

Inheritance diagram for iText.Layout.Layout.LayoutResult:
iText.Layout.Layout.MinMaxWidthLayoutResult iText.Layout.Layout.LineLayoutResult iText.Layout.Layout.TextLayoutResult

Public Member Functions

  LayoutResult (int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)
  Creates the LayoutResult result of layouting }. More...
 
  LayoutResult (int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)
  Creates the LayoutResult result of layouting }. More...
 
virtual int  GetStatus ()
  Gets the status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext). More...
 
virtual void  SetStatus (int status)
  Sets the status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext). More...
 
virtual LayoutArea  GetOccupiedArea ()
  Gets the layout area occupied by the content during layouting. More...
 
virtual IRenderer  GetSplitRenderer ()
  Gets the split renderer created during layouting. More...
 
virtual void  SetSplitRenderer (IRenderer splitRenderer)
  Sets the split renderer. More...
 
virtual IRenderer  GetOverflowRenderer ()
  Gets the overflow renderer created during layouting. More...
 
virtual void  SetOverflowRenderer (IRenderer overflowRenderer)
  Sets the overflow renderer. More...
 
virtual AreaBreak  GetAreaBreak ()
 
virtual iText.Layout.Layout.LayoutResult  SetAreaBreak (AreaBreak areaBreak)
 
virtual IRenderer  GetCauseOfNothing ()
  Gets the first renderer to produce NOTHING during iText.Layout.Renderer.IRenderer.Layout(LayoutContext) More...
 
override String  ToString ()
 

Static Public Attributes

const int  FULL = 1
  The status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext) which indicates that the content was fully placed. More...
 
const int  PARTIAL = 2
  The status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext) which indicates that the content was placed partially. More...
 
const int  NOTHING = 3
  The status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext) which indicates that the content was not placed. More...
 

Detailed Description

Represents the result of content layouting.

Constructor & Destructor Documentation

◆ LayoutResult() [1/2]

iText.Layout.Layout.LayoutResult.LayoutResult ( int  status,
LayoutArea  occupiedArea,
IRenderer  splitRenderer,
IRenderer  overflowRenderer 
)
inline

Creates the LayoutResult result of layouting }.

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

Parameters
status the status of iText.Layout.Renderer.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() [2/2]

iText.Layout.Layout.LayoutResult.LayoutResult ( int  status,
LayoutArea  occupiedArea,
IRenderer  splitRenderer,
IRenderer  overflowRenderer,
IRenderer  cause 
)
inline

Creates the LayoutResult result of layouting }.

Parameters
status the status of iText.Layout.Renderer.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

Member Function Documentation

◆ GetCauseOfNothing()

virtual IRenderer iText.Layout.Layout.LayoutResult.GetCauseOfNothing ( )
inlinevirtual

Gets the first renderer to produce NOTHING during iText.Layout.Renderer.IRenderer.Layout(LayoutContext)

Returns
the renderer

◆ GetOccupiedArea()

virtual LayoutArea iText.Layout.Layout.LayoutResult.GetOccupiedArea ( )
inlinevirtual

Gets the layout area occupied by the content during layouting.

Returns
the layout area occupied by the content

◆ GetOverflowRenderer()

virtual IRenderer iText.Layout.Layout.LayoutResult.GetOverflowRenderer ( )
inlinevirtual

Gets the overflow renderer created during layouting.

Returns
the renderer

◆ GetSplitRenderer()

virtual IRenderer iText.Layout.Layout.LayoutResult.GetSplitRenderer ( )
inlinevirtual

Gets the split renderer created during layouting.

Returns
the renderer

◆ GetStatus()

virtual int iText.Layout.Layout.LayoutResult.GetStatus ( )
inlinevirtual

Gets the status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext).

Returns
the status

◆ SetOverflowRenderer()

virtual void iText.Layout.Layout.LayoutResult.SetOverflowRenderer ( IRenderer  overflowRenderer )
inlinevirtual

Sets the overflow renderer.

Parameters
overflowRenderer

◆ SetSplitRenderer()

virtual void iText.Layout.Layout.LayoutResult.SetSplitRenderer ( IRenderer  splitRenderer )
inlinevirtual

Sets the split renderer.

Parameters
splitRenderer

◆ SetStatus()

virtual void iText.Layout.Layout.LayoutResult.SetStatus ( int  status )
inlinevirtual

Sets the status of iText.Layout.Renderer.IRenderer.Layout(LayoutContext).

Parameters
status

◆ ToString()

override String iText.Layout.Layout.LayoutResult.ToString ( )
inline

Member Data Documentation

◆ FULL

const int iText.Layout.Layout.LayoutResult.FULL = 1
static

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

◆ NOTHING

const int iText.Layout.Layout.LayoutResult.NOTHING = 3
static

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

◆ PARTIAL

const int iText.Layout.Layout.LayoutResult.PARTIAL = 2
static

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