java.lang.Object

com.openhtmltopdf.render.Box

com.openhtmltopdf.render.BlockBox

All Implemented Interfaces:: InlinePaintable, Styleable, DisplayListItem

Direct Known Subclasses:: AnonymousBlockBox, FlowingColumnBox, FlowingColumnContainerBox, MarginBox, TableBox, TableCellBox, TableRowBox, TableSectionBox, ViewportBox

public class BlockBox
extends Box
implements InlinePaintable

A block box as defined in the CSS spec. It also provides a base class for other kinds of block content (for example table rows or cells).

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class BlockBox.MarginCollapseResult

Nested classes/interfaces inherited from class com.openhtmltopdf.render.Box
Box.ChildIteratorOfType<T>

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`CONTENT_BLOCK`
`static int`	`CONTENT_EMPTY`
`static int`	`CONTENT_INLINE`
`static int`	`CONTENT_UNKNOWN`
`protected static int`	`NO_BASELINE`
`static int`	`POSITION_BOTH`
`static int`	`POSITION_HORIZONTALLY`
`static int`	`POSITION_VERTICALLY`

Fields inherited from class com.openhtmltopdf.render.Box

CHILDREN_FLUX, DONE, DUMP_LAYOUT, DUMP_RENDER, FLUX, LINE_SEPARATOR, NOTHING

Constructor Summary

Constructors

Constructor Description

BlockBox()

Method Summary

Modifier and Type	Method	Description
`protected void`	`addBoxID(LayoutContext c)`
`protected void`	`appendPositioningInfo(StringBuilder result)`
`int`	`calcBaseline(LayoutContext c)`
`BreakAtLineContext`	`calcBreakAtLineContext(LayoutContext c)`
`void`	`calcCanvasLocation()`
`void`	`calcChildLocations()`
`protected void`	`calcChildPaintingInfo(CssContext c, PaintingInfo result, boolean useCache)`
`void`	`calcDimensions(LayoutContext c)`
`protected void`	`calcDimensions(LayoutContext c, int cssWidth)`
`protected int`	`calcInitialBreakAtLine(LayoutContext c)`
`void`	`calcInitialFloatedCanvasLocation(LayoutContext c)`
`int`	`calcInlineBaseline(CssContext c)`
`protected void`	`calcLayoutHeight(LayoutContext c, BorderPropertySet border, RectPropertySet margin, RectPropertySet padding)`	Oh oh! Up to this method height is used to track content height.
`void`	`calcMinMaxWidth(LayoutContext c)`
`boolean`	`checkPageContext(LayoutContext c)`
`protected void`	`collapseMargins(LayoutContext c)`
`BlockBox`	`copyOf()`
`void`	`createMarkerData(LayoutContext c)`
`String`	`dump(LayoutContext c, String indent, int which)`
`void`	`ensureChildren(LayoutContext c)`
`LineBox`	`findLastNthLineBox(int count)`
`int`	`findOffset(Box box)`
`protected int`	`getAvailableWidth(LayoutContext c)`
`int`	`getChildrenContentType()`
`int`	`getChildrenHeight()`
`protected int`	`getCSSFitToWidth(CssContext c)`
`protected int`	`getCSSHeight(CssContext c)`
`protected int`	`getCSSWidth(CssContext c)`
`protected int`	`getCSSWidth(CssContext c, boolean shrinkingToFit)`
`Box`	`getDocumentParent()`
`protected String`	`getExtraBoxDescription()`
`CascadedStyle`	`getFirstLetterStyle()`
`CascadedStyle`	`getFirstLineStyle()`
`FloatedBoxData`	`getFloatedBoxData()`
`List<Styleable>`	`getInlineContent()`
`LineBox`	`getLineBox()`
`int`	`getListCounter()`
`MarkerData`	`getMarkerData()`
`int`	`getMaxWidth()`
`int`	`getMinWidth()`
`protected BlockBox`	`getNextCollapsableSibling(BlockBox.MarginCollapseResult collapsedMargin)`
`protected int`	`getPageClearance()`
`Rectangle`	`getPaintingClipEdge(CssContext cssCtx)`
`PersistentBFC`	`getPersistentBFC()`
`ReplacedElement`	`getReplacedElement()`
`Box`	`getStaticEquivalent()`
`void`	`initStaticPos(LayoutContext c, BlockBox parent, int childOffset)`
`protected boolean`	`isAllowHeightToShrink()`
`boolean`	`isAutoHeight()`
`boolean`	`isBottomMarginCalculated()`
`boolean`	`isContainsInlineContent(LayoutContext c)`
`boolean`	`isCurrentBreakAtLineContext(LayoutContext c)`
`protected boolean`	`isFixedWidthAdvisoryOnly()`
`boolean`	`isFloated()`
`boolean`	`isFromCaptionedTable()`
`boolean`	`isInline()`
`protected boolean`	`isInlineBlock()`
`boolean`	`isInMainFlow()`
`boolean`	`isListItem()`
`protected boolean`	`isMayCollapseMarginsWithChildren()`
`protected boolean`	`isMinMaxCalculated()`
`boolean`	`isNeedPageClear()`
`boolean`	`isNeedsClipOnPaint(CssContext c)`
`boolean`	`isNeedsKeepWithInline(LayoutContext c)`
`boolean`	`isPageBreakNeededBecauseOfMinHeight(LayoutContext context)`	Using the css: -fs-page-break-min-height: 5cm; on a block element you can force a pagebreak before this block, if not enough space (e.g.
`boolean`	`isReplaced()`
`protected boolean`	`isSkipWhenCollapsingMargins()`
`boolean`	`isTopMarginCalculated()`
`void`	`layout(LayoutContext c)`
`void`	`layout(LayoutContext c, int contentStart)`
`protected void`	`layoutChildren(LayoutContext c, int contentStart)`
`protected void`	`layoutInlineChildren(LayoutContext c, int contentStart, int breakAtLine, boolean tryAgain)`
`void`	`paintDebugOutline(RenderingContext c)`
`void`	`paintInline(RenderingContext c)`
`void`	`paintListMarker(RenderingContext c)`
`void`	`positionAbsolute(CssContext cssCtx, int direction)`
`void`	`positionAbsoluteOnPage(LayoutContext c)`
`protected void`	`propagateExtraSpace(LayoutContext c, ContentLimitContainer parentContainer, ContentLimitContainer currentContainer, int extraTop, int extraBottom)`
`void`	`reset(LayoutContext c)`
`protected void`	`resolveAutoMargins(LayoutContext c, int cssWidth, RectPropertySet padding, BorderPropertySet border)`
`void`	`setBottomMarginCalculated(boolean bottomMarginCalculated)`
`void`	`setChildrenContentType(int contentType)`
`protected void`	`setChildrenHeight(int childrenHeight)`
`protected void`	`setDimensionsCalculated(boolean dimensionsCalculated)`
`void`	`setElement(Element element)`
`void`	`setFirstLetterStyle(CascadedStyle firstLetterStyle)`
`void`	`setFirstLineStyle(CascadedStyle firstLineStyle)`
`void`	`setFloatedBoxData(FloatedBoxData floatedBoxData)`
`void`	`setFromCaptionedTable(boolean fromTable)`
`void`	`setInlineContent(List<Styleable> inlineContent)`
`void`	`setListCounter(int listCounter)`
`void`	`setMarkerData(MarkerData markerData)`
`protected void`	`setMaxWidth(int maxWidth)`
`protected void`	`setMinMaxCalculated(boolean minMaxCalculated)`
`protected void`	`setMinWidth(int minWidth)`
`void`	`setNeedPageClear(boolean needPageClear)`
`protected void`	`setNeedShrinkToFitCalculatation(boolean needShrinkToFitCalculatation)`
`void`	`setPersistentBFC(PersistentBFC persistentBFC)`
`void`	`setReplacedElement(ReplacedElement replacedElement)`
`void`	`setStaticEquivalent(Box staticEquivalent)`
`void`	`setTopMarginCalculated(boolean topMarginCalculated)`
`boolean`	`shouldBeReplaced()`
`void`	`styleText(LayoutContext c)`
`void`	`styleText(LayoutContext c, CalculatedStyle style)`
`String`	`toString()`

Methods inherited from class com.openhtmltopdf.render.Box

addAllChildren, addChild, addChildForLayout, analyzePageBreaks, ancestors, ancestorsWhile, calcPaintingInfo, collectText, connectChildrenToCurrentLayer, crossesPageBreak, detach, dumpBoxes, exportPageBoxText, exportText, find, findAncestor, findColumnBreakOpportunities, forcePageBreakAfter, forcePageBreakBefore, getAbsoluteClipBox, getAbsX, getAbsY, getAccessibilityObject, getBorder, getBorderBox, getBorderBoxHeight, getBorderBoxWidth, getBorderEdge, getBorderSides, getBoxDimensions, getChild, getChildCount, getChildIterator, getChildIteratorOfType, getChildren, getChildrenClipEdge, getClipBox, getContainingBlock, getContainingBlockWidth, getContainingLayer, getContentAreaEdge, getContentWidth, getEffBackgroundColor, getEffectiveWidth, getElement, getElementBoxes, getHeight, getIndex, getLayer, getLeftMBP, getMargin, getMarginBorderPadding, getMarginEdge, getMarginEdge, getNext, getNextSibling, getPadding, getPaddingEdge, getPaddingWidth, getPaintingBorderEdge, getPaintingInfo, getPaintingPaddingEdge, getParent, getParentClipBox, getPrevious, getPreviousSibling, getPseudoElementOrClass, getRelativeOffset, getRestyleTarget, getRightMBP, getState, getStyle, getStyleMargin, getStyleMargin, getTx, getTy, getWidth, getX, getY, hasNonTextContent, hasRootElementBackground, initContainingLayer, intersects, isAnonymous, isBody, isContainedInMarginBox, isFirstChild, isInDocumentFlow, isInitialContainingBlock, isMarginAreaRoot, isRoot, isStyled, isTerminalColumnBreak, moveIfGreater, paintBackground, paintBorder, paintRootElementBackground, positionRelative, removeAllChildren, removeChild, removeChild, resetChildren, resetChildren, resetTopMargin, restyle, restyleChildren, rootBox, setAbsX, setAbsY, setAccessiblityObject, setAnonymous, setBorderBoxHeight, setBorderBoxWidth, setBoxDimensions, setContainingBlock, setContainingLayer, setContentWidth, setHeight, setIndex, setLayer, setLeftMBP, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setParent, setPseudoElementOrClass, setRelativeOffset, setRightMBP, setState, setStyle, setTx, setTy, setX, setY, stateToString

Methods inherited from class java.lang.Object

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

Field Details
- POSITION_VERTICALLY
  
  public static final int POSITION_VERTICALLY
  
  See Also:
  
  Constant Field Values
- POSITION_HORIZONTALLY
  
  public static final int POSITION_HORIZONTALLY
  
  See Also:
  
  Constant Field Values
- POSITION_BOTH
  
  public static final int POSITION_BOTH
  
  See Also:
  
  Constant Field Values
- CONTENT_UNKNOWN
  
  public static final int CONTENT_UNKNOWN
  
  See Also:
  
  Constant Field Values
- CONTENT_INLINE
  
  public static final int CONTENT_INLINE
  
  See Also:
  
  Constant Field Values
- CONTENT_BLOCK
  
  public static final int CONTENT_BLOCK
  
  See Also:
  
  Constant Field Values
- CONTENT_EMPTY
  
  public static final int CONTENT_EMPTY
  
  See Also:
  
  Constant Field Values
- NO_BASELINE
  
  protected static final int NO_BASELINE
  
  See Also:
  
  Constant Field Values
Constructor Details
- BlockBox
  
  public BlockBox()
Method Details
- setElement
  
  public void setElement(Element element)
  
  Specified by:
  
  setElement in interface Styleable
  
  Overrides:
  
  setElement in class Box
- copyOf
  
  public BlockBox copyOf()
- getExtraBoxDescription
  
  protected String getExtraBoxDescription()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Box
- appendPositioningInfo
  
  protected void appendPositioningInfo(StringBuilder result)
- dump
  
  public String dump(LayoutContext c, String indent, int which)
  
  Specified by:
  
  dump in class Box
- isListItem
  
  public boolean isListItem()
- paintListMarker
  
  public void paintListMarker(RenderingContext c)
- getPaintingClipEdge
  
  public Rectangle getPaintingClipEdge(CssContext cssCtx)
  
  Overrides:
  
  getPaintingClipEdge in class Box
- paintInline
  
  public void paintInline(RenderingContext c)
  
  Specified by:
  
  paintInline in interface InlinePaintable
- isInline
  
  public boolean isInline()
- getLineBox
  
  public LineBox getLineBox()
- paintDebugOutline
  
  public void paintDebugOutline(RenderingContext c)
- getMarkerData
  
  public MarkerData getMarkerData()
- setMarkerData
  
  public void setMarkerData(MarkerData markerData)
- createMarkerData
  
  public void createMarkerData(LayoutContext c)
- getListCounter
  
  public int getListCounter()
- setListCounter
  
  public void setListCounter(int listCounter)
- getPersistentBFC
  
  public PersistentBFC getPersistentBFC()
- setPersistentBFC
  
  public void setPersistentBFC(PersistentBFC persistentBFC)
- getStaticEquivalent
  
  public Box getStaticEquivalent()
- setStaticEquivalent
  
  public void setStaticEquivalent(Box staticEquivalent)
- shouldBeReplaced
  
  public boolean shouldBeReplaced()
- isReplaced
  
  public boolean isReplaced()
- calcCanvasLocation
  
  public void calcCanvasLocation()
  
  Specified by:
  
  calcCanvasLocation in class Box
- calcInitialFloatedCanvasLocation
  
  public void calcInitialFloatedCanvasLocation(LayoutContext c)
- calcChildLocations
  
  public void calcChildLocations()
  
  Overrides:
  
  calcChildLocations in class Box
- isNeedPageClear
  
  public boolean isNeedPageClear()
- setNeedPageClear
  
  public void setNeedPageClear(boolean needPageClear)
- positionAbsolute
  
  public void positionAbsolute(CssContext cssCtx, int direction)
- isPageBreakNeededBecauseOfMinHeight
  
  public boolean isPageBreakNeededBecauseOfMinHeight(LayoutContext context)
  
  Using the css: -fs-page-break-min-height: 5cm; on a block element you can force a pagebreak before this block, if not enough space (e.g. 5cm in this case) is remaining on the current page for the block.
  
  Returns:
  
  true if a pagebreak is needed before this block because there is not enough space left on the current page.
- positionAbsoluteOnPage
  
  public void positionAbsoluteOnPage(LayoutContext c)
- getReplacedElement
  
  public ReplacedElement getReplacedElement()
- setReplacedElement
  
  public void setReplacedElement(ReplacedElement replacedElement)
- reset
  
  public void reset(LayoutContext c)
  
  Overrides:
  
  reset in class Box
- resolveAutoMargins
  
  protected void resolveAutoMargins(LayoutContext c, int cssWidth, RectPropertySet padding, BorderPropertySet border)
- calcDimensions
  
  public void calcDimensions(LayoutContext c)
- calcDimensions
  
  protected void calcDimensions(LayoutContext c, int cssWidth)
- addBoxID
  
  protected void addBoxID(LayoutContext c)
- layout
  
  public void layout(LayoutContext c)
- layout
  
  public void layout(LayoutContext c, int contentStart)
- isAllowHeightToShrink
  
  protected boolean isAllowHeightToShrink()
- getPageClearance
  
  protected int getPageClearance()
- calcLayoutHeight
  
  protected void calcLayoutHeight(LayoutContext c, BorderPropertySet border, RectPropertySet margin, RectPropertySet padding)
  
  Oh oh! Up to this method height is used to track content height. After this method it is used to track total layout height!
- ensureChildren
  
  public void ensureChildren(LayoutContext c)
- layoutChildren
  
  protected void layoutChildren(LayoutContext c, int contentStart)
- layoutInlineChildren
  
  protected void layoutInlineChildren(LayoutContext c, int contentStart, int breakAtLine, boolean tryAgain)
- getChildrenContentType
  
  public int getChildrenContentType()
- setChildrenContentType
  
  public void setChildrenContentType(int contentType)
- getInlineContent
  
  public List<Styleable> getInlineContent()
- setInlineContent
  
  public void setInlineContent(List<Styleable> inlineContent)
- isSkipWhenCollapsingMargins
  
  protected boolean isSkipWhenCollapsingMargins()
- isMayCollapseMarginsWithChildren
  
  protected boolean isMayCollapseMarginsWithChildren()
- collapseMargins
  
  protected void collapseMargins(LayoutContext c)
- getNextCollapsableSibling
  
  protected BlockBox getNextCollapsableSibling(BlockBox.MarginCollapseResult collapsedMargin)
- isTopMarginCalculated
  
  public boolean isTopMarginCalculated()
- setTopMarginCalculated
  
  public void setTopMarginCalculated(boolean topMarginCalculated)
- isBottomMarginCalculated
  
  public boolean isBottomMarginCalculated()
- setBottomMarginCalculated
  
  public void setBottomMarginCalculated(boolean bottomMarginCalculated)
- getCSSWidth
  
  protected int getCSSWidth(CssContext c)
- getCSSWidth
  
  protected int getCSSWidth(CssContext c, boolean shrinkingToFit)
- getCSSFitToWidth
  
  protected int getCSSFitToWidth(CssContext c)
- getCSSHeight
  
  protected int getCSSHeight(CssContext c)
- isAutoHeight
  
  public boolean isAutoHeight()
- getAvailableWidth
  
  protected int getAvailableWidth(LayoutContext c)
- isFixedWidthAdvisoryOnly
  
  protected boolean isFixedWidthAdvisoryOnly()
- calcMinMaxWidth
  
  public void calcMinMaxWidth(LayoutContext c)
- getMaxWidth
  
  public int getMaxWidth()
- setMaxWidth
  
  protected void setMaxWidth(int maxWidth)
- getMinWidth
  
  public int getMinWidth()
- setMinWidth
  
  protected void setMinWidth(int minWidth)
- styleText
  
  public void styleText(LayoutContext c)
- styleText
  
  public void styleText(LayoutContext c, CalculatedStyle style)
- calcChildPaintingInfo
  
  protected void calcChildPaintingInfo(CssContext c, PaintingInfo result, boolean useCache)
  
  Overrides:
  
  calcChildPaintingInfo in class Box
- getFirstLetterStyle
  
  public CascadedStyle getFirstLetterStyle()
- setFirstLetterStyle
  
  public void setFirstLetterStyle(CascadedStyle firstLetterStyle)
- getFirstLineStyle
  
  public CascadedStyle getFirstLineStyle()
- setFirstLineStyle
  
  public void setFirstLineStyle(CascadedStyle firstLineStyle)
- isMinMaxCalculated
  
  protected boolean isMinMaxCalculated()
- setMinMaxCalculated
  
  protected void setMinMaxCalculated(boolean minMaxCalculated)
- setDimensionsCalculated
  
  protected void setDimensionsCalculated(boolean dimensionsCalculated)
- setNeedShrinkToFitCalculatation
  
  protected void setNeedShrinkToFitCalculatation(boolean needShrinkToFitCalculatation)
- initStaticPos
  
  public void initStaticPos(LayoutContext c, BlockBox parent, int childOffset)
- calcBaseline
  
  public int calcBaseline(LayoutContext c)
- calcInitialBreakAtLine
  
  protected int calcInitialBreakAtLine(LayoutContext c)
- isCurrentBreakAtLineContext
  
  public boolean isCurrentBreakAtLineContext(LayoutContext c)
- calcBreakAtLineContext
  
  public BreakAtLineContext calcBreakAtLineContext(LayoutContext c)
- calcInlineBaseline
  
  public int calcInlineBaseline(CssContext c)
- findOffset
  
  public int findOffset(Box box)
- findLastNthLineBox
  
  public LineBox findLastNthLineBox(int count)
- isNeedsKeepWithInline
  
  public boolean isNeedsKeepWithInline(LayoutContext c)
- isFloated
  
  public boolean isFloated()
- getFloatedBoxData
  
  public FloatedBoxData getFloatedBoxData()
- setFloatedBoxData
  
  public void setFloatedBoxData(FloatedBoxData floatedBoxData)
- getChildrenHeight
  
  public int getChildrenHeight()
- setChildrenHeight
  
  protected void setChildrenHeight(int childrenHeight)
- isFromCaptionedTable
  
  public boolean isFromCaptionedTable()
- setFromCaptionedTable
  
  public void setFromCaptionedTable(boolean fromTable)
- isInlineBlock
  
  protected boolean isInlineBlock()
  
  Overrides:
  
  isInlineBlock in class Box
- isInMainFlow
  
  public boolean isInMainFlow()
- getDocumentParent
  
  public Box getDocumentParent()
  
  Overrides:
  
  getDocumentParent in class Box
- isContainsInlineContent
  
  public boolean isContainsInlineContent(LayoutContext c)
- checkPageContext
  
  public boolean checkPageContext(LayoutContext c)
- isNeedsClipOnPaint
  
  public boolean isNeedsClipOnPaint(CssContext c)
- propagateExtraSpace
  
  protected void propagateExtraSpace(LayoutContext c, ContentLimitContainer parentContainer, ContentLimitContainer currentContainer, int extraTop, int extraBottom)

Class BlockBox

Nested Class Summary

Nested classes/interfaces inherited from class com.openhtmltopdf.render.Box

Field Summary

Fields inherited from class com.openhtmltopdf.render.Box

Constructor Summary

Method Summary

Methods inherited from class com.openhtmltopdf.render.Box

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details