LayoutContext (Flying Saucer Core Renderer 9.1.20 API)

java.lang.Object
- org.xhtmlrenderer.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

class LayoutContext.CounterContext

Nested Classes
Modifier and Type	Class and Description
`class`	`LayoutContext.CounterContext`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBoxId(String id, Box box)`
`LayoutState`	`captureLayoutState()`
`LayoutState`	`copyStateForRelayout()`
`BlockFormattingContext`	`getBlockFormattingContext()`
`BreakAtLineContext`	`getBreakAtLineContext()`
`FSCanvas`	`getCanvas()`
`ContentFunctionFactory`	`getContentFunctionFactory()`
`LayoutContext.CounterContext`	`getCounterContext(CalculatedStyle style)`
`StyleReference`	`getCss()`
`MarkerData`	`getCurrentMarkerData()`
`int`	`getDotsPerPixel()`
`int`	`getExtraSpaceBottom()`
`int`	`getExtraSpaceTop()`
`StyleTracker`	`getFirstLettersTracker()`
`StyleTracker`	`getFirstLinesTracker()`
`Rectangle`	`getFixedRectangle()`
`FSFont`	`getFont(FontSpecification font)`
`FontContext`	`getFontContext()`
`float`	`getFontSize2D(FontSpecification font)`
`FSFontMetrics`	`getFSFontMetrics(FSFont font)`
`Layer`	`getLayer()`
`float`	`getMmPerDot()`
`NamespaceHandler`	`getNamespaceHandler()`
`int`	`getNoPageBreak()`
`PageBox`	`getPage()`
`String`	`getPageName()`
`String`	`getPendingPageName()`
`ReplacedElementFactory`	`getReplacedElementFactory()`
`Layer`	`getRootDocumentLayer()`
`Layer`	`getRootLayer()`
`SharedContext`	`getSharedContext()`
`TextRenderer`	`getTextRenderer()`
`UserAgentCallback`	`getUac()`
`float`	`getXHeight(FontSpecification parentFont)`
`boolean`	`isInteractive()`
`boolean`	`isMayCheckKeepTogether()`
`boolean`	`isPageBreaksAllowed()`
`boolean`	`isPrint()`
`void`	`popBFC()`
`void`	`popLayer()`
`void`	`pushBFC(BlockFormattingContext bfc)`
`void`	`pushLayer(Box master)`
`void`	`pushLayer(Layer layer)`
`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`	`setBreakAtLineContext(BreakAtLineContext breakAtLineContext)`
`void`	`setCurrentMarkerData(MarkerData currentMarkerData)`
`void`	`setExtraSpaceBottom(int extraSpaceBottom)`
`void`	`setExtraSpaceTop(int extraSpaceTop)`
`void`	`setFontContext(FontContext fontContext)`
`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

Method Detail

getTextRenderer
```
public TextRenderer getTextRenderer()
```

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

getCss in interface CssContext

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

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

getNamespaceHandler

public NamespaceHandler getNamespaceHandler()

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()
```

pushLayer
```
public void pushLayer(Box 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()
```

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()
```

setFontContext

public void setFontContext(FontContext fontContext)

getContentFunctionFactory

public ContentFunctionFactory getContentFunctionFactory()

getSharedContext

public SharedContext getSharedContext()

getExtraSpaceBottom
```
public int getExtraSpaceBottom()
```

setExtraSpaceBottom

public void setExtraSpaceBottom(int extraSpaceBottom)

getExtraSpaceTop
```
public int getExtraSpaceTop()
```

setExtraSpaceTop

public void setExtraSpaceTop(int extraSpaceTop)

resolveCounters

public void resolveCounters(CalculatedStyle style,
                            Integer startIndex)

resolveCounters

public void resolveCounters(CalculatedStyle style)

getCounterContext

public LayoutContext.CounterContext 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)

getBreakAtLineContext

public BreakAtLineContext getBreakAtLineContext()

setBreakAtLineContext

public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext)

Class LayoutContext

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getTextRenderer

getCss

getCanvas

getFixedRectangle

getNamespaceHandler

reInit

captureLayoutState

restoreLayoutState

copyStateForRelayout

restoreStateForRelayout

getBlockFormattingContext

pushBFC

popBFC

pushLayer

pushLayer

popLayer

getLayer

getRootLayer

translate

addBoxId

removeBoxId

isInteractive

getMmPerDot

getDotsPerPixel

getFontSize2D

getXHeight

getFont

getUac

isPrint

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

getBreakAtLineContext

setBreakAtLineContext