Package com.itextpdf.layout.layout

Class LineLayoutResult

java.lang.Object

com.itextpdf.layout.layout.LayoutResult

com.itextpdf.layout.layout.MinMaxWidthLayoutResult

com.itextpdf.layout.layout.LineLayoutResult

 public class LineLayoutResult extends MinMaxWidthLayoutResult 
      

Represents the result of a line layouting.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	splitForcedByNewline	Indicates whether split was forced by new line symbol or not.

Fields inherited from class com.itextpdf.layout.layout.MinMaxWidthLayoutResult

minMaxWidth

Fields inherited from class com.itextpdf.layout.layout.LayoutResult

areaBreak, causeOfNothing, FULL, NOTHING, occupiedArea, overflowRenderer, PARTIAL, splitRenderer, status

Constructor Summary

Constructors

Constructor	Description
LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer)	Creates the result of layouting.
LineLayoutResult(int status, LayoutArea occupiedArea, IRenderer splitRenderer, IRenderer overflowRenderer, IRenderer cause)	Creates the result of layouting.

Method Summary

Modifier and Type	Method	Description
List<IRenderer>	getFloatsOverflowedToNextPage()	Gets the list of floats overflowed to next page.
boolean	isSplitForcedByNewline()	Indicates whether split was forced by new line symbol in rendered text.
void	setFloatsOverflowedToNextPage(List<IRenderer> floatsOverflowedToNextPage)	Sets the list of floats overflowed to next page.
LineLayoutResult	setSplitForcedByNewline(boolean isSplitForcedByNewline)	Sets a flat that split was forced by new line symbol in rendered text.

Methods inherited from class com.itextpdf.layout.layout.MinMaxWidthLayoutResult

getMinMaxWidth, setMinMaxWidth

Methods inherited from class com.itextpdf.layout.layout.LayoutResult

getAreaBreak, getCauseOfNothing, getOccupiedArea, getOverflowRenderer, getSplitRenderer, getStatus, setAreaBreak, setOverflowRenderer, setSplitRenderer, setStatus, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

splitForcedByNewline

 protected boolean splitForcedByNewline 
            

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

Constructor Details

LineLayoutResult

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

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

Parameters:

status - the status of LineRenderer.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

LineLayoutResult

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

Creates the result of layouting.

Parameters:

status - the status of LineRenderer.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 LayoutResult.NOTHING

Method Details

isSplitForcedByNewline

 public boolean isSplitForcedByNewline() 
            

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.

Returns:

whether split was forced by new line or not

setSplitForcedByNewline

 public LineLayoutResult setSplitForcedByNewline 
             (boolean isSplitForcedByNewline) 
            

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

Parameters:

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

Returns:

this layout result the setting was applied on.

getFloatsOverflowedToNextPage

 public List<IRenderer> getFloatsOverflowedToNextPage() 
            

Gets the list of floats overflowed to next page.

Returns:

list of floats overflowed to next page

setFloatsOverflowedToNextPage

 public void setFloatsOverflowedToNextPage 
             (List<IRenderer> floatsOverflowedToNextPage) 
            

Sets the list of floats overflowed to next page.

Parameters:

floatsOverflowedToNextPage - the floats overflowed to next page