Package org.xhtmlrenderer.render
Class Box
- java.lang.Object
-
- org.xhtmlrenderer.render.Box
-
- All Implemented Interfaces:
Styleable
- Direct Known Subclasses:
BlockBox
,InlineLayoutBox
,LineBox
public abstract class Box extends java.lang.Object implements Styleable
-
-
Field Summary
Fields Modifier and Type Field Description static int
CHILDREN_FLUX
static int
DONE
static int
DUMP_LAYOUT
static int
DUMP_RENDER
static int
FLUX
static int
NOTHING
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addAllChildren(java.util.List children)
void
addChild(Box child)
void
addChildForLayout(LayoutContext c, Box child)
void
analyzePageBreaks(LayoutContext c, ContentLimitContainer container)
abstract void
calcCanvasLocation()
void
calcChildLocations()
PaintingInfo
calcPaintingInfo(CssContext c, boolean useCache)
void
clearSelection(java.util.List modified)
void
collectText(RenderingContext c, java.lang.StringBuffer buffer)
void
connectChildrenToCurrentLayer(LayoutContext c)
boolean
crossesPageBreak(LayoutContext c)
void
detach(LayoutContext c)
abstract java.lang.String
dump(LayoutContext c, java.lang.String indent, int which)
void
exportText(RenderingContext c, java.io.Writer writer)
Box
find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)
void
forcePageBreakAfter(LayoutContext c, IdentValue pageBreakValue)
int
forcePageBreakBefore(LayoutContext c, IdentValue pageBreakValue, boolean pendingPageName)
int
getAbsX()
int
getAbsY()
BorderPropertySet
getBorder(CssContext cssCtx)
java.awt.Rectangle
getBorderEdge(int left, int top, CssContext cssCtx)
int
getBorderSides()
BoxDimensions
getBoxDimensions()
Box
getChild(int i)
int
getChildCount()
java.util.Iterator
getChildIterator()
java.util.List
getChildren()
java.awt.Rectangle
getChildrenClipEdge(RenderingContext c)
Box
getContainingBlock()
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
getElementBoxes(org.w3c.dom.Element elem)
int
getHeight()
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)
Box
getNextSibling()
RectPropertySet
getPadding(CssContext cssCtx)
java.awt.Rectangle
getPaddingEdge(int left, int top, CssContext cssCtx)
java.awt.Rectangle
getPaintingBorderEdge(CssContext cssCtx)
java.awt.Rectangle
getPaintingClipEdge(CssContext cssCtx)
PaintingInfo
getPaintingInfo()
java.awt.Rectangle
getPaintingPaddingEdge(CssContext cssCtx)
Box
getParent()
Box
getPreviousSibling()
java.lang.String
getPseudoElementOrClass()
java.awt.Dimension
getRelativeOffset()
Box
getRestyleTarget()
int
getRightMBP()
int
getState()
CalculatedStyle
getStyle()
int
getTx()
int
getTy()
int
getWidth()
int
getX()
int
getY()
void
initContainingLayer(LayoutContext c)
boolean
intersects(CssContext cssCtx, java.awt.Shape clip)
NOTE: This method does not consider any children of this boxboolean
isAnonymous()
boolean
isBody()
boolean
isContainedInMarginBox()
boolean
isInDocumentFlow()
boolean
isRoot()
boolean
isStyled()
void
paintBackground(RenderingContext c)
void
paintBorder(RenderingContext c)
void
paintRootElementBackground(RenderingContext c)
java.awt.Dimension
positionRelative(CssContext cssCtx)
void
removeAllChildren()
void
removeChild(int i)
void
removeChild(Box target)
void
reset(LayoutContext c)
void
resetChildren(LayoutContext c, int start, int end)
void
restyle(LayoutContext c)
void
selectAll()
void
setAbsX(int absX)
void
setAbsY(int absY)
void
setAnonymous(boolean anonymous)
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)
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)
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()
-
-
-
Field Detail
-
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
-
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
-
-
Method Detail
-
dump
public abstract java.lang.String dump(LayoutContext c, java.lang.String indent, int which)
-
getWidth
public int getWidth()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
addChildForLayout
public void addChildForLayout(LayoutContext c, Box child)
-
addChild
public void addChild(Box child)
-
addAllChildren
public void addAllChildren(java.util.List children)
-
removeAllChildren
public void removeAllChildren()
-
removeChild
public void removeChild(Box target)
-
getPreviousSibling
public Box getPreviousSibling()
-
getNextSibling
public Box getNextSibling()
-
removeChild
public void removeChild(int i)
-
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 getChildIterator()
-
getChildren
public java.util.List getChildren()
-
getState
public int getState()
-
setState
public void setState(int state)
-
stateToString
public static java.lang.String stateToString(int state)
-
getStyle
public final CalculatedStyle getStyle()
-
setStyle
public void setStyle(CalculatedStyle style)
-
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(RenderingContext c)
-
intersects
public boolean intersects(CssContext cssCtx, java.awt.Shape clip)
NOTE: This method does not consider any children of this box
-
getBorderEdge
public java.awt.Rectangle getBorderEdge(int left, int top, CssContext cssCtx)
-
getPaddingEdge
public java.awt.Rectangle getPaddingEdge(int left, int top, 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)
-
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)
-
paintBackground
public void paintBackground(RenderingContext c)
-
paintRootElementBackground
public void paintRootElementBackground(RenderingContext c)
-
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 getElementBoxes(org.w3c.dom.Element elem)
-
reset
public void reset(LayoutContext c)
-
detach
public void detach(LayoutContext c)
-
resetChildren
public void resetChildren(LayoutContext c, int start, int end)
-
calcCanvasLocation
public abstract void calcCanvasLocation()
-
calcChildLocations
public void calcChildLocations()
-
forcePageBreakBefore
public int forcePageBreakBefore(LayoutContext c, IdentValue pageBreakValue, boolean pendingPageName)
-
forcePageBreakAfter
public void forcePageBreakAfter(LayoutContext c, IdentValue pageBreakValue)
-
crossesPageBreak
public boolean crossesPageBreak(LayoutContext c)
-
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 interfaceStyleable
-
setElement
public void setElement(org.w3c.dom.Element element)
- Specified by:
setElement
in interfaceStyleable
-
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)
-
getMargin
public RectPropertySet getMargin(CssContext cssContext)
-
getPadding
public RectPropertySet getPadding(CssContext cssCtx)
-
getBorder
public BorderPropertySet getBorder(CssContext cssCtx)
-
clearSelection
public void clearSelection(java.util.List modified)
-
selectAll
public void selectAll()
-
calcPaintingInfo
public PaintingInfo calcPaintingInfo(CssContext c, boolean useCache)
-
getMarginBorderPadding
public int getMarginBorderPadding(CssContext cssCtx, int which)
-
restyle
public void restyle(LayoutContext c)
-
getRestyleTarget
public Box getRestyleTarget()
-
getPseudoElementOrClass
public java.lang.String getPseudoElementOrClass()
- Specified by:
getPseudoElementOrClass
in interfaceStyleable
-
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)
-
getHeight
public int getHeight()
-
setContentWidth
public void setContentWidth(int contentWidth)
-
getContentWidth
public int getContentWidth()
-
getPaintingInfo
public PaintingInfo getPaintingInfo()
-
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.StringBuffer buffer) throws java.io.IOException
- Throws:
java.io.IOException
-
exportText
public void exportText(RenderingContext c, java.io.Writer writer) 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)
-
isContainedInMarginBox
public boolean isContainedInMarginBox()
-
getEffectiveWidth
public int getEffectiveWidth()
-
-