Openhtmltopdf 1.0.10 · com.openhtmltopdf.render.Box · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
public static class	Box.ChildIteratorOfType<T>

Modifier and Type	Field and Description
private Area	_absoluteClipBox
private int	_absX
private int	_absY
private Object	_accessibilityObject
private boolean	_anonymous
private List<Box>	_boxes
private boolean	_clipBoxCalculated
private Box	_containingBlock
private Layer	_containingLayer
private int	_contentWidth Box width.
private Element	_element
private int	_height Box height.
private int	_index
private Layer	_layer
private int	_leftMBP
private PaintingInfo	_paintingInfo
private Box	_parent
private String	_pseudoElementOrClass
private Dimension	_relativeOffset
private int	_rightMBP
private int	_state
private CalculatedStyle	_style
private int	_tx Keeps track of the start of childrens containing block.
private int	_ty
private RectPropertySet	_workingMargin
private int	_x
private int	_y
public static final int	CHILDREN_FLUX
public static final int	DONE
public static final int	DUMP_LAYOUT
public static final int	DUMP_RENDER
public static final int	FLUX
protected static final String	LINE_SEPARATOR
public static final int	NOTHING

Access	Constructor and Description
protected	Box()

Method Summary

Modifier and Type	Method and Description
public void	addAllChildren(List<Box> children)
public void	addChild(Box child)
public void	addChildForLayout(LayoutContext c, Box child)
public void	analyzePageBreaks(LayoutContext c, ContentLimitContainer container)
public List<Box>	ancestors() Get all ancestors, up until the root box.
public List<Box>	ancestorsWhile(Predicate<Box> predicate) Creates a list of ancestors by walking up the chain of parent, grandparent, etc. Stops when the provided predicate returns false or the root box otherwise.
private Area	calcAbsoluteClipBox(CssContext c)
public abstract void	calcCanvasLocation()
public void	calcChildLocations()
protected void	calcChildPaintingInfo(CssContext c, PaintingInfo result, boolean useCache)
private Rectangle	calcClipBox(RenderingContext c, Layer layer)
public PaintingInfo	calcPaintingInfo(CssContext c, boolean useCache)
public void	collectText(RenderingContext c, StringBuilder buffer)
public void	connectChildrenToCurrentLayer(LayoutContext c)
public boolean	crossesPageBreak(LayoutContext c) Whether this box would cross a page break.
public void	detach(LayoutContext c)
public abstract String	dump(LayoutContext c, String indent, int which)
protected void	dumpBoxes(LayoutContext c, String indent, List<Box> boxes, int which, StringBuilder result)
private void	ensureWorkingMargin(CssContext cssContext)
private void	exportPageBoxText(RenderingContext c, Writer writer)
protected void	exportPageBoxText(RenderingContext c, Writer writer, int yPos)
public void	exportText(RenderingContext c, Writer writer)
public Box	find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)
public Box	Returns: the box for which predicate returned true or null if none found. findAncestor(Predicate<Box> predicate) Walks up the ancestor tree to the root testing ancestors agains the predicate.
public void	findColumnBreakOpportunities(FlowingColumnContainerBox.ColumnBreakStore - use to report break opportunities. store) Recursive method to find column break opportunities.
public void	forcePageBreakAfter(LayoutContext c, IdentValue pageBreakValue) Forces a page break after this box.
public int	forcePageBreakBefore(LayoutContext c, IdentValue pageBreakValue, boolean pendingPageName)
public int	forcePageBreakBefore(LayoutContext c, IdentValue pageBreakValue, boolean pendingPageName, int absY)
public Area	getAbsoluteClipBox(CssContext c) Returns the absolute (ie transformed if needed) clip area for this box.
public int	getAbsX()
public int	getAbsY()
public Object	getAccessibilityObject()
public BorderPropertySet	getBorder(CssContext cssCtx)
public Rectangle	getBorderBox(CssContext c) Only to be called after layout, due to double use of getHeight().
public int	getBorderBoxHeight(CssContext c)
public int	getBorderBoxWidth(CssContext c)
public Rectangle	getBorderEdge(int left, int top, CssContext cssCtx)
public int	getBorderSides()
public BoxDimensions	getBoxDimensions()
public Box	getChild(int i)
public int	getChildCount()
public Iterator<Box>	getChildIterator()
public <T> Iterator<T>	getChildIteratorOfType(Class<T> type) Returns an iterator of boxes cast to type.
public List<Box>	getChildren()
public Rectangle	getChildrenClipEdge(CssContext c)
public Rectangle	getClipBox(RenderingContext c, Layer layer) Gets the combined clip of this box relative to the containing layer.
private Box	getClipParent()
public Box	getContainingBlock()
protected int	getContainingBlockWidth()
public Layer	getContainingLayer()
public Rectangle	getContentAreaEdge(int left, int top, CssContext cssCtx)
public int	getContentWidth()
public Box	getDocumentParent()
public FSColor	getEffBackgroundColor(RenderingContext c)
public int	getEffectiveWidth()
public Element	getElement() Implements com.openhtmltopdf.layout.Styleable.getElement.
public List<Box>	getElementBoxes(Element elem)
public int	getHeight() Uh oh!
protected int	getIndex() The zero based index of this child amongst its fellow children of its parent.
public Layer	getLayer()
public int	getLeftMBP()
public RectPropertySet	getMargin(CssContext cssContext)
public int	getMarginBorderPadding(CssContext cssCtx, int which)
public Rectangle	getMarginEdge(int left, int top, CssContext cssCtx, int tx, int ty)
public Rectangle	getMarginEdge(CssContext cssCtx, int tx, int ty)
protected Box	getNext(Box child)
public Box	getNextSibling()
public RectPropertySet	getPadding(CssContext cssCtx)
public Rectangle	getPaddingEdge(int left, int top, CssContext cssCtx)
protected int	getPaddingWidth(CssContext cssCtx)
public Rectangle	getPaintingBorderEdge(CssContext cssCtx)
public Rectangle	getPaintingClipEdge(CssContext cssCtx)
public PaintingInfo	getPaintingInfo()
public Rectangle	getPaintingPaddingEdge(CssContext cssCtx)
public Box	getParent()
public Rectangle	getParentClipBox(RenderingContext c, Layer layer) Gets the layer relative clip for the parent box.
protected Box	getPrevious(Box child)
public Box	getPreviousSibling()
public String	getPseudoElementOrClass() Implements com.openhtmltopdf.layout.Styleable.getPseudoElementOrClass.
public Dimension	getRelativeOffset()
public int	getRightMBP()
public synchronized int	getState()
public final CalculatedStyle	getStyle() Implements com.openhtmltopdf.layout.Styleable.getStyle.
protected RectPropertySet	getStyleMargin(CssContext cssContext)
protected RectPropertySet	getStyleMargin(CssContext cssContext, boolean useCache)
public int	getTx()
public int	getTy()
public int	getWidth()
public int	getX()
public int	getY()
public boolean	hasNonTextContent(CssContext c)
public boolean	hasRootElementBackground(RenderingContext c) If the html or body box have a background return true.
public void	initContainingLayer(LayoutContext c)
public boolean	intersects(CssContext cssCtx, Shape clip) Note This method does not consider any children of this box but does consider the transformation matrix of the containing layer.
public boolean	isAnonymous()
public boolean	isBody()
public boolean	isContainedInMarginBox()
public boolean	isFirstChild() Is this box the first child of its parent?
public boolean	isInDocumentFlow()
protected boolean	isInitialContainingBlock()
protected boolean	isInlineBlock()
protected boolean	isMarginAreaRoot()
private boolean	isPaintsRootElementBackground()
public boolean	isRoot()
public boolean	isStyled()
public boolean	isTerminalColumnBreak() Is this box unbreakable in regards to column break opportunities?
protected void	moveIfGreater(Dimension result, Dimension test)
public void	paintBackground(RenderingContext c)
public void	paintBorder(RenderingContext c)
public void	paintRootElementBackground(RenderingContext c)
private void	paintRootElementBackground(RenderingContext c, PaintingInfo pI)
public Dimension	positionRelative(CssContext cssCtx)
public void	removeAllChildren()
public boolean	removeChild(Box target) Removes a child box if it is indeed a child and adjusts the index of subsequent children.
public boolean	removeChild(int index) Removes child by index and adjusts the index of subsequent children.
public void	reset(LayoutContext c) Responsible for resetting the state of the box before a repeat call to `BlockBox#layout(LayoutContext)` or other layout methods.
public void	resetChildren(LayoutContext c, int start, int end)
protected void	resetChildren(LayoutContext c)
protected void	resetTopMargin(CssContext cssContext)
public Box	rootBox() Returns the highest ancestor box.
public void	setAbsX(int absX)
public void	setAbsY(int absY)
public void	setAccessiblityObject(Object object)
public void	setAnonymous(boolean anonymous)
protected void	setBorderBoxHeight(CssContext c, int h)
public void	setBorderBoxWidth(CssContext c, int borderBoxWidth)
public void	setBoxDimensions(BoxDimensions dimensions)
public void	setContainingBlock(Box containingBlock)
public void	setContainingLayer(Layer containingLayer)
public void	setContentWidth(int contentWidth)
public void	setElement(Element element) Implements com.openhtmltopdf.layout.Styleable.setElement.
public void	setHeight(int height) Uh oh!
protected void	setIndex(int index) See `getIndex()` Must make sure this is correct when removing children/rearranging children.
public void	setLayer(Layer layer)
public void	setLeftMBP(int leftMBP)
public void	setMarginBottom(CssContext cssContext, int marginBottom)
public void	setMarginLeft(CssContext cssContext, int marginLeft)
public void	setMarginRight(CssContext cssContext, int marginRight)
public void	setMarginTop(CssContext cssContext, int marginTop)
private void	setPaintingInfo(PaintingInfo paintingInfo)
public void	setParent(Box box)
public void	setPseudoElementOrClass(String pseudoElementOrClass)
public void	setRelativeOffset(Dimension relativeOffset)
public void	setRightMBP(int rightMBP)
public synchronized void	setState(int state)
public void	setStyle(CalculatedStyle style) Implements com.openhtmltopdf.layout.Styleable.setStyle.
public void	setTx(int tx)
public void	setTy(int ty)
public void	setX(int x)
public void	setY(int y)
public static String	stateToString(int state)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

public abstract Class Box

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary