iText 8.0.5 API
iText.Layout.Layout.LayoutContext Class Reference

Represents the context for content layouting. More...

Inheritance diagram for iText.Layout.Layout.LayoutContext:
iText.Layout.Layout.LineLayoutContext iText.Layout.Layout.PositionedLayoutContext

Public Member Functions

  LayoutContext (LayoutArea area)
  Creates the layout context. More...
 
  LayoutContext (LayoutArea area, MarginsCollapseInfo marginsCollapseInfo)
  Creates the layout context. More...
 
  LayoutContext (LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, IList< Rectangle > floatedRendererAreas)
  Creates the layout context. More...
 
  LayoutContext (LayoutArea area, bool clippedHeight)
  Creates the layout context. More...
 
  LayoutContext (LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, IList< Rectangle > floatedRendererAreas, bool clippedHeight)
  Creates the layout context. More...
 
virtual LayoutArea  GetArea ()
  Gets the area the content to be placed on. More...
 
virtual MarginsCollapseInfo  GetMarginsCollapseInfo ()
  Gets info about margins collapsing. More...
 
virtual IList< Rectangle GetFloatRendererAreas ()
  Gets list of iText.Kernel.Geom.Rectangle objects. More...
 
virtual bool  IsClippedHeight ()
  Indicates whether the layout area's height is clipped or not. More...
 
virtual void  SetClippedHeight (bool clippedHeight)
  Defines whether the layout area's height is clipped or not. More...
 
override String  ToString ()
 

Package Attributes

LayoutArea  area
  The LayoutArea for the content to be placed on. More...
 
MarginsCollapseInfo  marginsCollapseInfo
  The info about margins collapsing. More...
 
IList< Rectangle floatRendererAreas = new List<Rectangle>()
  The list of iText.Kernel.Geom.Rectangle objects. More...
 
bool  clippedHeight = false
  Indicates whether the height is clipped or not. More...
 

Detailed Description

Represents the context for content layouting.

Constructor & Destructor Documentation

◆ LayoutContext() [1/5]

iText.Layout.Layout.LayoutContext.LayoutContext ( LayoutArea  area )
inline

Creates the layout context.

Parameters
area for the content to be placed on

◆ LayoutContext() [2/5]

iText.Layout.Layout.LayoutContext.LayoutContext ( LayoutArea  area,
MarginsCollapseInfo  marginsCollapseInfo 
)
inline

Creates the layout context.

Parameters
area for the content to be placed on
marginsCollapseInfo the info about margins collapsing

◆ LayoutContext() [3/5]

iText.Layout.Layout.LayoutContext.LayoutContext ( LayoutArea  area,
MarginsCollapseInfo  marginsCollapseInfo,
IList< Rectangle floatedRendererAreas 
)
inline

Creates the layout context.

Parameters
area for the content to be placed on
marginsCollapseInfo the info about margins collapsing
floatedRendererAreas list of iText.Kernel.Geom.Rectangle objects

◆ LayoutContext() [4/5]

iText.Layout.Layout.LayoutContext.LayoutContext ( LayoutArea  area,
bool  clippedHeight 
)
inline

Creates the layout context.

Parameters
area for the content to be placed on
clippedHeight indicates whether the height is clipped or not

◆ LayoutContext() [5/5]

iText.Layout.Layout.LayoutContext.LayoutContext ( LayoutArea  area,
MarginsCollapseInfo  marginsCollapseInfo,
IList< Rectangle floatedRendererAreas,
bool  clippedHeight 
)
inline

Creates the layout context.

Parameters
area for the content to be placed on
marginsCollapseInfo the info about margins collapsing
floatedRendererAreas list of iText.Kernel.Geom.Rectangle objects
clippedHeight indicates whether the height is clipped or not

Member Function Documentation

◆ GetArea()

virtual LayoutArea iText.Layout.Layout.LayoutContext.GetArea ( )
inlinevirtual

Gets the area the content to be placed on.

Returns
the area for content layouting.

◆ GetFloatRendererAreas()

virtual IList<Rectangle> iText.Layout.Layout.LayoutContext.GetFloatRendererAreas ( )
inlinevirtual

Gets list of iText.Kernel.Geom.Rectangle objects.

Returns
list of iText.Kernel.Geom.Rectangle objects

◆ GetMarginsCollapseInfo()

virtual MarginsCollapseInfo iText.Layout.Layout.LayoutContext.GetMarginsCollapseInfo ( )
inlinevirtual

Gets info about margins collapsing.

Returns
the info about margins collapsing

◆ IsClippedHeight()

virtual bool iText.Layout.Layout.LayoutContext.IsClippedHeight ( )
inlinevirtual

Indicates whether the layout area's height is clipped or not.

Returns
whether the layout area's height is clipped or not.

◆ SetClippedHeight()

virtual void iText.Layout.Layout.LayoutContext.SetClippedHeight ( bool  clippedHeight )
inlinevirtual

Defines whether the layout area's height is clipped or not.

Parameters
clippedHeight indicates whether the height is clipped or not.

◆ ToString()

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

Member Data Documentation

◆ area

LayoutArea iText.Layout.Layout.LayoutContext.area
package

The LayoutArea for the content to be placed on.

◆ clippedHeight

bool iText.Layout.Layout.LayoutContext.clippedHeight = false
package

Indicates whether the height is clipped or not.

◆ floatRendererAreas

IList<Rectangle> iText.Layout.Layout.LayoutContext.floatRendererAreas = new List<Rectangle>()
package

The list of iText.Kernel.Geom.Rectangle objects.

◆ marginsCollapseInfo

MarginsCollapseInfo iText.Layout.Layout.LayoutContext.marginsCollapseInfo
package

The info about margins collapsing.