iText 9.6.0 API
iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult Class Reference

Represents result of one iteration of MulticolRenderer layouting It contains split renderers which were lauded on a given height and overflow renderer for which height should be increased, so it can be lauded. More...

Public Member Functions

virtual IList< IRenderer GetSplitRenderers ()
  Gets the split renderers. More...
 
virtual AbstractRenderer  GetOverflowRenderer ()
  Gets the overflow renderer. More...
 
virtual void  SetOverflowRenderer (AbstractRenderer overflowRenderer)
  Sets the overflow renderer. More...
 
virtual IRenderer  GetCauseOfNothing ()
  Gets the cause of nothing renderer. More...
 
virtual void  SetCauseOfNothing (IRenderer causeOfNothing)
  Sets the cause of nothing renderer. More...
 

Detailed Description

Represents result of one iteration of MulticolRenderer layouting It contains split renderers which were lauded on a given height and overflow renderer for which height should be increased, so it can be lauded.

Member Function Documentation

◆ GetCauseOfNothing()

virtual IRenderer iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult.GetCauseOfNothing ( )
inlinevirtual

Gets the cause of nothing renderer.

Returns
the cause of nothing renderer, can be null if GetSplitRenderers() is not empty

◆ GetOverflowRenderer()

virtual AbstractRenderer iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult.GetOverflowRenderer ( )
inlinevirtual

Gets the overflow renderer.

Returns
the overflow renderer, can be null if there is no overflow

◆ GetSplitRenderers()

virtual IList<IRenderer> iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult.GetSplitRenderers ( )
inlinevirtual

Gets the split renderers.

Returns
the split renderers (always not null )

◆ SetCauseOfNothing()

virtual void iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult.SetCauseOfNothing ( IRenderer  causeOfNothing )
inlinevirtual

Sets the cause of nothing renderer.

Parameters
causeOfNothing cause of nothing renderer to be set

◆ SetOverflowRenderer()

virtual void iText.Layout.Renderer.MulticolRenderer.MulticolLayoutResult.SetOverflowRenderer ( AbstractRenderer  overflowRenderer )
inlinevirtual

Sets the overflow renderer.

Parameters
overflowRenderer the overflow renderer to be set