Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	LayoutContext.BlockBoxingState

Modifier and Type	Field and Description
private LinkedList<BlockFormattingContext>	_bfcs
private BidiReorderer	_bidiReorderer
private BidiSplitterFactory	_bidiSplitterFactory
private LayoutContext.BlockBoxingState	_blockBoxingState
private BreakAtLineContext	_breakAtLineContext
private final ContentFunctionFactory	_contentFunctionFactory
public final Map<CalculatedStyle, CounterContext>	_counterContextMap
private MarkerData	_currentMarkerData
private byte	_defaultTextDirection
private int	_extraSpaceBottom
private int	_extraSpaceTop
private StyleTracker	_firstLetters
private StyleTracker	_firstLines
private FontContext	_fontContext
private int	_footnoteIndex
private FootnoteManager	_footnoteManager
private boolean	_isFootnoteAllowed
private boolean	_isInFloatBottom
private LinkedList<Layer>	_layers
private boolean	_lineBreakedBecauseOfNoWrap
private boolean	_mayCheckKeepTogether
private int	_noPageBreak
private PageBox	_page
private String	_pageName
private String	_pendingPageName
private Layer	_rootDocumentLayer
private Layer	_rootLayer
private LayoutState	_savedLayoutState
private SharedContext	_sharedContext
private final ParagraphSplitter	_splitter
private Boolean	isPrintOverride

Access	Constructor and Description
pack-priv	LayoutContext(SharedContext sharedContext)

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_bfcs	back to summary
private LinkedList<BlockFormattingContext> _bfcs

_bidiReorderer	back to summary
private BidiReorderer _bidiReorderer

_bidiSplitterFactory	back to summary
private BidiSplitterFactory _bidiSplitterFactory

_blockBoxingState	back to summary
private LayoutContext.BlockBoxingState _blockBoxingState

_breakAtLineContext	back to summary
private BreakAtLineContext _breakAtLineContext

_contentFunctionFactory	back to summary
private final ContentFunctionFactory _contentFunctionFactory

_counterContextMap	back to summary
public final Map<CalculatedStyle, CounterContext> _counterContextMap

_currentMarkerData	back to summary
private MarkerData _currentMarkerData

_defaultTextDirection	back to summary
private byte _defaultTextDirection

_extraSpaceBottom	back to summary
private int _extraSpaceBottom

_extraSpaceTop	back to summary
private int _extraSpaceTop

_firstLetters	back to summary
private StyleTracker _firstLetters

_firstLines	back to summary
private StyleTracker _firstLines

_fontContext	back to summary
private FontContext _fontContext

_footnoteIndex	back to summary
private int _footnoteIndex

_footnoteManager	back to summary
private FootnoteManager _footnoteManager

_isFootnoteAllowed	back to summary
private boolean _isFootnoteAllowed

_isInFloatBottom	back to summary
private boolean _isInFloatBottom

_layers	back to summary
private LinkedList<Layer> _layers

_lineBreakedBecauseOfNoWrap	back to summary
private boolean _lineBreakedBecauseOfNoWrap

_mayCheckKeepTogether	back to summary
private boolean _mayCheckKeepTogether

_noPageBreak	back to summary
private int _noPageBreak

_page	back to summary
private PageBox _page

_pageName	back to summary
private String _pageName

_pendingPageName	back to summary
private String _pendingPageName

_rootDocumentLayer	back to summary
private Layer _rootDocumentLayer

_rootLayer	back to summary
private Layer _rootLayer

_savedLayoutState	back to summary
private LayoutState _savedLayoutState

_sharedContext	back to summary
private SharedContext _sharedContext

_splitter	back to summary
private final ParagraphSplitter _splitter

isPrintOverride	back to summary
private Boolean isPrintOverride

Constructor Detail

LayoutContext	back to summary
pack-priv LayoutContext(SharedContext sharedContext)

Method Detail

addBoxId	back to summary
public void addBoxId(String id, Box box)

captureLayoutState	back to summary
public LayoutState captureLayoutState()

copyStateForRelayout	back to summary
public LayoutState copyStateForRelayout()

getBidiReorderer	back to summary
public BidiReorderer getBidiReorderer()

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

getBlockBoxingState	back to summary
public LayoutContext.BlockBoxingState getBlockBoxingState()

getBlockFormattingContext	back to summary
public BlockFormattingContext getBlockFormattingContext()

getBreakAtLineContext	back to summary
public BreakAtLineContext getBreakAtLineContext()

getCanvas	back to summary
public FSCanvas getCanvas()

getContentFunctionFactory	back to summary
public ContentFunctionFactory getContentFunctionFactory()

getCounterContext	back to summary
public AbstractCounterContext getCounterContext(CalculatedStyle style)

getCss	back to summary
public StyleReference getCss() Implements com.openhtmltopdf.css.style.CssContext.getCss.

getCurrentMarkerData	back to summary
public MarkerData getCurrentMarkerData()

getDefaultTextDirection	back to summary
public byte getDefaultTextDirection() Returns:byte the default text direction for a document.

getDotsPerPixel	back to summary
public int getDotsPerPixel() Implements com.openhtmltopdf.css.style.CssContext.getDotsPerPixel.

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

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

getFirstLettersTracker	back to summary
public StyleTracker getFirstLettersTracker()

getFirstLinesTracker	back to summary
public StyleTracker getFirstLinesTracker()

getFixedRectangle	back to summary
public Rectangle getFixedRectangle()

getFont	back to summary
public FSFont getFont(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFont.

getFontContext

back to summary

public FontContext getFontContext()

Implements com.openhtmltopdf.css.style.CssContext.getFontContext.

Annotations

@Override

getFontSize2D	back to summary
public float getFontSize2D(FontSpecification font) Implements com.openhtmltopdf.css.style.CssContext.getFontSize2D.

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

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

getFSFontMetrics	back to summary
public FSFontMetrics getFSFontMetrics(FSFont font) Implements com.openhtmltopdf.css.style.CssContext.getFSFontMetrics.

getLayer	back to summary
public Layer getLayer()

getMmPerDot	back to summary
public float getMmPerDot() Implements com.openhtmltopdf.css.style.CssContext.getMmPerDot.

getNamespaceHandler	back to summary
public NamespaceHandler getNamespaceHandler()

getNoPageBreak	back to summary
public int getNoPageBreak()

getPage	back to summary
public PageBox getPage()

getPageName	back to summary
public String getPageName()

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

getPendingPageName	back to summary
public String getPendingPageName()

getReplacedElementFactory	back to summary
public ReplacedElementFactory getReplacedElementFactory()

getRootDocumentLayer	back to summary
public Layer getRootDocumentLayer()

getRootLayer	back to summary
public Layer getRootLayer()

getSharedContext	back to summary
public SharedContext getSharedContext()

getTextRenderer

back to summary

public TextRenderer getTextRenderer()

Implements com.openhtmltopdf.css.style.CssContext.getTextRenderer.

Annotations

@Override

getUac	back to summary
public UserAgentCallback getUac()

getXHeight	back to summary
public float getXHeight(FontSpecification parentFont) Implements com.openhtmltopdf.css.style.CssContext.getXHeight.

hasActiveFootnotes	back to summary
public boolean hasActiveFootnotes()

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

isInFloatBottom

back to summary

public boolean isInFloatBottom()

Implements com.openhtmltopdf.css.style.CssContext.isInFloatBottom.

Doc from com.openhtmltopdf.css.style.CssContext.isInFloatBottom.

Returns true if we are laying out the footnote area rather than general content.

isInteractive	back to summary
public boolean isInteractive()

isLineBreakedBecauseOfNoWrap	back to summary
public boolean isLineBreakedBecauseOfNoWrap()

isMayCheckKeepTogether	back to summary
public boolean isMayCheckKeepTogether()

isPageBreaksAllowed	back to summary
public boolean isPageBreaksAllowed()

isPrint	back to summary
public boolean isPrint()

popBFC	back to summary
public void popBFC()

popLayer	back to summary
public void popLayer()

pushBFC	back to summary
public void pushBFC(BlockFormattingContext bfc)

pushLayer	back to summary
public void pushLayer(Box master)

pushLayer	back to summary
public void pushLayer(Layer layer)

pushLayerIsolated	back to summary
public void pushLayerIsolated(Box master)

reInit	back to summary
public void reInit(boolean keepLayers)

removeBoxId	back to summary
public void removeBoxId(String id)

resolveCounters	back to summary
public void resolveCounters(CalculatedStyle style, Integer startIndex)

resolveCounters	back to summary
public void resolveCounters(CalculatedStyle style)

restoreLayoutState	back to summary
public void restoreLayoutState(LayoutState layoutState)

restoreStateForRelayout	back to summary
public void restoreStateForRelayout(LayoutState layoutState)

setBidiReorderer	back to summary
public void setBidiReorderer(BidiReorderer reorderer)

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

setBlockBoxingState	back to summary
public void setBlockBoxingState(LayoutContext.BlockBoxingState state)

setBreakAtLineContext	back to summary
public void setBreakAtLineContext(BreakAtLineContext breakAtLineContext)

setCurrentMarkerData	back to summary
public void setCurrentMarkerData(MarkerData currentMarkerData)

setDefaultTextDirection	back to summary
public void setDefaultTextDirection(byte direction) Parameters direction:byte either BidiSplitter.LTR or BidiSplitter.RTL.

setExtraSpaceBottom	back to summary
public void setExtraSpaceBottom(int extraSpaceBottom) See `getExtraSpaceBottom()`

setExtraSpaceTop	back to summary
public void setExtraSpaceTop(int extraSpaceTop) See `getExtraSpaceTop()`

setFirstLettersTracker	back to summary
public void setFirstLettersTracker(StyleTracker firstLetters)

setFirstLinesTracker	back to summary
public void setFirstLinesTracker(StyleTracker firstLines)

setFontContext	back to summary
public void setFontContext(FontContext fontContext)

setFootnoteAllowed	back to summary
public void setFootnoteAllowed(boolean allowed) See `isFootnoteAllowed()`.

setFootnoteIndex	back to summary
public void setFootnoteIndex(int footnoteIndex) See `getFootnoteIndex()`

setIsInFloatBottom	back to summary
public void setIsInFloatBottom(boolean inFloatBottom) See `isInFloatBottom()`

setIsPrintOverride	back to summary
public void setIsPrintOverride(Boolean isPrint) Parameters isPrint:Boolean true, false or null for no override.

setLineBreakedBecauseOfNoWrap	back to summary
public void setLineBreakedBecauseOfNoWrap(boolean value)

setMayCheckKeepTogether	back to summary
public void setMayCheckKeepTogether(boolean mayKeepTogether)

setNoPageBreak	back to summary
public void setNoPageBreak(int noPageBreak)

setPage	back to summary
public void setPage(PageBox page)

setPageName	back to summary
public void setPageName(String currentPageName)

setPendingPageName	back to summary
public void setPendingPageName(String pendingPageName)

setRootDocumentLayer	back to summary
public void setRootDocumentLayer(Layer rootDocumentLayer)

translate	back to summary
public void translate(int x, int y)

com.openhtmltopdf.layout back to summary

public final Enum LayoutContext.BlockBoxingState

Class Inheritance

extends Enum<LayoutContext.BlockBoxingState>

java.lang.Object
java.lang.Enum
com.openhtmltopdf.layout.LayoutContext.BlockBoxingState

Field Summary

Modifier and Type	Field and Description
public static final LayoutContext.BlockBoxingState	ALLOW
public static final LayoutContext.BlockBoxingState	DENY
public static final LayoutContext.BlockBoxingState	NOT_SET

Constructor Summary

Access	Constructor and Description
private	BlockBoxingState()

Method Summary

Modifier and Type	Method and Description
public static LayoutContext.BlockBoxingState	valueOf(String name)
public static LayoutContext.BlockBoxingState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALLOW	back to summary
public static final LayoutContext.BlockBoxingState ALLOW

DENY	back to summary
public static final LayoutContext.BlockBoxingState DENY

NOT_SET	back to summary
public static final LayoutContext.BlockBoxingState NOT_SET

Constructor Detail

BlockBoxingState	back to summary
private BlockBoxingState()

Method Detail

valueOf	back to summary
public static LayoutContext.BlockBoxingState valueOf(String name)

values	back to summary
public static LayoutContext.BlockBoxingState[] values()

public Class LayoutContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum LayoutContext.BlockBoxingState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail