org.axsl.text.line
Interface LineText

All Superinterfaces:

LineContent

All Known Subinterfaces:

FOLineText, FOText

public interface LineText

extends LineContent

This interface should be used by classes who wish to present themselves to the line-breaking system as containing text.

Method Summary

java.lang.String	inlineCountry() Tells the line-breaking system which country to use for purposes of hyphenation and other line-breaking decisions.
int	inlineFauxSmallCapsFontSize() Tells the line-breaking system what font-size should be used on faux small-caps text.
int	inlineFontSize() Tells the line-breaking system the size of the Font that should be used in the character size computations.
boolean	inlineHyphenate() Tells the line-breaking system whether the text can be hyphenated or not.
int	inlineHyphenationCharacter() Tells the line-breaking system what character to use as the hyphen for purposes of hyphenation.
int	inlineHyphenationPushCount() Tells the line-breaking system the minimum number of characters in a hyphenated word after the hyphenation character.
int	inlineHyphenationRemainCount() Tells the line-breaking system the minimum number of characters in a hyphenated word before the hyphenation character.
boolean	inlineIsFauxSmallCaps() Tells the line-breaking system whether faux small-caps should be applied to this text.
java.lang.String	inlineLanguage() Tells the line-breaking system which language to use for purposes of hyphenation and other line-breaking decisions.
int	inlineLetterSpacingOptimum() Tells the line-breaking system the optimum amount of letter-spacing that should be used the line-breaking computations.
FontUse	inlinePrimaryFont() Tells the line-breaking sytem which FontUse instance should be considered the primary font to use in the text size computations.
FontUse	inlineSecondaryFont(char c) Provides a way to obtain a secondary FontUse instance for characters that cannot be encoded by the primary font.
char[]	inlineText() Tells the line-breaking system what char array to use as the text for which the line-breaks should be computed.
boolean	inlineWrapOption() Tells the line-breaking system whether the text should wrap to a new line, or whether it should be overflowed.
LineText	nextContiguousLineText() Gives the line-breaking system the next contiguous LineText instance, if any.
LineText	previousContiguousLineText() Gives the line-breaking system the preceding contiguous LineText instance, if any.

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

isLastItemInBlock

Method Detail

inlineText

public char[] inlineText()

Tells the line-breaking system what char array to use as the text for which the line-breaks should be computed.

Returns:

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

inlinePrimaryFont

public FontUse inlinePrimaryFont()

Tells the line-breaking sytem which FontUse instance should be considered the primary font to use in the text size computations.

Returns:

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

inlineSecondaryFont

public FontUse inlineSecondaryFont(char c)

Provides a way to obtain a secondary FontUse instance for characters that cannot be encoded by the primary font. Note that this method should only be used if the FontUse returned by inlinePrimaryFont() is incapable of encoding c.

Parameters:

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()

Tells the line-breaking system the size of the Font that should be used in the character size computations.

Returns:

The size of the font, in millipoints.

inlineLetterSpacingOptimum

public int inlineLetterSpacingOptimum()

Tells the line-breaking system the optimum amount of letter-spacing that should be used the line-breaking computations.

Returns:

The optimum amount of letter-spacing, in millipoints.

inlineWrapOption

public boolean inlineWrapOption()

Tells the line-breaking system whether the text should wrap to a new line, or whether it should be overflowed.

Returns:

True if text should be wrapped.

inlineHyphenate

public boolean inlineHyphenate()

Tells the line-breaking system whether the text can be hyphenated or not.

Returns:

True if the text can be hyphenated.

inlineLanguage

public java.lang.String inlineLanguage()

Tells the line-breaking system which language to use for purposes of hyphenation and other line-breaking decisions.

Returns:

The language for this text.

inlineCountry

public java.lang.String inlineCountry()

Tells the line-breaking system which country to use for purposes of hyphenation and other line-breaking decisions.

Returns:

The country for this text.

inlineHyphenationRemainCount

public int inlineHyphenationRemainCount()

Tells the line-breaking system the minimum number of characters in a hyphenated word before the hyphenation character. This is the minumum number of characters in the word left on the line ending with the hyphenation character.

Returns:

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

inlineHyphenationPushCount

public int inlineHyphenationPushCount()

Tells the line-breaking system the minimum number of characters in a hyphenated word after the hyphenation character. This is the minumum number of characters in the word pushed to the next line after the line ending with the hyphenation character.

Returns:

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

inlineHyphenationCharacter

public int inlineHyphenationCharacter()

Tells the line-breaking system what character to use as the hyphen for purposes of hyphenation.

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()

Tells the line-breaking system whether faux small-caps should be applied to this text.

Returns:

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

inlineFauxSmallCapsFontSize

public int inlineFauxSmallCapsFontSize()

Tells the line-breaking system what font-size should be used on faux small-caps text.

Returns:

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

nextContiguousLineText

public LineText nextContiguousLineText()

Gives the line-breaking system the next contiguous LineText instance, if any. Only LineText items that are contextual to this instance should be returned. If the nearest LineText item is in a different paragraph or if something is between the two, null should be returned.

Returns:

The next contiguous LineText item, or null if there is none.

previousContiguousLineText

public LineText previousContiguousLineText()

Gives the line-breaking system the preceding contiguous LineText instance, if any. Only LineText items that are contextual to this instance should be returned. If the nearest LineText item is in a different paragraph or if something is between the two, null should be returned.

Returns:

The previous contiguous LineText item, or null if there is none.