org.jfree.layouting.renderer.model

Class RenderableText

public class RenderableText extends RenderNode

The renderable text is a text chunk, enriched with layouting information, such as break opportunities, character sizes, kerning information and spacing information.

Text is given as codepoints. Break opportunities are given as integer values, where zero forbids breaking, and higher values denote better breaks. Spacing and glyph sizes and kerning is given in micro-points; Spacing is the 'added' space between codepoints if text-justification is enabled.

The text is computed as grapheme clusters; this means that several unicode codepoints may result in a single /virtual/ glyph/codepoint/character. (Example: 'A' + accent symbols). If the font supports Lithurges, these lithurges may also be represented as a single grapheme cluster (and thus behave unbreakable).

Grapheme clusters with more than one unicode char have the size of that char added to the first codepoint, all subsequence codepoints of the same cluster have a size/kerning/etc of zero and are unbreakable.

This text chunk is perfectly suitable for horizontal text, going either from left-to-right or right-to-left. (Breaking mixed text is up to the textfactory).

Author: Thomas Morgner

Constructor Summary
protected RenderableText()
RenderableText(ExtendedBaselineInfo baselineInfo, Glyph[] glyphs, int offset, int length, int script, boolean forceLinebreak)
Method Summary
ExtendedBaselineInfogetBaselineInfo()
Returns the baseline info for the given node.
Glyph[]getGlyphs()
intgetLength()
longgetMinimumWidth()
intgetOffset()
longgetPreferredWidth()
StringgetRawText()
intgetScript()
protected voidinitialize(Glyph[] glyphs, int offset, int length, ExtendedBaselineInfo baselineInfo, int script, boolean forceLinebreak)
booleanisDiscardable()
booleanisEmpty()
booleanisForceLinebreak()
booleanisLtr()

Constructor Detail

RenderableText

protected RenderableText()

RenderableText

public RenderableText(ExtendedBaselineInfo baselineInfo, Glyph[] glyphs, int offset, int length, int script, boolean forceLinebreak)

Method Detail

getBaselineInfo

public ExtendedBaselineInfo getBaselineInfo()
Returns the baseline info for the given node. This can be null, if the node does not have any baseline info.

Returns:

getGlyphs

public Glyph[] getGlyphs()

getLength

public int getLength()

getMinimumWidth

public long getMinimumWidth()

getOffset

public int getOffset()

getPreferredWidth

public long getPreferredWidth()

getRawText

public String getRawText()

getScript

public int getScript()

initialize

protected void initialize(Glyph[] glyphs, int offset, int length, ExtendedBaselineInfo baselineInfo, int script, boolean forceLinebreak)

isDiscardable

public boolean isDiscardable()

isEmpty

public boolean isEmpty()

isForceLinebreak

public boolean isForceLinebreak()

isLtr

public boolean isLtr()