org.axsl.galley

Interface TextArea

All Superinterfaces:

Area, AreaNode, GeneralInlineArea, java.lang.Iterable<AreaNode>, javax.swing.tree.TreeNode

All Known Subinterfaces:

LeaderArea

public interface TextArea
extends GeneralInlineArea

An Area containing text.

Method Summary

Modifier and Type	Method and Description
FontOptions	fontOptions() Indicates the font options that were used to compute this text area, and which may be needed during rendering.
FontUse	getPrimaryFont() The primary font for this Area.
FontUse	getSecondaryFont(int codePoint) The secondary font for this Area.
java.lang.CharSequence	getText() Returns the text that should actually be used in the output document.
int	letterSpacing() The letter-spacing for this Area.
Orthography	orthography() Returns the orthography for this area.
int	traitFontSize() The font-size for this Area.
int	wordSpacing() The word-spacing for this text area, that is, the extra size that should be added to the width of the space character.

Methods inherited from interface org.axsl.galley.GeneralInlineArea

baselineX, baselineY, getLineArea, traitColor, traitOverlineScore, traitOverlineScoreColor, traitThroughScore, traitThroughScoreColor, traitUnderlineScore, traitUnderlineScoreColor

Methods inherited from interface org.axsl.galley.Area

brBpd, brIpd, brOriginX, brOriginY, crBpd, crIpd, crOriginX, crOriginY, destinationName, generatedByExists, generatedByName, isLinkRoot, linkDestination, linkType, traitId

Methods inherited from interface org.axsl.galley.AreaNode

getAreaName, getChildAt, getGalley, render

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getText

java.lang.CharSequence getText()

Returns the text that should actually be used in the output document. The text returned has the following changes made to it, if appopriate:

• Any white-space changes (for example, conversion of line-feeds to spaces).
• Ligature changes and other font-driven character substitutions.
• Faux small-caps changes.
• Addition of hyphen characters at the end of a line.
• Any text-transform changes (making text all uppercase, all lowercase, or initial caps only).

Returns:

The text to be used in the output document.

getPrimaryFont

FontUse getPrimaryFont()

The primary font for this Area.

Returns:

The primary font for this Area.

getSecondaryFont

FontUse getSecondaryFont(int codePoint)

The secondary font for this Area.

Parameters:

codePoint - The Unicode code point which should be used to obtain a secondary font. This should ordinarily be the next character to be rendered that the primary font cannot render.

Returns:

The secondary font for this Area.

letterSpacing

int letterSpacing()

The letter-spacing for this Area.

Returns:

The letter-spacing, in millipoints.

wordSpacing

int wordSpacing()

The word-spacing for this text area, that is, the extra size that should be added to the width of the space character.

Returns:

Returns the amount of word-spacing, in millipoints, that should be used for this text area.

fontOptions

FontOptions fontOptions()

Indicates the font options that were used to compute this text area, and which may be needed during rendering.

Returns:

The font options.

orthography

Orthography orthography()

Returns the orthography for this area.

Returns:

The orthography;

traitFontSize

int traitFontSize()

The font-size for this Area.

Returns:

The font-size, in millipoints.