com.openhtmltopdf.render

Class InlineLayoutBox

java.lang.Object

com.openhtmltopdf.render.Box

com.openhtmltopdf.render.InlineLayoutBox

All Implemented Interfaces:

InlinePaintable, Styleable, DisplayListItem

public class InlineLayoutBox
extends Box
implements InlinePaintable

A Box which contains the portion of an inline element layed out on a single line. It may contain content from several InlineBox objects if the original inline element was interrupted by nested content. Unlike other boxes, its children may be either Box objects (for example, a box with display: inline-block) or InlineText objects. For this reason, it's children are not stored in the children property, but instead stored in the inlineChildren property.

Nested Class Summary

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

Box.ChildIteratorOfType<T>

Field Summary

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
InlineLayoutBox(LayoutContext c, Element elem, CalculatedStyle style, int cbWidth)

Method Summary

Modifier and Type	Method and Description
void	addAllChildren(List<? super Box> list, Layer layer)
void	addInlineChild(LayoutContext c, Object child)
void	addInlineChild(LayoutContext c, Object child, boolean callUnmarkPending)
float	adjustHorizontalPosition(JustificationInfo info, float adjust)
float	adjustHorizontalPositionRTL(JustificationInfo info, float adjust)
void	calcCanvasLocation()
void	calcChildLocations()
protected void	calcChildPaintingInfo(CssContext c, PaintingInfo result, boolean useCache)
void	calculateHeight(LayoutContext c)
void	calculateTextDecoration(LayoutContext c)
void	collectText(RenderingContext c, StringBuilder buffer)
void	connectChildrenToCurrentLayer(LayoutContext c)
InlineLayoutBox	copyOf()
void	countJustifiableChars(CharCounts counts)
String	dump(LayoutContext c, String indent, int which)
Box	find(CssContext cssCtx, int absX, int absY, boolean findAnonymous)
InlineText	findTrailingText()
int	getBaseline()
Rectangle	getBorderEdge(int left, int top, CssContext cssCtx)
int	getBorderSides()
int	getContainingBlockWidth()
Rectangle	getContentAreaEdge(int left, int top, CssContext cssCtx)
int	getEffectiveWidth()
List<Box>	getElementBoxes(Element elem)
List<Box>	getElementWithContent()
Object	getInlineChild(int i)
int	getInlineChildCount()
List<Object>	getInlineChildren() Either Box, including InlineLayoutBox or InlineText objects.
int	getInlineWidth()
int	getInlineWidth(CssContext cssCtx)
int	getLeftMarginBorderPadding(CssContext cssCtx)
LineBox	getLineBox()
Rectangle	getMarginEdge(int left, int top, CssContext cssCtx, int tx, int ty)
protected Box	getNext(Box child)
protected Box	getPrevious(Box child)
int	getRightMarginPaddingBorder(CssContext cssCtx)
List<TextDecoration>	getTextDecorations()
boolean	hasNonTextContent(CssContext c)
boolean	isAllTextItems(CssContext c)
boolean	isContainsVisibleContent()
boolean	isEndsHere()
boolean	isPending()
boolean	isStartsHere()
void	lookForDynamicFunctions(RenderingContext c, boolean evaluateLeaders) This method will look for dynamic functions such as counter or target-counter and evaluate them.
void	paintDebugOutline(RenderingContext c)
void	paintInline(RenderingContext c)
void	paintSelection(RenderingContext c)
Dimension	positionRelative(CssContext cssCtx)
void	prunePending(LayoutContext c)
boolean	removeChild(Box child) Removes a child box if it is indeed a child and adjusts the index of subsequent children.
boolean	removeChild(int i) Removes child by index and adjusts the index of subsequent children.
protected void	resetChildren(LayoutContext c)
void	setBaseline(int baseline)
void	setContainingBlockWidth(int containingBlockWidth)
void	setEndsHere(boolean endsHere)
void	setInlineWidth(int inlineWidth)
void	setPending(boolean b)
void	setStartsHere(boolean startsHere)
void	setTextDecorations(List<TextDecoration> textDecoration)
String	toString()
void	unmarkPending(LayoutContext c)

Methods inherited from class com.openhtmltopdf.render.Box

addAllChildren, addChild, addChildForLayout, analyzePageBreaks, ancestors, ancestorsWhile, calcPaintingInfo, collectLayoutText, crossesPageBreak, detach, dumpBoxes, exportPageBoxText, exportText, findAncestor, findColumnBreakOpportunities, forcePageBreakAfter, forcePageBreakBefore, forcePageBreakBefore, getAbsoluteClipBox, getAbsX, getAbsY, getAccessibilityObject, getBorder, getBorderBox, getBorderBoxHeight, getBorderBoxWidth, getBoxDimensions, getChild, getChildCount, getChildIterator, getChildIteratorOfType, getChildren, getChildrenClipEdge, getClipBox, getContainingBlock, getContainingLayer, getContentWidth, getDocumentParent, getEffBackgroundColor, getElement, getHeight, getIndex, getLayer, getLeftMBP, getMargin, getMarginBorderPadding, getMarginEdge, getNextSibling, getPadding, getPaddingEdge, getPaddingWidth, getPaintingBorderEdge, getPaintingClipEdge, getPaintingInfo, getPaintingPaddingEdge, getParent, getParentClipBox, getPreviousSibling, getPseudoElementOrClass, getRelativeOffset, getRightMBP, getState, getStyle, getStyleMargin, getStyleMargin, getTx, getTy, getWidth, getX, getY, hasRootElementBackground, initContainingLayer, isAnonymous, isBody, isBody, isContainedInMarginBox, isFirstChild, isInDocumentFlow, isInitialContainingBlock, isInlineBlock, isMarginAreaRoot, isRoot, isStyled, isTerminalColumnBreak, moveIfGreater, paintBackground, paintBorder, paintRootElementBackground, removeAllChildren, reset, resetChildren, resetTopMargin, rootBox, setAbsX, setAbsY, setAccessiblityObject, setAnonymous, setBorderBoxHeight, setBorderBoxWidth, setBoxDimensions, setContainingBlock, setContainingLayer, setContentWidth, setElement, 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

InlineLayoutBox

public InlineLayoutBox(LayoutContext c,
                       Element elem,
                       CalculatedStyle style,
                       int cbWidth)

Method Detail

copyOf

public InlineLayoutBox copyOf()

calculateHeight

public void calculateHeight(LayoutContext c)

getBaseline

public int getBaseline()

setBaseline

public void setBaseline(int baseline)

getInlineChildCount

public int getInlineChildCount()

addInlineChild

public void addInlineChild(LayoutContext c,
                           Object child)

addInlineChild

public void addInlineChild(LayoutContext c,
                           Object child,
                           boolean callUnmarkPending)

getInlineChildren

public List<Object> getInlineChildren()

Either Box, including InlineLayoutBox or InlineText objects.

getInlineChild

public Object getInlineChild(int i)

getInlineWidth

public int getInlineWidth(CssContext cssCtx)

prunePending

public void prunePending(LayoutContext c)

isEndsHere

public boolean isEndsHere()

setEndsHere

public void setEndsHere(boolean endsHere)

isStartsHere

public boolean isStartsHere()

setStartsHere

public void setStartsHere(boolean startsHere)

isPending

public boolean isPending()

setPending

public void setPending(boolean b)

unmarkPending

public void unmarkPending(LayoutContext c)

connectChildrenToCurrentLayer

public void connectChildrenToCurrentLayer(LayoutContext c)

Overrides:

connectChildrenToCurrentLayer in class Box

paintSelection

public void paintSelection(RenderingContext c)

paintInline

public void paintInline(RenderingContext c)

Specified by:

paintInline in interface InlinePaintable

hasNonTextContent

public boolean hasNonTextContent(CssContext c)

Overrides:

hasNonTextContent in class Box

isAllTextItems

public boolean isAllTextItems(CssContext c)

getBorderSides

public int getBorderSides()

Overrides:

getBorderSides in class Box

getBorderEdge

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

Overrides:

getBorderEdge in class Box

getMarginEdge

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

Overrides:

getMarginEdge in class Box

getContentAreaEdge

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

Overrides:

getContentAreaEdge in class Box

getLeftMarginBorderPadding

public int getLeftMarginBorderPadding(CssContext cssCtx)

getRightMarginPaddingBorder

public int getRightMarginPaddingBorder(CssContext cssCtx)

getInlineWidth

public int getInlineWidth()

setInlineWidth

public void setInlineWidth(int inlineWidth)

isContainsVisibleContent

public boolean isContainsVisibleContent()

getTextDecorations

public List<TextDecoration> getTextDecorations()

setTextDecorations

public void setTextDecorations(List<TextDecoration> textDecoration)

getLineBox

public LineBox getLineBox()

getElementWithContent

public List<Box> getElementWithContent()

getElementBoxes

public List<Box> getElementBoxes(Element elem)

Overrides:

getElementBoxes in class Box

positionRelative

public Dimension positionRelative(CssContext cssCtx)

Overrides:

positionRelative in class Box

addAllChildren

public void addAllChildren(List<? super Box> list,
                           Layer layer)

paintDebugOutline

public void paintDebugOutline(RenderingContext c)

resetChildren

protected void resetChildren(LayoutContext c)

Overrides:

resetChildren in class Box

removeChild

public boolean removeChild(Box child)

Removes a child box if it is indeed a child and adjusts the index of subsequent children. Returns whether this was a child.

Overrides:

removeChild in class Box

removeChild

public boolean removeChild(int i)

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 Box.removeChild(Box)

Overrides:

removeChild in class Box

getPrevious

protected Box getPrevious(Box child)

Overrides:

getPrevious in class Box

getNext

protected Box getNext(Box child)

Overrides:

getNext in class Box

calcCanvasLocation

public void calcCanvasLocation()

Specified by:

calcCanvasLocation in class Box

calcChildLocations

public void calcChildLocations()

Overrides:

calcChildLocations in class Box

calcChildPaintingInfo

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

Overrides:

calcChildPaintingInfo in class Box

lookForDynamicFunctions

public void lookForDynamicFunctions(RenderingContext c,
                                    boolean evaluateLeaders)

This method will look for dynamic functions such as counter or target-counter and evaluate them.

Parameters:

evaluateLeaders - whether to evaluate leader functions - we don't want to evaluate the two leaders on the one line.

findTrailingText

public InlineText findTrailingText()

calculateTextDecoration

public void calculateTextDecoration(LayoutContext c)

find

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

Overrides:

find in class Box

getContainingBlockWidth

public int getContainingBlockWidth()

Overrides:

getContainingBlockWidth in class Box

setContainingBlockWidth

public void setContainingBlockWidth(int containingBlockWidth)

toString

public String toString()

Overrides:

toString in class Box

dump

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

Specified by:

dump in class Box

collectText

public void collectText(RenderingContext c,
                        StringBuilder buffer)

Overrides:

collectText in class Box

countJustifiableChars

public void countJustifiableChars(CharCounts counts)

adjustHorizontalPosition

public float adjustHorizontalPosition(JustificationInfo info,
                                      float adjust)

adjustHorizontalPositionRTL

public float adjustHorizontalPositionRTL(JustificationInfo info,
                                         float adjust)

getEffectiveWidth

public int getEffectiveWidth()

Overrides:

getEffectiveWidth in class Box