Package com.openhtmltopdf.layout

Class LayoutContext

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.

  • Field Details

    • _blockBoxingState

      private LayoutContext.BlockBoxingState _blockBoxingState

    • _sharedContext

      private SharedContext _sharedContext

    • _rootLayer

      private Layer _rootLayer

    • _firstLines

      private StyleTracker _firstLines

    • _firstLetters

      private StyleTracker _firstLetters

    • _currentMarkerData

      private MarkerData _currentMarkerData

    • _bfcs

      private LinkedList<BlockFormattingContext> _bfcs

    • _layers

      private LinkedList<Layer> _layers

    • _fontContext

      private FontContext _fontContext

    • _contentFunctionFactory

      private final ContentFunctionFactory _contentFunctionFactory

    • _extraSpaceTop

      private int _extraSpaceTop

    • _extraSpaceBottom

      private int _extraSpaceBottom

    • _counterContextMap

      public final Map<CalculatedStyle,CounterContext> _counterContextMap

    • _pendingPageName

      private String _pendingPageName

    • _pageName

      private String _pageName

    • _noPageBreak

      private int _noPageBreak

    • _rootDocumentLayer

      private Layer _rootDocumentLayer

    • _page

      private PageBox _page

    • _mayCheckKeepTogether

      private boolean _mayCheckKeepTogether

    • _lineBreakedBecauseOfNoWrap

      private boolean _lineBreakedBecauseOfNoWrap

    • _breakAtLineContext

      private BreakAtLineContext _breakAtLineContext

    • isPrintOverride

      private Boolean isPrintOverride

    • _isInFloatBottom

      private boolean _isInFloatBottom

    • _savedLayoutState

      private LayoutState _savedLayoutState

    • _footnoteIndex

      private int _footnoteIndex

    • _footnoteManager

      private FootnoteManager _footnoteManager

    • _isFootnoteAllowed

      private boolean _isFootnoteAllowed

    • _splitter

      private final ParagraphSplitter _splitter

    • _bidiSplitterFactory

      private BidiSplitterFactory _bidiSplitterFactory

    • _defaultTextDirection

      private byte _defaultTextDirection

    • _bidiReorderer

      private BidiReorderer _bidiReorderer

  • Constructor Details

  • Method Details

    • 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(Box master)

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

    • 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)