Class LineLayoutResult

Namespace

iText.Layout.Layout

Assembly

itext.layout.dll

Represents the result of a line layouting.

public class LineLayoutResult : MinMaxWidthLayoutResult

Inheritance

object

LayoutResult

MinMaxWidthLayoutResult

LineLayoutResult

Inherited Members

MinMaxWidthLayoutResult.minMaxWidth

MinMaxWidthLayoutResult.GetMinMaxWidth()

MinMaxWidthLayoutResult.SetMinMaxWidth(MinMaxWidth)

LayoutResult.FULL

LayoutResult.PARTIAL

LayoutResult.NOTHING

LayoutResult.status

LayoutResult.occupiedArea

LayoutResult.splitRenderer

LayoutResult.overflowRenderer

LayoutResult.areaBreak

LayoutResult.causeOfNothing

LayoutResult.GetStatus()

LayoutResult.SetStatus(int)

LayoutResult.GetOccupiedArea()

LayoutResult.GetSplitRenderer()

LayoutResult.SetSplitRenderer(IRenderer)

LayoutResult.GetOverflowRenderer()

LayoutResult.SetOverflowRenderer(IRenderer)

LayoutResult.GetAreaBreak()

LayoutResult.SetAreaBreak(AreaBreak)

LayoutResult.GetCauseOfNothing()

LayoutResult.ToString()

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LineLayoutResult(int, LayoutArea, IRenderer, IRenderer)

Creates the LayoutResult result of layouting }.

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

Parameters

status int

the status of Layout(LayoutContext)

occupiedArea LayoutArea

the area occupied by the content

splitRenderer IRenderer

the renderer to draw the splitted part of the content

overflowRenderer IRenderer

the renderer to draw the overflowed part of the content

Remarks

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

LineLayoutResult(int, LayoutArea, IRenderer, IRenderer, IRenderer)

Creates the LayoutResult result of layouting }.

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

Parameters

status int

the status of Layout(LayoutContext)

occupiedArea LayoutArea

the area occupied by the content

splitRenderer IRenderer

the renderer to draw the splitted part of the content

overflowRenderer IRenderer

the renderer to draw the overflowed part of the content

cause IRenderer

the first renderer to produce NOTHING

Fields

splitForcedByNewline

Indicates whether split was forced by new line symbol or not.

protected bool splitForcedByNewline

Field Value

bool

Methods

GetFloatsOverflowedToNextPage()

Gets the list of floats overflowed to next page.

public virtual IList<IRenderer> GetFloatsOverflowedToNextPage()

Returns

IList<IRenderer>

list of floats overflowed to next page

IsSplitForcedByNewline()

Indicates whether split was forced by new line symbol in rendered text.

public virtual bool IsSplitForcedByNewline()

Returns

bool

whether split was forced by new line or not

Remarks

Indicates whether split was forced by new line symbol in rendered text. The value will be set as true if, for example, the rendered text of one of the child renderers contains '\n' symbol.

SetFloatsOverflowedToNextPage(IList<IRenderer>)

Sets the list of floats overflowed to next page.

public virtual void SetFloatsOverflowedToNextPage(IList<IRenderer> floatsOverflowedToNextPage)

Parameters

floatsOverflowedToNextPage IList<IRenderer>

the floats overflowed to next page

SetSplitForcedByNewline(bool)

Sets a flat that split was forced by new line symbol in rendered text.

public virtual LineLayoutResult SetSplitForcedByNewline(bool isSplitForcedByNewline)

Parameters

isSplitForcedByNewline bool

indicates that split was forced by new line symbol in rendered text.

Returns

LineLayoutResult

this layout result the setting was applied on.