Top Description Inners Fields Constructors Methods
com.openhtmltopdf.render

public Class BlockBox

extends Box
implements InlinePaintable
Class Inheritance
All Implemented Interfaces
com.openhtmltopdf.layout.InlinePaintable
Known Direct Subclasses
com.openhtmltopdf.render.FlowingColumnBox, com.openhtmltopdf.render.FlowingColumnContainerBox, com.openhtmltopdf.render.MarginBox, com.openhtmltopdf.render.ViewportBox, com.openhtmltopdf.newtable.TableBox, com.openhtmltopdf.newtable.TableCellBox, com.openhtmltopdf.newtable.TableRowBox, com.openhtmltopdf.newtable.TableSectionBox, com.openhtmltopdf.render.AnonymousBlockBox
Imports
java.awt.Point, .Rectangle, java.util.Iterator, .LinkedList, .List, org.w3c.dom.Element, com.openhtmltopdf.css.constants.CSSName, .IdentValue, com.openhtmltopdf.css.newmatch.CascadedStyle, com.openhtmltopdf.css.parser.FSRGBColor, com.openhtmltopdf.css.style.CalculatedStyle, .CssContext, .FSDerivedValue, com.openhtmltopdf.css.style.derived.BorderPropertySet, .LengthValue, .RectPropertySet, com.openhtmltopdf.extend.FSImage, .ReplacedElement, com.openhtmltopdf.layout.BlockBoxing, .BlockFormattingContext, .BoxBuilder, .BreakAtLineContext, .CounterFunction, .FloatManager, .InlineBoxing, .InlinePaintable, .LayoutContext, .PaintingInfo, .PersistentBFC, .Styleable, com.openhtmltopdf.newtable.TableRowBox, com.openhtmltopdf.util.ThreadCtx
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). See ContentType

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
BlockBox.ContentType

What type of direct child content this block box contains.

private static class
BlockBox.LastLineBoxContext

public static class
BlockBox.MarginCollapseResult

Field Summary

Modifier and TypeField and Description
private boolean
_bottomMarginCalculated

private BlockBox.ContentType
_childrenContentType

private int
_childrenHeight

private boolean
_dimensionsCalculated

private CascadedStyle
_firstLetterStyle

private CascadedStyle
_firstLineStyle

private FloatedBoxData
_floatedBoxData

private boolean
_fromCaptionedTable

private List<Styleable>
_inlineContent

private boolean
_isReplaced

private int
_listCounter

private MarkerData
_markerData

private int
_maxWidth

private boolean
_minMaxCalculated

private int
_minWidth

private boolean
_needPageClear

private boolean
_needShrinkToFitCalculatation

private BlockBox.MarginCollapseResult
_pendingCollapseCalculation

private PersistentBFC
_persistentBFC

private ReplacedElement
_replacedElement

private Box
_staticEquivalent

private boolean
_topMarginCalculated

protected static final int
NO_BASELINE

public static final int
POSITION_BOTH

public static final int
POSITION_HORIZONTALLY

public static final int
POSITION_VERTICALLY

Inherited from com.openhtmltopdf.render.Box:
CHILDREN_FLUXDONEDUMP_LAYOUTDUMP_RENDERFLUXLINE_SEPARATORNOTHING

Constructor Summary

AccessConstructor and Description
public
BlockBox()

Method Summary

Modifier and TypeMethod and Description
protected void
addBoxID(LayoutContext c)

private void
alignToStaticEquivalent()

protected void
appendPositioningInfo(StringBuilder result)

private void
applyCSSMinMaxHeight(CssContext c)

private void
applyCSSMinMaxWidth(CssContext c)

public int
calcBaseline(LayoutContext c)

public BreakAtLineContext
calcBreakAtLineContext(LayoutContext c)

public void
calcCanvasLocation()

Implements abstract com.openhtmltopdf.render.Box.calcCanvasLocation.

public void
calcChildLocations()

Overrides com.openhtmltopdf.render.Box.calcChildLocations.

protected void
calcChildPaintingInfo(final CssContext c, final PaintingInfo result, final boolean useCache)

Overrides com.openhtmltopdf.render.Box.calcChildPaintingInfo.

private void
calcClearance(LayoutContext c)

public void
calcDimensions(LayoutContext c)

protected void
calcDimensions(LayoutContext c, int cssWidth)

private int
calcEffPageRelativeWidth(LayoutContext c)

private void
calcExtraPageClearance(LayoutContext c)

protected int
calcInitialBreakAtLine(LayoutContext c)

public void
calcInitialFloatedCanvasLocation(LayoutContext c)

public int
calcInlineBaseline(CssContext c)

protected void
calcLayoutHeight(LayoutContext c, BorderPropertySet border, RectPropertySet margin, RectPropertySet padding)

Oh oh!

private void
calcMinMaxCSSMinMaxWidth(LayoutContext c, RectPropertySet margin, BorderPropertySet border, RectPropertySet padding)

public void
calcMinMaxWidth(LayoutContext c)

private void
calcMinMaxWidthBlockChildren(LayoutContext c)

private void
calcMinMaxWidthInlineChildren(LayoutContext c)

private int
calcPinnedContentWidth(CssContext c)

private int
calcPinnedHeight(CssContext c)

private int
calcShrinkToFitWidth(LayoutContext c)

private void
calcShrinkToFitWidthIfNeeded(LayoutContext c)

public boolean
checkPageContext(LayoutContext c)

protected void
checkPopBfc(LayoutContext c)

Checks if this box established a block formatting context and if so removes the last bfc from the stack.

protected void
checkPushBfc(LayoutContext c)

Checks if this box establishes a block formatting context and if so creates one and pushes it to the stack of bfcs.

protected boolean
checkPushLayer(LayoutContext c, CalculatedStyle style)

private void
collapseBottomMargin(LayoutContext c, boolean calculationRoot, BlockBox.MarginCollapseResult result)

private void
collapseEmptySubtreeMargins(LayoutContext c, BlockBox.MarginCollapseResult result)

protected void
collapseMargins(LayoutContext c)

private void
collapseTopMargin(LayoutContext c, boolean calculationRoot, BlockBox.MarginCollapseResult result)

public BlockBox
copyOf()

public void
createMarkerData(LayoutContext c)

private void
createReplaced(LayoutContext c)

Creates the replaced element as required.

public String
dump(LayoutContext c, String indent, int which)

Implements abstract com.openhtmltopdf.render.Box.dump.

public void
ensureChildren(LayoutContext c)

private LineBox
findFirstLineBox()

private void
findLastLineBox(BlockBox.LastLineBoxContext context)

private LineBox
findLastLineBox()

public LineBox
findLastNthLineBox(int count)

public int
findOffset(Box box)

protected int
getAvailableWidth(LayoutContext c)

public BlockBox.ContentType
getChildrenContentType()

See ContentType

public int
getChildrenHeight()

private int
getContainingBlockCSSHeight(CssContext c)

protected int
getCSSFitToWidth(CssContext c)

protected int
getCSSHeight(CssContext c)

private int
getCSSMaxHeight(CssContext c)

private int
getCSSMaxWidth(CssContext c)

private int
getCSSMinHeight(CssContext c)

private int
getCSSMinWidth(CssContext c)

protected int
getCSSWidth(CssContext c)

protected int
getCSSWidth(CssContext c, boolean shrinkingToFit)

public Box
getDocumentParent()

Overrides com.openhtmltopdf.render.Box.getDocumentParent.

protected String
getExtraBoxDescription()

public CascadedStyle
getFirstLetterStyle()

public CascadedStyle
getFirstLineStyle()

public FloatedBoxData
getFloatedBoxData()

public List<Styleable>
getInlineContent()

See setInlineContent(List)

public LineBox
getLineBox()

public int
getListCounter()

public MarkerData
getMarkerData()

public int
getMaxWidth()

public int
getMinWidth()

protected BlockBox
getNextCollapsableSibling(BlockBox.MarginCollapseResult collapsedMargin)

protected int
getPageClearance()

public Rectangle
getPaintingClipEdge(CssContext cssCtx)

Overrides com.openhtmltopdf.render.Box.getPaintingClipEdge.

public PersistentBFC
getPersistentBFC()

public ReplacedElement
getReplacedElement()

public Box
getStaticEquivalent()

public void
initStaticPos(LayoutContext c, BlockBox parent, int childOffset)

protected boolean
isAllowHeightToShrink()

public boolean
isAutoHeight()

public boolean
isBottomMarginCalculated()

public boolean
isContainsInlineContent(LayoutContext c)

public boolean
isCurrentBreakAtLineContext(LayoutContext c)

private boolean
isDimensionsCalculated()

protected boolean
isFixedWidthAdvisoryOnly()

public boolean
isFloated()

public boolean
isFromCaptionedTable()

public boolean
isInline()

protected boolean
isInlineBlock()

Overrides com.openhtmltopdf.render.Box.isInlineBlock.

public boolean
isInMainFlow()

public boolean
isListItem()

protected boolean
isMayCollapseMarginsWithChildren()

protected boolean
isMinMaxCalculated()

public boolean
isNeedPageClear()

public boolean
isNeedsClipOnPaint(CssContext c)

private boolean
isNeedShrinkToFitCalculatation()

public boolean
isNeedsKeepWithInline(LayoutContext c)

private boolean
isNoBottomPaddingOrBorder(LayoutContext c)

private boolean
isNoTopPaddingOrBorder(LayoutContext c)

public boolean

Returns:

true if a pagebreak is needed before this block because there is not enough space left on the current page.
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.

public boolean
isReplaced()

protected boolean
isSkipWhenCollapsingMargins()

public boolean
isTopMarginCalculated()

private boolean
isVerticalMarginsAdjoin(LayoutContext c)

private void
justifyText(LayoutContext c)

public void
layout(LayoutContext c)

public void
layout(LayoutContext c, int contentStart)

protected void
layoutChildren(LayoutContext c, int contentStart)

protected void
layoutInlineChildren(LayoutContext c, int contentStart, int breakAtLine, boolean tryAgain)

private MarkerData.GlyphMarker
makeGlyphMarker(StrutMetrics strutMetrics)

private MarkerData.ImageMarker
makeImageMarker(LayoutContext c, StrutMetrics structMetrics, String image)

private MarkerData.TextMarker
makeTextMarker(LayoutContext c, IdentValue listStyle)

public void
paintDebugOutline(RenderingContext c)

public void
paintInline(RenderingContext c)

Implements com.openhtmltopdf.layout.InlinePaintable.paintInline.

public void
paintListMarker(RenderingContext c)

public void
positionAbsolute(CssContext cssCtx, int direction)

public void
positionAbsoluteOnPage(LayoutContext c)

protected void
propagateExtraSpace(LayoutContext c, ContentLimitContainer parentContainer, ContentLimitContainer currentContainer, int extraTop, int extraBottom)

private void
recalcMargin(LayoutContext c)

public void
reset(LayoutContext c)

Overrides com.openhtmltopdf.render.Box.reset.

Responsible for resetting the state of the box before a repeat call to BlockBox#layout(LayoutContext) or other layout methods.

protected void
resolveAutoMargins(LayoutContext c, int cssWidth, RectPropertySet padding, BorderPropertySet border)

private void
satisfyWidowsAndOrphans(LayoutContext c, int contentStart, boolean tryAgain)

TERMINOLOGY: Orphans refers to the number of lines of content in this box before the first page break.

public void
setBottomMarginCalculated(boolean bottomMarginCalculated)

public void
setChildrenContentType(BlockBox.ContentType contentType)

See ContentType

protected void
setChildrenHeight(int childrenHeight)

private void
setCollapsedBottomMargin(LayoutContext c, RectPropertySet margin, BlockBox.MarginCollapseResult collapsedMargin)

protected void
setDimensionsCalculated(boolean dimensionsCalculated)

public void
setElement(Element element)

Overrides com.openhtmltopdf.render.Box.setElement.

Implements com.openhtmltopdf.layout.Styleable.setElement.

public void
setFirstLetterStyle(CascadedStyle firstLetterStyle)

public void
setFirstLineStyle(CascadedStyle firstLineStyle)

public void
setFloatedBoxData(FloatedBoxData floatedBoxData)

public void
setFromCaptionedTable(boolean fromTable)

public void
setInlineContent(List<Styleable> inlineContent)

Inline content is created by the box builder.

public void
setListCounter(int listCounter)

public void
setMarkerData(MarkerData markerData)

protected void
setMaxWidth(int maxWidth)

protected void
setMinMaxCalculated(boolean minMaxCalculated)

protected void
setMinWidth(int minWidth)

public void
setNeedPageClear(boolean needPageClear)

protected void
setNeedShrinkToFitCalculatation(boolean needShrinkToFitCalculatation)

public void
setPersistentBFC(PersistentBFC persistentBFC)

public void
setReplacedElement(ReplacedElement replacedElement)

public void
setStaticEquivalent(Box staticEquivalent)

public void
setTopMarginCalculated(boolean topMarginCalculated)

public boolean
shouldBeReplaced()

private void
sizeReplacedElement(LayoutContext c, ReplacedElement re)

Size a replaced element taking into account size properties including min/max, border-box/content-box and the natural size/aspect ratio of the replaced object.

public void
styleText(LayoutContext c)

public void
styleText(LayoutContext c, CalculatedStyle style)

public String
toString()

Overrides com.openhtmltopdf.render.Box.toString.

Returns a string representation of the object.

Inherited from com.openhtmltopdf.render.Box:
addAllChildrenaddChildaddChildForLayoutanalyzePageBreaksancestorsancestorsWhilecalcPaintingInfocollectTextconnectChildrenToCurrentLayercrossesPageBreakdetachdumpBoxesexportPageBoxTextexportTextfindfindAncestorfindColumnBreakOpportunitiesforcePageBreakAfterforcePageBreakBeforeforcePageBreakBeforegetAbsoluteClipBoxgetAbsXgetAbsYgetAccessibilityObjectgetBordergetBorderBoxgetBorderBoxHeightgetBorderBoxWidthgetBorderEdgegetBorderSidesgetBoxDimensionsgetChildgetChildCountgetChildIteratorgetChildIteratorOfTypegetChildrengetChildrenClipEdgegetClipBoxgetContainingBlockgetContainingBlockWidthgetContainingLayergetContentAreaEdgegetContentWidthgetEffBackgroundColorgetEffectiveWidthgetElementgetElementBoxesgetHeightgetIndexgetLayergetLeftMBPgetMargingetMarginBorderPaddinggetMarginEdgegetMarginEdgegetNextgetNextSiblinggetPaddinggetPaddingEdgegetPaddingWidthgetPaintingBorderEdgegetPaintingInfogetPaintingPaddingEdgegetParentgetParentClipBoxgetPreviousgetPreviousSiblinggetPseudoElementOrClassgetRelativeOffsetgetRightMBPgetStategetStylegetStyleMargingetStyleMargingetTxgetTygetWidthgetXgetYhasNonTextContenthasRootElementBackgroundinitContainingLayerintersectsisAnonymousisBodyisContainedInMarginBoxisFirstChildisInDocumentFlowisInitialContainingBlockisMarginAreaRootisRootisStyledisTerminalColumnBreakmoveIfGreaterpaintBackgroundpaintBorderpaintRootElementBackgroundpositionRelativeremoveAllChildrenremoveChildremoveChildresetChildrenresetChildrenresetTopMarginrootBoxsetAbsXsetAbsYsetAccessiblityObjectsetAnonymoussetBorderBoxHeightsetBorderBoxWidthsetBoxDimensionssetContainingBlocksetContainingLayersetContentWidthsetHeightsetIndexsetLayersetLeftMBPsetMarginBottomsetMarginLeftsetMarginRightsetMarginTopsetParentsetPseudoElementOrClasssetRelativeOffsetsetRightMBPsetStatesetStylesetTxsetTysetXsetYstateToString