iText 8.0.5 API
iText.Layout.Layout.LineLayoutContext Class Reference

Represents the context for content of a line layouting. More...

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

Public Member Functions

  LineLayoutContext (LayoutArea area, MarginsCollapseInfo marginsCollapseInfo, IList< Rectangle > floatedRendererAreas, bool clippedHeight)
  Creates the context for content of a line. More...
 
  LineLayoutContext (LayoutContext layoutContext)
  Creates the context for content of a line. More...
 
virtual bool  IsFloatOverflowedToNextPageWithNothing ()
  Specifies whether some floating element within the same paragraph has already completely overflowed to the next page. More...
 
virtual iText.Layout.Layout.LineLayoutContext  SetFloatOverflowedToNextPageWithNothing (bool floatOverflowedToNextPageWithNothing)
  Changes the value of property specified by IsFloatOverflowedToNextPageWithNothing(). More...
 
virtual float  GetTextIndent ()
  Gets the indent of text in the beginning of the current line. More...
 
virtual iText.Layout.Layout.LineLayoutContext  SetTextIndent (float textIndent)
  Sets the indent of text in the beginning of the current line. More...
 
- Public Member Functions inherited from iText.Layout.Layout.LayoutContext
  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 ()
 

Additional Inherited Members

- Package Attributes inherited from iText.Layout.Layout.LayoutContext
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 of a line layouting.

Constructor & Destructor Documentation

◆ LineLayoutContext() [1/2]

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

Creates the context for content of a line.

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

◆ LineLayoutContext() [2/2]

iText.Layout.Layout.LineLayoutContext.LineLayoutContext ( LayoutContext  layoutContext )
inline

Creates the context for content of a line.

Parameters
layoutContext the context for content layouting

Member Function Documentation

◆ GetTextIndent()

virtual float iText.Layout.Layout.LineLayoutContext.GetTextIndent ( )
inlinevirtual

Gets the indent of text in the beginning of the current line.

Returns
the indent of text in this line.

◆ IsFloatOverflowedToNextPageWithNothing()

virtual bool iText.Layout.Layout.LineLayoutContext.IsFloatOverflowedToNextPageWithNothing ( )
inlinevirtual

Specifies whether some floating element within the same paragraph has already completely overflowed to the next page.

Returns
true if floating element has already overflowed to the next page, false otherwise.

◆ SetFloatOverflowedToNextPageWithNothing()

virtual iText.Layout.Layout.LineLayoutContext iText.Layout.Layout.LineLayoutContext.SetFloatOverflowedToNextPageWithNothing ( bool  floatOverflowedToNextPageWithNothing )
inlinevirtual

Changes the value of property specified by IsFloatOverflowedToNextPageWithNothing().

Parameters
floatOverflowedToNextPageWithNothing true if some floating element already completely overflowed.
Returns
this LineLayoutContext instance.

◆ SetTextIndent()

virtual iText.Layout.Layout.LineLayoutContext iText.Layout.Layout.LineLayoutContext.SetTextIndent ( float  textIndent )
inlinevirtual

Sets the indent of text in the beginning of the current line.

Parameters
textIndent the indent of text in this line.
Returns
this LineLayoutContext instance.