java.lang.Object
- com.openhtmltopdf.render.Box

All Implemented Interfaces:

Styleable, DisplayListItem

Direct Known Subclasses:

BlockBox, InlineLayoutBox, LineBox
```
public abstract class Box
extends java.lang.Object
implements Styleable, DisplayListItem
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Box.ChildIteratorOfType<T>

Field Summary

Fields
Modifier and Type	Field	Description
`private java.awt.geom.Area`	`_absoluteClipBox`
`private int`	`_absX`
`private int`	`_absY`
`private java.lang.Object`	`_accessibilityObject`
`private boolean`	`_anonymous`
`private java.util.List<Box>`	`_boxes`
`private boolean`	`_clipBoxCalculated`
`private Box`	`_containingBlock`
`private Layer`	`_containingLayer`
`private int`	`_contentWidth`	Box width.
`private org.w3c.dom.Element`	`_element`
`private int`	`_height`	Box height.
`private int`	`_index`
`private Layer`	`_layer`
`private int`	`_leftMBP`
`private PaintingInfo`	`_paintingInfo`
`private Box`	`_parent`
`private java.lang.String`	`_pseudoElementOrClass`
`private java.awt.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`
`static int`	`CHILDREN_FLUX`
`static int`	`DONE`
`static int`	`DUMP_LAYOUT`
`static int`	`DUMP_RENDER`
`static int`	`FLUX`
`protected static java.lang.String`	`LINE_SEPARATOR`
`static int`	`NOTHING`

Constructor Summary

Constructors
Modifier Constructor Description

protected Box()

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LINE_SEPARATOR

protected static final java.lang.String LINE_SEPARATOR

_element
```
private org.w3c.dom.Element _element
```

_x
```
private int _x
```

_y
```
private int _y
```

_absY
```
private int _absY
```

_absX
```
private int _absX
```

_contentWidth
```
private int _contentWidth
```
Box width.

_rightMBP
```
private int _rightMBP
```

_leftMBP
```
private int _leftMBP
```

_height
```
private int _height
```
Box height.

_layer
```
private Layer _layer
```

_containingLayer
```
private Layer _containingLayer
```

_parent
```
private Box _parent
```

_boxes
```
private java.util.List<Box> _boxes
```

_tx
```
private int _tx
```
Keeps track of the start of childrens containing block.

_ty
```
private int _ty
```

_style
```
private CalculatedStyle _style
```

_containingBlock
```
private Box _containingBlock
```

_relativeOffset

private java.awt.Dimension _relativeOffset

_paintingInfo
```
private PaintingInfo _paintingInfo
```

_workingMargin
```
private RectPropertySet _workingMargin
```

_index
```
private int _index
```

_pseudoElementOrClass

private java.lang.String _pseudoElementOrClass

_anonymous
```
private boolean _anonymous
```

_absoluteClipBox

private java.awt.geom.Area _absoluteClipBox

_clipBoxCalculated
```
private boolean _clipBoxCalculated
```

_accessibilityObject

private java.lang.Object _accessibilityObject

NOTHING
```
public static final int NOTHING
```
See Also:

Constant Field Values

FLUX
```
public static final int FLUX
```
See Also:

Constant Field Values

CHILDREN_FLUX
```
public static final int CHILDREN_FLUX
```
See Also:

Constant Field Values

DONE
```
public static final int DONE
```
See Also:

Constant Field Values

_state
```
private int _state
```

DUMP_RENDER
```
public static final int DUMP_RENDER
```
See Also:

Constant Field Values

DUMP_LAYOUT
```
public static final int DUMP_LAYOUT
```
See Also:

Constant Field Values

Constructor Detail
- Box
```
protected Box()
```

Method Detail

getClipBox
```
public java.awt.Rectangle getClipBox(RenderingContext c,
                                     Layer layer)
```
Gets the combined clip of this box relative to the containing layer. The returned clip is in document coordinate space (not transformed in any way). For example, if we have the following nesting: overflow hidden := transformed box := overflow hidden := overflow hidden := overflow visible this function called on the overflow visible box will return the combined clip of its two immediate ancestors in document coordinate space. It stops at the transformed box because the transform triggers a layer. Currently this method is used for getting the clip to apply to a float, which are nested in layers but taken out of the default block list and therefore clip stack. Since it is only used for floats, the result is not cached. Revisit this decision if using for every box. There are several other clip methods available: + getChildrenClipEdge(CssContext) - gets the local clip for a single box. + getParentClipBox(RenderingContext, Layer) - gets the layer relative clip for the parent box. + getAbsoluteClipBox(CssContext) - gets the absolute clip box in document coordinates

getClipParent
```
private Box getClipParent()
```

getParentClipBox

public java.awt.Rectangle getParentClipBox(RenderingContext c,
                                           Layer layer)

Gets the layer relative clip for the parent box. See getClipBox(RenderingContext, Layer)

calcClipBox

private java.awt.Rectangle calcClipBox(RenderingContext c,
                                       Layer layer)

getAbsoluteClipBox
```
public java.awt.geom.Area getAbsoluteClipBox(CssContext c)
```
Returns the absolute (ie transformed if needed) clip area for this box. Cached as this will be needed on every box to check if the clip area is inside a page.

calcAbsoluteClipBox

private java.awt.geom.Area calcAbsoluteClipBox(CssContext c)

dump

public abstract java.lang.String dump(LayoutContext c,
                                      java.lang.String indent,
                                      int which)

dumpBoxes

protected void dumpBoxes(LayoutContext c,
                         java.lang.String indent,
                         java.util.List<Box> boxes,
                         int which,
                         java.lang.StringBuilder result)

getWidth
```
public int getWidth()
```

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

addChildForLayout

public void addChildForLayout(LayoutContext c,
                              Box child)

addChild
```
public void addChild(Box child)
```

addAllChildren

public void addAllChildren(java.util.List<Box> children)

removeAllChildren
```
public void removeAllChildren()
```

removeChild
```
public boolean removeChild(Box target)
```
Removes a child box if it is indeed a child and adjusts the index of subsequent children. Returns whether this was a child.

getPreviousSibling
```
public Box getPreviousSibling()
```

getNextSibling
```
public Box getNextSibling()
```

getPrevious

protected Box getPrevious(Box child)

getNext
```
protected Box getNext(Box child)
```

removeChild
```
public boolean removeChild(int index)
```
Removes child by index and adjusts the index of subsequent children. Returns true if this box has children, throws if the index is out-of-bounds.

IMPORTANT: This method must be kept in sync with removeChild(Box)

setParent
```
public void setParent(Box box)
```

getParent
```
public Box getParent()
```

getDocumentParent
```
public Box getDocumentParent()
```

getChildCount
```
public int getChildCount()
```

getChild
```
public Box getChild(int i)
```

getChildIterator

public java.util.Iterator<Box> getChildIterator()

getChildren

public java.util.List<Box> getChildren()

getChildIteratorOfType
```
public <T> java.util.Iterator<T> getChildIteratorOfType(java.lang.Class<T> type)
```
Returns an iterator of boxes cast to type. If a box is not of type, an error will be logged and null will be returned for that box. Therefore, this method should only be used when it is certain all children are of a particular type. Eg: TableBox has children only of type TableSectionBox.

getState
```
public int getState()
```

setState
```
public void setState(int state)
```

stateToString

public static java.lang.String stateToString(int state)

getStyle
```
public final CalculatedStyle getStyle()
```
Specified by:

getStyle in interface Styleable

setStyle

public void setStyle(CalculatedStyle style)

Specified by:: setStyle in interface Styleable

getContainingBlock
```
public Box getContainingBlock()
```

setContainingBlock

public void setContainingBlock(Box containingBlock)

getMarginEdge

public java.awt.Rectangle getMarginEdge(int left,
                                        int top,
                                        CssContext cssCtx,
                                        int tx,
                                        int ty)

getMarginEdge

public java.awt.Rectangle getMarginEdge(CssContext cssCtx,
                                        int tx,
                                        int ty)

getPaintingBorderEdge

public java.awt.Rectangle getPaintingBorderEdge(CssContext cssCtx)

getPaintingPaddingEdge

public java.awt.Rectangle getPaintingPaddingEdge(CssContext cssCtx)

getPaintingClipEdge

public java.awt.Rectangle getPaintingClipEdge(CssContext cssCtx)

getChildrenClipEdge

public java.awt.Rectangle getChildrenClipEdge(CssContext c)

intersects
```
public boolean intersects(CssContext cssCtx,
                          java.awt.Shape clip)
```
NOTE: This method does not consider any children of this box but does consider the transformation matrix of the containing layer.

getBorderEdge

public java.awt.Rectangle getBorderEdge(int left,
                                        int top,
                                        CssContext cssCtx)

getPaddingEdge

public java.awt.Rectangle getPaddingEdge(int left,
                                         int top,
                                         CssContext cssCtx)

getPaddingWidth

protected int getPaddingWidth(CssContext cssCtx)

getContentAreaEdge

public java.awt.Rectangle getContentAreaEdge(int left,
                                             int top,
                                             CssContext cssCtx)

getLayer
```
public Layer getLayer()
```

setLayer
```
public void setLayer(Layer layer)
```

positionRelative

public java.awt.Dimension positionRelative(CssContext cssCtx)

isInlineBlock
```
protected boolean isInlineBlock()
```

setAbsY
```
public void setAbsY(int absY)
```

getAbsY
```
public int getAbsY()
```

setAbsX
```
public void setAbsX(int absX)
```

getAbsX
```
public int getAbsX()
```

isStyled
```
public boolean isStyled()
```

getBorderSides
```
public int getBorderSides()
```

paintBorder

public void paintBorder(RenderingContext c)

isPaintsRootElementBackground

private boolean isPaintsRootElementBackground()

paintBackground

public void paintBackground(RenderingContext c)

hasNonTextContent

public boolean hasNonTextContent(CssContext c)

setAccessiblityObject

public void setAccessiblityObject(java.lang.Object object)

getAccessibilityObject

public java.lang.Object getAccessibilityObject()

paintRootElementBackground

public void paintRootElementBackground(RenderingContext c)

paintRootElementBackground

private void paintRootElementBackground(RenderingContext c,
                                        PaintingInfo pI)

hasRootElementBackground
```
public boolean hasRootElementBackground(RenderingContext c)
```
If the html or body box have a background return true.

getContainingLayer
```
public Layer getContainingLayer()
```

setContainingLayer

public void setContainingLayer(Layer containingLayer)

initContainingLayer

public void initContainingLayer(LayoutContext c)

connectChildrenToCurrentLayer

public void connectChildrenToCurrentLayer(LayoutContext c)

getElementBoxes

public java.util.List<Box> getElementBoxes(org.w3c.dom.Element elem)

reset
```
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.

Any layout operation that is not idempotent MUST be reset in this method. Layout may be called several times on the one box.

detach

public void detach(LayoutContext c)

resetChildren

public void resetChildren(LayoutContext c,
                          int start,
                          int end)

resetChildren

protected void resetChildren(LayoutContext c)

calcCanvasLocation

public abstract void calcCanvasLocation()

calcChildLocations
```
public void calcChildLocations()
```

forcePageBreakBefore

public int forcePageBreakBefore(LayoutContext c,
                                IdentValue pageBreakValue,
                                boolean pendingPageName)

forcePageBreakBefore

public int forcePageBreakBefore(LayoutContext c,
                                IdentValue pageBreakValue,
                                boolean pendingPageName,
                                int absY)

forcePageBreakAfter

public void forcePageBreakAfter(LayoutContext c,
                                IdentValue pageBreakValue)

Forces a page break after this box.

crossesPageBreak
```
public boolean crossesPageBreak(LayoutContext c)
```
Whether this box would cross a page break.

See Layer.crossesPageBreak(LayoutContext, int, int) for extra info.

getRelativeOffset

public java.awt.Dimension getRelativeOffset()

setRelativeOffset

public void setRelativeOffset(java.awt.Dimension relativeOffset)

find

public Box find(CssContext cssCtx,
                int absX,
                int absY,
                boolean findAnonymous)

isRoot
```
public boolean isRoot()
```

isBody
```
public boolean isBody()
```

getElement
```
public org.w3c.dom.Element getElement()
```
Specified by:

getElement in interface Styleable

setElement

public void setElement(org.w3c.dom.Element element)

Specified by:: setElement in interface Styleable

setMarginTop

public void setMarginTop(CssContext cssContext,
                         int marginTop)

setMarginBottom

public void setMarginBottom(CssContext cssContext,
                            int marginBottom)

setMarginLeft

public void setMarginLeft(CssContext cssContext,
                          int marginLeft)

setMarginRight

public void setMarginRight(CssContext cssContext,
                           int marginRight)

ensureWorkingMargin

private void ensureWorkingMargin(CssContext cssContext)

getMargin

public RectPropertySet getMargin(CssContext cssContext)

getStyleMargin

protected RectPropertySet getStyleMargin(CssContext cssContext)

getStyleMargin

protected RectPropertySet getStyleMargin(CssContext cssContext,
                                         boolean useCache)

getPadding

public RectPropertySet getPadding(CssContext cssCtx)

getBorder

public BorderPropertySet getBorder(CssContext cssCtx)

getContainingBlockWidth

protected int getContainingBlockWidth()

resetTopMargin

protected void resetTopMargin(CssContext cssContext)

calcPaintingInfo

public PaintingInfo calcPaintingInfo(CssContext c,
                                     boolean useCache)

calcChildPaintingInfo

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

getMarginBorderPadding

public int getMarginBorderPadding(CssContext cssCtx,
                                  int which)

moveIfGreater

protected void moveIfGreater(java.awt.Dimension result,
                             java.awt.Dimension test)

getIndex
```
protected int getIndex()
```
The zero based index of this child amongst its fellow children of its parent.

setIndex
```
protected void setIndex(int index)
```
See getIndex() Must make sure this is correct when removing children/rearranging children.

getPseudoElementOrClass
```
public java.lang.String getPseudoElementOrClass()
```
Specified by:

getPseudoElementOrClass in interface Styleable

setPseudoElementOrClass

public void setPseudoElementOrClass(java.lang.String pseudoElementOrClass)

setX
```
public void setX(int x)
```

getX
```
public int getX()
```

setY
```
public void setY(int y)
```

getY
```
public int getY()
```

setTy
```
public void setTy(int ty)
```

getTy
```
public int getTy()
```

setTx
```
public void setTx(int tx)
```

getTx
```
public int getTx()
```

setRightMBP

public void setRightMBP(int rightMBP)

getRightMBP
```
public int getRightMBP()
```

setLeftMBP

public void setLeftMBP(int leftMBP)

getLeftMBP
```
public int getLeftMBP()
```

setHeight
```
public void setHeight(int height)
```
Uh oh! This refers to content height during layout but total height after layout!

getHeight
```
public int getHeight()
```
Uh oh! This refers to content height during layout but total height after layout!

setBorderBoxHeight

protected void setBorderBoxHeight(CssContext c,
                                  int h)

getBorderBoxHeight

public int getBorderBoxHeight(CssContext c)

getBorderBox
```
public java.awt.Rectangle getBorderBox(CssContext c)
```
Only to be called after layout, due to double use of getHeight().

setContentWidth

public void setContentWidth(int contentWidth)

getContentWidth
```
public int getContentWidth()
```

getBorderBoxWidth

public int getBorderBoxWidth(CssContext c)

setBorderBoxWidth

public void setBorderBoxWidth(CssContext c,
                              int borderBoxWidth)

getPaintingInfo
```
public PaintingInfo getPaintingInfo()
```

setPaintingInfo

private void setPaintingInfo(PaintingInfo paintingInfo)

isAnonymous
```
public boolean isAnonymous()
```

setAnonymous

public void setAnonymous(boolean anonymous)

getBoxDimensions

public BoxDimensions getBoxDimensions()

setBoxDimensions

public void setBoxDimensions(BoxDimensions dimensions)

collectText

public void collectText(RenderingContext c,
                        java.lang.StringBuilder buffer)

exportText

public void exportText(RenderingContext c,
                       java.io.Writer writer)
                throws java.io.IOException

Throws:: java.io.IOException

exportPageBoxText

private void exportPageBoxText(RenderingContext c,
                               java.io.Writer writer)
                        throws java.io.IOException

Throws:: java.io.IOException

exportPageBoxText

protected void exportPageBoxText(RenderingContext c,
                                 java.io.Writer writer,
                                 int yPos)
                          throws java.io.IOException

Throws:: java.io.IOException

isInDocumentFlow
```
public boolean isInDocumentFlow()
```

analyzePageBreaks

public void analyzePageBreaks(LayoutContext c,
                              ContentLimitContainer container)

getEffBackgroundColor

public FSColor getEffBackgroundColor(RenderingContext c)

isMarginAreaRoot
```
protected boolean isMarginAreaRoot()
```

isContainedInMarginBox

public boolean isContainedInMarginBox()

getEffectiveWidth
```
public int getEffectiveWidth()
```

isInitialContainingBlock

protected boolean isInitialContainingBlock()

isFirstChild
```
public boolean isFirstChild()
```
Is this box the first child of its parent?

isTerminalColumnBreak
```
public boolean isTerminalColumnBreak()
```
Is this box unbreakable in regards to column break opportunities?

ancestorsWhile
```
public java.util.List<Box> ancestorsWhile(java.util.function.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.

ancestors
```
public java.util.List<Box> ancestors()
```
Get all ancestors, up until the root box.

findAncestor
```
public Box findAncestor(java.util.function.Predicate<Box> predicate)
```
Walks up the ancestor tree to the root testing ancestors agains the predicate. NOTE: Does not test against the current box (this).

Returns:

the box for which predicate returned true or null if none found.

rootBox
```
public Box rootBox()
```
Returns the highest ancestor box. May be current box (this).

findColumnBreakOpportunities
```
public void findColumnBreakOpportunities(FlowingColumnContainerBox.ColumnBreakStore store)
```
Recursive method to find column break opportunities.

Parameters:

store - - use to report break opportunities.

Class Box

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LINE_SEPARATOR

_element

_x

_y

_absY

_absX

_contentWidth

_rightMBP

_leftMBP

_height

_layer

_containingLayer

_parent

_boxes

_tx

_ty

_style

_containingBlock

_relativeOffset

_paintingInfo

_workingMargin

_index

_pseudoElementOrClass

_anonymous

_absoluteClipBox

_clipBoxCalculated

_accessibilityObject

NOTHING

FLUX

CHILDREN_FLUX

DONE

_state

DUMP_RENDER

DUMP_LAYOUT

Constructor Detail

Box

Method Detail

getClipBox

getClipParent

getParentClipBox

calcClipBox

getAbsoluteClipBox

calcAbsoluteClipBox

dump

dumpBoxes

getWidth

toString

addChildForLayout

addChild

addAllChildren

removeAllChildren

removeChild

getPreviousSibling

getNextSibling

getPrevious

getNext

removeChild

setParent

getParent

getDocumentParent

getChildCount

getChild

getChildIterator

getChildren

getChildIteratorOfType

getState

setState

stateToString

getStyle

setStyle

getContainingBlock

setContainingBlock

getMarginEdge