com.openhtmltopdf.render

Class MarginBox

java.lang.Object

com.openhtmltopdf.render.Box

com.openhtmltopdf.render.BlockBox

com.openhtmltopdf.render.MarginBox

All Implemented Interfaces:

Styleable, DisplayListItem

public class MarginBox
extends BlockBox

A dummy box representing one side of the margin area of a page.

Nested Class Summary

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

BlockBox.ContentType, BlockBox.MarginCollapseResult

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

Box.ChildIteratorOfType<T>

Field Summary

Fields inherited from class com.openhtmltopdf.render.BlockBox

NO_BASELINE, POSITION_BOTH, POSITION_HORIZONTALLY, POSITION_VERTICALLY

Fields inherited from class com.openhtmltopdf.render.Box

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

Constructor Summary

Constructors

Constructor and Description
MarginBox(Rectangle bounds)

Method Summary

Modifier and Type	Method and Description
BlockBox	copyOf()
protected int	getContainingBlockWidth()
Rectangle	getContentAreaEdge(int left, int top, CssContext cssCtx)
int	getContentWidth()
int	getHeight() Uh oh! This refers to content height during layout but total height after layout!
Rectangle	getPaddingEdge(int left, int top, CssContext cssCtx)
protected int	getPaddingWidth(CssContext cssCtx)
int	getWidth()

Methods inherited from class com.openhtmltopdf.render.BlockBox

addBoxID, appendPositioningInfo, calcBaseline, calcBreakAtLineContext, calcCanvasLocation, calcChildLocations, calcChildPaintingInfo, calcDimensions, calcDimensions, calcInitialBreakAtLine, calcInitialFloatedCanvasLocation, calcInlineBaseline, calcLayoutHeight, calcMinMaxWidth, checkPageContext, checkPopBfc, checkPushBfc, checkPushLayer, collapseMargins, collectLayoutText, createMarkerData, dump, ensureChildren, findLastNthLineBox, findOffset, getAvailableWidth, getChildrenContentType, getChildrenHeight, getCSSFitToWidth, getCSSHeight, getCSSWidth, getCSSWidth, getDocumentParent, getExtraBoxDescription, getFirstLetterStyle, getFirstLineStyle, getFloatedBoxData, getInlineContent, getLineBox, getListCounter, getMarkerData, getMaxWidth, getMinWidth, getNextCollapsableSibling, getPageClearance, getPaintingClipEdge, getPersistentBFC, getReplacedElement, getStaticEquivalent, initStaticPos, isAllowHeightToShrink, isAutoHeight, isBottomMarginCalculated, isContainsInlineContent, isCurrentBreakAtLineContext, isFixedWidthAdvisoryOnly, isFloated, isFromCaptionedTable, isInline, isInlineBlock, isInMainFlow, isListItem, isMayCollapseMarginsWithChildren, isMinMaxCalculated, isNeedPageClear, isNeedsClipOnPaint, isNeedsKeepWithInline, isPageBreakNeededBecauseOfMinHeight, isReplaced, isSkipWhenCollapsingMargins, isTopMarginCalculated, layout, layout, layoutChildren, layoutInlineChildren, paintDebugOutline, paintListMarker, positionAbsolute, positionAbsoluteOnPage, propagateExtraSpace, reset, resolveAutoMargins, setBottomMarginCalculated, setChildrenContentType, setChildrenHeight, setDimensionsCalculated, setElement, setFirstLetterStyle, setFirstLineStyle, setFloatedBoxData, setFromCaptionedTable, setInlineContent, setListCounter, setMarkerData, setMaxWidth, setMinMaxCalculated, setMinWidth, setNeedPageClear, setNeedShrinkToFitCalculation, setPersistentBFC, setReplacedElement, setStaticEquivalent, setTopMarginCalculated, shouldBeReplaced, styleText, styleText, 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, forcePageBreakBefore, getAbsoluteClipBox, getAbsX, getAbsY, getAccessibilityObject, getBorder, getBorderBox, getBorderBoxHeight, getBorderBoxWidth, getBorderEdge, getBorderSides, getBoxDimensions, getChild, getChildCount, getChildIterator, getChildIteratorOfType, getChildren, getChildrenClipEdge, getClipBox, getContainingBlock, getContainingLayer, getEffBackgroundColor, getEffectiveWidth, getElement, getElementBoxes, getIndex, getLayer, getLeftMBP, getMargin, getMarginBorderPadding, getMarginEdge, getMarginEdge, getNext, getNextSibling, getPadding, getPaintingBorderEdge, getPaintingInfo, getPaintingPaddingEdge, getParent, getParentClipBox, getPrevious, getPreviousSibling, getPseudoElementOrClass, getRelativeOffset, getRightMBP, getState, getStyle, getStyleMargin, getStyleMargin, getTx, getTy, getX, getY, hasNonTextContent, hasRootElementBackground, initContainingLayer, isAnonymous, isBody, isBody, isContainedInMarginBox, isFirstChild, isInDocumentFlow, isInitialContainingBlock, isMarginAreaRoot, isRoot, isStyled, isTerminalColumnBreak, moveIfGreater, paintBackground, paintBorder, paintRootElementBackground, positionRelative, removeAllChildren, removeChild, removeChild, resetChildren, resetChildren, resetTopMargin, 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

Constructor Detail

MarginBox

public MarginBox(Rectangle bounds)

Method Detail

getWidth

public int getWidth()

Overrides:

getWidth in class Box

getHeight

public int getHeight()

Description copied from class: Box

Uh oh! This refers to content height during layout but total height after layout!

Overrides:

getHeight in class Box

getContentWidth

public int getContentWidth()

Overrides:

getContentWidth in class Box

getContentAreaEdge

public Rectangle getContentAreaEdge(int left,
                                    int top,
                                    CssContext cssCtx)

Overrides:

getContentAreaEdge in class Box

getPaddingEdge

public Rectangle getPaddingEdge(int left,
                                int top,
                                CssContext cssCtx)

Overrides:

getPaddingEdge in class Box

getContainingBlockWidth

protected int getContainingBlockWidth()

Overrides:

getContainingBlockWidth in class Box

getPaddingWidth

protected int getPaddingWidth(CssContext cssCtx)

Overrides:

getPaddingWidth in class Box

copyOf

public BlockBox copyOf()

Overrides:

copyOf in class BlockBox