org.axsl.foR
Interface FOLineText

All Superinterfaces:

LineContent, LineText

All Known Subinterfaces:

FOText

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.
RetrieveMarker	getRetrieveMarker() Return the retrieve-marker associated with this item, if any.
FOLineText	getWrapped() If this instance wraps another (to provide context), return the wrapped instance.
java.lang.String	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().
java.lang.String	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

public 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

public 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.

getRetrieveMarker

public RetrieveMarker getRetrieveMarker()

Return the retrieve-marker associated with this item, if any.

Returns:

The retrieve-marker associated with this item, or null if there is none.

inlineText

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public java.lang.String 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

public java.lang.String 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

public 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

public 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

public 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

public 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

public 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.