org.axsl.fo
Interface FoLineText

All Superinterfaces:

LineContent, LineText

All Known Subinterfaces:

CharacterSequence

public interface FoLineText
extends LineText

Subinterface of LineText that provides additional services to XSL-FO systems.

Method Summary

FoLineText	getContextWrapper(FoContext context) Allows the FoContext to attach itself to a LineText item as it passes through the line-breaking system, if that context is necessary.
GraftingPoint	getGraftingPoint() Return the grafting point (retrieve-marker or retrieve-table-marker) associated with this item, if any.
FoLineText	getWrapped() If this instance wraps another (to provide context), return the wrapped instance.
Iso3166	inlineCountry(FoContext context) Context-aware version of LineText.inlineCountry().
int	inlineFauxSmallCapsFontSize(FoContext context) Context-aware version of LineText.inlineFauxSmallCapsFontSize().
int	inlineFontSize(FoContext context) Context-aware version of LineText.inlineFontSize().
boolean	inlineHyphenate(FoContext context) Context-aware version of LineText.inlineHyphenate().
int	inlineHyphenationCharacter(FoContext context) Context-aware version of LineText.inlineHyphenationCharacter().
int	inlineHyphenationPushCount(FoContext context) Context-aware version of LineText.inlineHyphenationPushCount().
int	inlineHyphenationRemainCount(FoContext context) Context-aware version of LineText.inlineHyphenationRemainCount().
boolean	inlineIsFauxSmallCaps(FoContext context) Context-aware version of LineText.inlineIsFauxSmallCaps().
Iso639	inlineLanguage(FoContext context) Context-aware version of LineText.inlineLanguage().
int	inlineLetterSpacingOptimum(FoContext context) Context-aware version of LineText.inlineLetterSpacingOptimum().
FontUse	inlinePrimaryFont(FoContext context) Context-aware version of LineText.inlinePrimaryFont().
FontUse	inlineSecondaryFont(FoContext context, char c) Context-aware version of LineText.inlineSecondaryFont(char).
char[]	inlineText(FoContext context) Context-aware version of LineText.inlineText().
boolean	inlineWrapOption(FoContext context) Context-aware version of LineText.inlineWrapOption().

Methods inherited from interface org.axsl.text.line.LineText

inlineCountry, inlineFauxSmallCapsFontSize, inlineFontSize, inlineHyphenate, inlineHyphenationCharacter, inlineHyphenationPushCount, inlineHyphenationRemainCount, inlineIsFauxSmallCaps, inlineLanguage, inlineLetterSpacingOptimum, inlinePrimaryFont, inlineSecondaryFont, inlineText, inlineWrapOption, nextContiguousLineText, previousContiguousLineText

Methods inherited from interface org.axsl.text.line.LineContent

isLastItemInBlock

Method Detail

getContextWrapper

FoLineText getContextWrapper(FoContext context)

Allows the FoContext to attach itself to a LineText item as it passes through the line-breaking system, if that context is necessary.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

Either "this" or a context-aware equivalent of "this", depending upon whether the context is needed.

getWrapped

FoLineText getWrapped()

If this instance wraps another (to provide context), return the wrapped instance.

Returns:

The wrapped instance, or "this" if it is not a wrapper.

getGraftingPoint

GraftingPoint getGraftingPoint()

Return the grafting point (retrieve-marker or retrieve-table-marker) associated with this item, if any.

Returns:

The grafting point associated with this item, or null if there is none.

inlineText

char[] inlineText(FoContext context)

Context-aware version of LineText.inlineText().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

A char array containing the text which represents the content of this item.

inlinePrimaryFont

FontUse inlinePrimaryFont(FoContext context)

Context-aware version of LineText.inlinePrimaryFont().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The primary FontUse instance that should be used in character size computations for this text.

inlineSecondaryFont

FontUse inlineSecondaryFont(FoContext context,
                            char c)

Context-aware version of LineText.inlineSecondaryFont(char).

Parameters:

context - An object that knows how to resolve FO Tree context issues.

c - The character for which a secondary font is desired.

Returns:

The best FontUse instance possible for c, which can be used in character size computations for this text.

inlineFontSize

int inlineFontSize(FoContext context)

Context-aware version of LineText.inlineFontSize().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The size of the font, in millipoints.

inlineLetterSpacingOptimum

int inlineLetterSpacingOptimum(FoContext context)

Context-aware version of LineText.inlineLetterSpacingOptimum().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The optimum amount of letter-spacing, in millipoints.

inlineWrapOption

boolean inlineWrapOption(FoContext context)

Context-aware version of LineText.inlineWrapOption().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True if text should be wrapped.

inlineHyphenate

boolean inlineHyphenate(FoContext context)

Context-aware version of LineText.inlineHyphenate().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True if the text can be hyphenated.

inlineLanguage

Iso639 inlineLanguage(FoContext context)

Context-aware version of LineText.inlineLanguage().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The language for this text.

inlineCountry

Iso3166 inlineCountry(FoContext context)

Context-aware version of LineText.inlineCountry().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The country for this text.

inlineHyphenationRemainCount

int inlineHyphenationRemainCount(FoContext context)

Context-aware version of LineText.inlineHyphenationRemainCount().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The minimum number of characters in the word that can be left on the line.

inlineHyphenationPushCount

int inlineHyphenationPushCount(FoContext context)

Context-aware version of LineText.inlineHyphenationPushCount().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The minimum number of characters in the word that can be pushed to the next line.

inlineHyphenationCharacter

int inlineHyphenationCharacter(FoContext context)

Context-aware version of LineText.inlineHyphenationCharacter().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The hyphenation character that should be used for discretionary hyphens for this text, as an unsigned 21-bit Unicode code point.

inlineIsFauxSmallCaps

boolean inlineIsFauxSmallCaps(FoContext context)

Context-aware version of LineText.inlineIsFauxSmallCaps().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True iff this text should have faux small-caps applied.

inlineFauxSmallCapsFontSize

int inlineFauxSmallCapsFontSize(FoContext context)

Context-aware version of LineText.inlineFauxSmallCapsFontSize().

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

The font size for lowercase characters when faux small-caps is applied.