com.openhtmltopdf.render

Class InlineBox

java.lang.Object

com.openhtmltopdf.render.InlineBox

All Implemented Interfaces:

Styleable

public class InlineBox
extends Object
implements Styleable

A class which represents a portion of an inline element. If an inline element does not contain any nested elements, then a single InlineBox object will contain the content for the entire element. Otherwise multiple InlineBox objects will be created corresponding to each discrete chunk of text appearing in the element. It is not rendered directly (and hence does not extend from Box), but does play an important role in layout (for example, when calculating min/max widths). Note that it does not contain children. Inline content is stored as a flat list in the layout tree. However, InlineBox does contain enough information to reconstruct the original element nesting and this is, in fact, done during inline layout.

See Also:

InlineLayoutBox

Constructor Summary

Constructors

Constructor and Description
InlineBox(String text)

Method Summary

Modifier and Type	Method and Description
protected void	appendPositioningInfo(StringBuilder result)
void	applyTextTransform()
void	calcMinMaxWidth(LayoutContext c, int cbWidth, boolean trimLeadingSpace)
ContentFunction	getContentFunction()
Element	getElement()
int	getFirstLineWidth()
BlockBox	getFootnoteBody()
FSFunction	getFunction()
int	getMaxWidth()
int	getMinWidth()
String	getPseudoElementOrClass()
int	getSpaceWidth(LayoutContext c)
CalculatedStyle	getStyle()
String	getText()
byte	getTextDirection()
int	getTrailingSpaceWidth(LayoutContext c)
boolean	hasFootnote()
boolean	isDynamicFunction()
boolean	isEndsHere() The opposite of isStartsHere()
boolean	isRemovableWhitespace()
boolean	isStartsHere() Whether this is the first InlineBox for a box.
void	setContentFunction(ContentFunction contentFunction)
void	setElement(Element element)
void	setEndsHere(boolean endsHere) See isEndsHere()
void	setFootnote(BlockBox footnoteBody)
void	setFunction(FSFunction function)
void	setPseudoElementOrClass(String pseudoElementOrClass)
void	setRemovableWhitespace(boolean removeableWhitespace)
void	setStartsHere(boolean startsHere) See isStartsHere()
void	setStyle(CalculatedStyle style)
void	setText(String text)
void	setTextDirection(byte direction)
String	toString()
void	truncateText()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InlineBox

public InlineBox(String text)

Method Detail

setTextDirection

public void setTextDirection(byte direction)

Parameters:

direction - either LTR or RTL from BidiSplitter interface.

getTextDirection

public byte getTextDirection()

Returns:

either LTR or RTL from BidiSplitter interface.

getText

public String getText()

setText

public void setText(String text)

applyTextTransform

public void applyTextTransform()

isRemovableWhitespace

public boolean isRemovableWhitespace()

setRemovableWhitespace

public void setRemovableWhitespace(boolean removeableWhitespace)

isEndsHere

public boolean isEndsHere()

The opposite of isStartsHere()

setEndsHere

public void setEndsHere(boolean endsHere)

See isEndsHere()

isStartsHere

public boolean isStartsHere()

Whether this is the first InlineBox for a box. For example: [b]one[i]two[/i]three[/b] will create three InlineBox objects and one and two will return true for isStartsHere. This is used for example to decide whether left margin needs to be applied.

setStartsHere

public void setStartsHere(boolean startsHere)

See isStartsHere()

getStyle

public CalculatedStyle getStyle()

Specified by:

getStyle in interface Styleable

setStyle

public void setStyle(CalculatedStyle style)

Specified by:

setStyle in interface Styleable

getElement

public Element getElement()

Specified by:

getElement in interface Styleable

setElement

public void setElement(Element element)

Specified by:

setElement in interface Styleable

getContentFunction

public ContentFunction getContentFunction()

setContentFunction

public void setContentFunction(ContentFunction contentFunction)

isDynamicFunction

public boolean isDynamicFunction()

getSpaceWidth

public int getSpaceWidth(LayoutContext c)

getTrailingSpaceWidth

public int getTrailingSpaceWidth(LayoutContext c)

calcMinMaxWidth

public void calcMinMaxWidth(LayoutContext c,
                            int cbWidth,
                            boolean trimLeadingSpace)

getMaxWidth

public int getMaxWidth()

getMinWidth

public int getMinWidth()

getFirstLineWidth

public int getFirstLineWidth()

getPseudoElementOrClass

public String getPseudoElementOrClass()

Specified by:

getPseudoElementOrClass in interface Styleable

setPseudoElementOrClass

public void setPseudoElementOrClass(String pseudoElementOrClass)

toString

public String toString()

Overrides:

toString in class Object

appendPositioningInfo

protected void appendPositioningInfo(StringBuilder result)

getFunction

public FSFunction getFunction()

setFunction

public void setFunction(FSFunction function)

truncateText

public void truncateText()

setFootnote

public void setFootnote(BlockBox footnoteBody)

hasFootnote

public boolean hasFootnote()

getFootnoteBody

public BlockBox getFootnoteBody()