LayoutContext (Openhtmltopdf Core Renderer 1.1.24 API)

java.lang.Object
- com.openhtmltopdf.layout.LayoutContext

All Implemented Interfaces:

CssContext
```
public class LayoutContext
extends Object
implements CssContext
```
This class tracks state which changes over the course of a layout run. Generally speaking, if possible, state information should be stored in the box tree and not here. It also provides pass-though calls to many methods in SharedContext.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LayoutContext.BlockBoxingState

Nested Classes
Modifier and Type	Class and Description
`static class`	`LayoutContext.BlockBoxingState`

Field Summary

Fields
Modifier and Type Field and Description

Map<CalculatedStyle,CounterContext> _counterContextMap

Fields
Modifier and Type	Field and Description
`Map<CalculatedStyle,CounterContext>`	`_counterContextMap`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBoxId(String id, Box box)`
`void`	`addLayoutBoxId(Element elem, Object boxOrInlineBox)`
`LayoutState`	`captureLayoutState()`
`LayoutState`	`copyStateForRelayout()`
`BidiReorderer`	`getBidiReorderer()`
`BidiSplitterFactory`	`getBidiSplitterFactory()` The bidi splitter is used to split text runs into LTR and RTL visual ordering.
`LayoutContext.BlockBoxingState`	`getBlockBoxingState()`
`BlockFormattingContext`	`getBlockFormattingContext()`
`BreakAtLineContext`	`getBreakAtLineContext()`
`FSCanvas`	`getCanvas()`
`ContentFunctionFactory`	`getContentFunctionFactory()`
`AbstractCounterContext`	`getCounterContext(CalculatedStyle style)`
`StyleReference`	`getCss()`
`MarkerData`	`getCurrentMarkerData()`
`byte`	`getDefaultTextDirection()`
`int`	`getDotsPerPixel()`
`int`	`getExtraSpaceBottom()` Returns the extra space set aside for the footers of paginated tables.
`int`	`getExtraSpaceTop()` Returns the extra space set aside for the head section of paginated tables.
`StyleTracker`	`getFirstLettersTracker()`
`StyleTracker`	`getFirstLinesTracker()`
`Rectangle`	`getFixedRectangle()`
`FSFont`	`getFont(FontSpecification font)`
`FontContext`	`getFontContext()`
`float`	`getFontSize2D(FontSpecification font)`
`int`	`getFootnoteIndex()` The zero-based footnote index, which will likely be different from any counter used with the footnote.
`FootnoteManager`	`getFootnoteManager()` Gets the document's footnote manager, creating it if required.
`FSFontMetrics`	`getFSFontMetrics(FSFont font)`
`Layer`	`getLayer()`
`Object`	`getLayoutBox(String id)` Returns null, an `InlineBox` or `BlockBox` with the given id.
`float`	`getMmPerDot()`
`NamespaceHandler`	`getNamespaceHandler()`
`int`	`getNoPageBreak()`
`PageBox`	`getPage()`
`String`	`getPageName()`
`ParagraphSplitter`	`getParagraphSplitter()` The paragraph splitter splits the document into paragraphs for the purpose of bi-directional text analysis.
`String`	`getPendingPageName()`
`ReplacedElementFactory`	`getReplacedElementFactory()`
`Layer`	`getRootDocumentLayer()`
`Layer`	`getRootLayer()`
`SharedContext`	`getSharedContext()`
`TextRenderer`	`getTextRenderer()`
`UserAgentCallback`	`getUac()`
`float`	`getXHeight(FontSpecification parentFont)`
`boolean`	`hasActiveFootnotes()`
`boolean`	`isFootnoteAllowed()` Whether further footnote content is allowed.
`boolean`	`isInFloatBottom()` Returns true if we are laying out the footnote area rather than general content.
`boolean`	`isInteractive()`
`boolean`	`isLineBreakedBecauseOfNoWrap()`
`boolean`	`isMayCheckKeepTogether()`
`boolean`	`isPageBreaksAllowed()`
`boolean`	`isPrint()`
`void`	`popBFC()`
`void`	`popLayer()`
`void`	`pushBFC(BlockFormattingContext bfc)`
`void`	`pushLayer(BlockBox master)`
`void`	`pushLayer(Layer layer)`
`void`	`pushLayerIsolated(BlockBox master)`
`void`	`reInit(boolean keepLayers)`
`void`	`removeBoxId(String id)`
`void`	`resolveCounters(CalculatedStyle style)`
`void`	`resolveCounters(CalculatedStyle style, Integer startIndex)`
`void`	`restoreLayoutState(LayoutState layoutState)`
`void`	`restoreStateForRelayout(LayoutState layoutState)`
`void`	`setBidiReorderer(BidiReorderer reorderer)`
`void`	`setBidiSplitterFactory(BidiSplitterFactory factory)` The bidi splitter is used to split text runs into LTR and RTL visual ordering.
`void`	`setBlockBoxingState(LayoutContext.BlockBoxingState state)`
`void`	`setBreakAtLineContext(BreakAtLineContext breakAtLineContext)`
`void`	`setCurrentMarkerData(MarkerData currentMarkerData)`
`void`	`setDefaultTextDirection(byte direction)`
`void`	`setExtraSpaceBottom(int extraSpaceBottom)` See `getExtraSpaceBottom()`
`void`	`setExtraSpaceTop(int extraSpaceTop)` See `getExtraSpaceTop()`
`void`	`setFirstLettersTracker(StyleTracker firstLetters)`
`void`	`setFirstLinesTracker(StyleTracker firstLines)`
`void`	`setFontContext(FontContext fontContext)`
`void`	`setFootnoteAllowed(boolean allowed)` See `isFootnoteAllowed()`.
`void`	`setFootnoteIndex(int footnoteIndex)` See `getFootnoteIndex()`
`void`	`setIsInFloatBottom(boolean inFloatBottom)` See `isInFloatBottom()`
`void`	`setIsPrintOverride(Boolean isPrint)`
`void`	`setLineBreakedBecauseOfNoWrap(boolean value)`
`void`	`setMayCheckKeepTogether(boolean mayKeepTogether)`
`void`	`setNoPageBreak(int noPageBreak)`
`void`	`setPage(PageBox page)`
`void`	`setPageName(String currentPageName)`
`void`	`setPendingPageName(String pendingPageName)`
`void`	`setRootDocumentLayer(Layer rootDocumentLayer)`
`void`	`translate(int x, int y)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_counterContextMap

public final Map<CalculatedStyle,CounterContext> _counterContextMap

Method Detail

addLayoutBoxId

public void addLayoutBoxId(Element elem,
                           Object boxOrInlineBox)

getLayoutBox
```
public Object getLayoutBox(String id)
```
Returns null, an InlineBox or BlockBox with the given id. NOTE: This is for use pre-layout. Once layout has occurred and InlineBox objects have been transformed into one or more InlineLayoutBox objects, one can use _sharedContext::getBoxById.

getTextRenderer
```
public TextRenderer getTextRenderer()
```
Specified by:

getTextRenderer in interface CssContext

getCss
```
public StyleReference getCss()
```
Specified by:

getCss in interface CssContext

getCanvas
```
public FSCanvas getCanvas()
```

getFixedRectangle
```
public Rectangle getFixedRectangle()
```

getNamespaceHandler

public NamespaceHandler getNamespaceHandler()

getParagraphSplitter
```
public ParagraphSplitter getParagraphSplitter()
```
The paragraph splitter splits the document into paragraphs for the purpose of bi-directional text analysis.

setBidiReorderer

public void setBidiReorderer(BidiReorderer reorderer)

getBidiReorderer

public BidiReorderer getBidiReorderer()

getBidiSplitterFactory
```
public BidiSplitterFactory getBidiSplitterFactory()
```
The bidi splitter is used to split text runs into LTR and RTL visual ordering.

setBidiSplitterFactory
```
public void setBidiSplitterFactory(BidiSplitterFactory factory)
```
The bidi splitter is used to split text runs into LTR and RTL visual ordering.

getDefaultTextDirection
```
public byte getDefaultTextDirection()
```
Returns:

the default text direction for a document.

setDefaultTextDirection
```
public void setDefaultTextDirection(byte direction)
```
Parameters:

direction - either BidiSplitter.LTR or BidiSplitter.RTL.

reInit

public void reInit(boolean keepLayers)

captureLayoutState

public LayoutState captureLayoutState()

restoreLayoutState

public void restoreLayoutState(LayoutState layoutState)

copyStateForRelayout

public LayoutState copyStateForRelayout()

restoreStateForRelayout

public void restoreStateForRelayout(LayoutState layoutState)

getBlockFormattingContext

public BlockFormattingContext getBlockFormattingContext()

pushBFC

public void pushBFC(BlockFormattingContext bfc)

popBFC
```
public void popBFC()
```

pushLayerIsolated

public void pushLayerIsolated(BlockBox master)

pushLayer

public void pushLayer(BlockBox master)

pushLayer
```
public void pushLayer(Layer layer)
```

popLayer
```
public void popLayer()
```

getLayer
```
public Layer getLayer()
```

getRootLayer
```
public Layer getRootLayer()
```

translate

public void translate(int x,
                      int y)

addBoxId

public void addBoxId(String id,
                     Box box)

removeBoxId
```
public void removeBoxId(String id)
```

isInteractive
```
public boolean isInteractive()
```

getMmPerDot
```
public float getMmPerDot()
```
Specified by:

getMmPerDot in interface CssContext

getDotsPerPixel
```
public int getDotsPerPixel()
```
Specified by:

getDotsPerPixel in interface CssContext

getFontSize2D
```
public float getFontSize2D(FontSpecification font)
```
Specified by:

getFontSize2D in interface CssContext

getXHeight

public float getXHeight(FontSpecification parentFont)

Specified by:: getXHeight in interface CssContext

getFont

public FSFont getFont(FontSpecification font)

Specified by:: getFont in interface CssContext

getUac
```
public UserAgentCallback getUac()
```

isPrint
```
public boolean isPrint()
```

setIsPrintOverride
```
public void setIsPrintOverride(Boolean isPrint)
```
Parameters:

isPrint - true, false or null for no override.

getFirstLinesTracker

public StyleTracker getFirstLinesTracker()

getFirstLettersTracker

public StyleTracker getFirstLettersTracker()

getCurrentMarkerData

public MarkerData getCurrentMarkerData()

setCurrentMarkerData

public void setCurrentMarkerData(MarkerData currentMarkerData)

getReplacedElementFactory

public ReplacedElementFactory getReplacedElementFactory()

getFontContext
```
public FontContext getFontContext()
```
Specified by:

getFontContext in interface CssContext

setFontContext

public void setFontContext(FontContext fontContext)

getContentFunctionFactory

public ContentFunctionFactory getContentFunctionFactory()

getSharedContext

public SharedContext getSharedContext()

getExtraSpaceBottom
```
public int getExtraSpaceBottom()
```
Returns the extra space set aside for the footers of paginated tables.

setExtraSpaceBottom

public void setExtraSpaceBottom(int extraSpaceBottom)

See getExtraSpaceBottom()

getExtraSpaceTop
```
public int getExtraSpaceTop()
```
Returns the extra space set aside for the head section of paginated tables.

setExtraSpaceTop

public void setExtraSpaceTop(int extraSpaceTop)

See getExtraSpaceTop()

resolveCounters

public void resolveCounters(CalculatedStyle style,
                            Integer startIndex)

resolveCounters

public void resolveCounters(CalculatedStyle style)

getCounterContext

public AbstractCounterContext getCounterContext(CalculatedStyle style)

getFSFontMetrics
```
public FSFontMetrics getFSFontMetrics(FSFont font)
```
Specified by:

getFSFontMetrics in interface CssContext

getPageName
```
public String getPageName()
```

setPageName

public void setPageName(String currentPageName)

getNoPageBreak
```
public int getNoPageBreak()
```

setNoPageBreak

public void setNoPageBreak(int noPageBreak)

isPageBreaksAllowed
```
public boolean isPageBreaksAllowed()
```

getPendingPageName
```
public String getPendingPageName()
```

setPendingPageName

public void setPendingPageName(String pendingPageName)

getRootDocumentLayer
```
public Layer getRootDocumentLayer()
```

setRootDocumentLayer

public void setRootDocumentLayer(Layer rootDocumentLayer)

getPage
```
public PageBox getPage()
```

setPage
```
public void setPage(PageBox page)
```

isMayCheckKeepTogether

public boolean isMayCheckKeepTogether()

setMayCheckKeepTogether

public void setMayCheckKeepTogether(boolean mayKeepTogether)

setBlockBoxingState

public void setBlockBoxingState(LayoutContext.BlockBoxingState state)

getBlockBoxingState

public LayoutContext.BlockBoxingState getBlockBoxingState()

isLineBreakedBecauseOfNoWrap

public boolean isLineBreakedBecauseOfNoWrap()

setLineBreakedBecauseOfNoWrap

public void setLineBreakedBecauseOfNoWrap(boolean value)

getBreakAtLineContext

public BreakAtLineContext getBreakAtLineContext()

setBreakAtLineContext

public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext)

isFootnoteAllowed
```
public boolean isFootnoteAllowed()
```
Whether further footnote content is allowed. Used to prohibit footnotes inside footnotes.

setFootnoteAllowed

public void setFootnoteAllowed(boolean allowed)

See isFootnoteAllowed().

setIsInFloatBottom

public void setIsInFloatBottom(boolean inFloatBottom)

See isInFloatBottom()

isInFloatBottom
```
public boolean isInFloatBottom()
```
Returns true if we are laying out the footnote area rather than general content.

Specified by:

isInFloatBottom in interface CssContext

setFootnoteIndex

public void setFootnoteIndex(int footnoteIndex)

See getFootnoteIndex()

getFootnoteIndex
```
public int getFootnoteIndex()
```
The zero-based footnote index, which will likely be different from any counter used with the footnote.

hasActiveFootnotes
```
public boolean hasActiveFootnotes()
```

getFootnoteManager
```
public FootnoteManager getFootnoteManager()
```
Gets the document's footnote manager, creating it if required. From the footnote manager, one can add and remove footnote bodies.

setFirstLettersTracker

public void setFirstLettersTracker(StyleTracker firstLetters)

setFirstLinesTracker

public void setFirstLinesTracker(StyleTracker firstLines)

Class LayoutContext

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_counterContextMap

Method Detail

addLayoutBoxId

getLayoutBox

getTextRenderer

getCss

getCanvas

getFixedRectangle

getNamespaceHandler

getParagraphSplitter

setBidiReorderer

getBidiReorderer

getBidiSplitterFactory

setBidiSplitterFactory

getDefaultTextDirection

setDefaultTextDirection

reInit

captureLayoutState

restoreLayoutState

copyStateForRelayout

restoreStateForRelayout

getBlockFormattingContext

pushBFC

popBFC

pushLayerIsolated

pushLayer

pushLayer

popLayer

getLayer

getRootLayer

translate

addBoxId

removeBoxId

isInteractive

getMmPerDot

getDotsPerPixel

getFontSize2D

getXHeight

getFont

getUac

isPrint

setIsPrintOverride

getFirstLinesTracker

getFirstLettersTracker

getCurrentMarkerData

setCurrentMarkerData

getReplacedElementFactory

getFontContext

setFontContext

getContentFunctionFactory

getSharedContext

getExtraSpaceBottom

setExtraSpaceBottom

getExtraSpaceTop

setExtraSpaceTop

resolveCounters

resolveCounters

getCounterContext

getFSFontMetrics

getPageName

setPageName

getNoPageBreak

setNoPageBreak

isPageBreaksAllowed

getPendingPageName

setPendingPageName

getRootDocumentLayer

setRootDocumentLayer

getPage

setPage

isMayCheckKeepTogether

setMayCheckKeepTogether

setBlockBoxingState

getBlockBoxingState