org.apache.flex.compiler.internal.fxg.dom.text

Class AbstractCharacterTextNode

java.lang.Object

org.apache.flex.compiler.internal.fxg.dom.AbstractFXGNode

org.apache.flex.compiler.internal.fxg.dom.text.AbstractTextNode

org.apache.flex.compiler.internal.fxg.dom.text.AbstractCharacterTextNode

All Implemented Interfaces:

IFXGNode, IPreserveWhiteSpaceNode, ITextNode

Direct Known Subclasses:

ParagraphNode, SpanNode

public abstract class AbstractCharacterTextNode
extends AbstractTextNode

A base class for text nodes that have character formatting.

Field Summary

Fields

Modifier and Type	Field and Description
int	color
String	fontFamily
double	fontSize
protected static double	FONTSIZE_MAX_INCLUSIVE
protected static double	FONTSIZE_MIN_INCLUSIVE
String	fontStyle
String	fontWeight
Kerning	kerning
LineBreak	lineBreak
double	lineHeight
boolean	lineThrough
double	textAlpha
String	textDecoration
double	tracking
WhiteSpaceCollapse	whiteSpaceCollapse

Fields inherited from class org.apache.flex.compiler.internal.fxg.dom.text.AbstractTextNode

content, id, textAttributes

Fields inherited from class org.apache.flex.compiler.internal.fxg.dom.AbstractFXGNode

ALPHA_MAX_INCLUSIVE, ALPHA_MIN_INCLUSIVE, COLOR_BLACK, COLOR_RED, COLOR_WHITE, documentNode, endColumn, endLine, EPSILON, GRADIENT_ENTRIES_MAX_INCLUSIVE, startColumn, startLine, uri

Constructor Summary

Constructors

Constructor and Description
AbstractCharacterTextNode()

Method Summary

Methods

Modifier and Type	Method and Description
static Kerning	getKerning(IFXGNode node, String value, Collection<ICompilerProblem> problems) Convert an FXG String value to a Kerning enumeration.
static LineBreak	getLineBreak(IFXGNode node, String value, Collection<ICompilerProblem> problems) Convert an FXG String value to a LineBreak enumeration.
static WhiteSpaceCollapse	getWhiteSpaceCollapse(IFXGNode node, String value, Collection<ICompilerProblem> problems) Convert an FXG String value to a WhiteSpaceCollapse enumeration.
void	setAttribute(String name, String value, Collection<ICompilerProblem> problems) This implementation processes character attributes that are common to <TextGraphic>, <p>, and <span>.

Methods inherited from class org.apache.flex.compiler.internal.fxg.dom.text.AbstractTextNode

addChild, addTextProperty, getChildren, getId, getTextAttributes, getTextChildren, getTextProperties, rememberAttribute, setId

Methods inherited from class org.apache.flex.compiler.internal.fxg.dom.AbstractFXGNode

getDocumentNode, getDocumentPath, getEndColumn, getEndLine, getFileVersion, getNodeURI, getStartColumn, getStartLine, isVersionGreaterThanCompiler, setDocumentNode, setEndColumn, setEndLine, setNodeURI, setStartColumn, setStartLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.fxg.dom.IFXGNode

getDocumentNode, getDocumentPath, getEndColumn, getEndLine, getNodeName, getNodeURI, getStartColumn, getStartLine, setDocumentNode, setEndColumn, setEndLine, setStartColumn, setStartLine

Field Detail

FONTSIZE_MIN_INCLUSIVE

protected static final double FONTSIZE_MIN_INCLUSIVE

See Also:

Constant Field Values

FONTSIZE_MAX_INCLUSIVE

protected static final double FONTSIZE_MAX_INCLUSIVE

See Also:

Constant Field Values

fontFamily

public String fontFamily

fontSize

public double fontSize

fontStyle

public String fontStyle

fontWeight

public String fontWeight

lineHeight

public double lineHeight

textDecoration

public String textDecoration

whiteSpaceCollapse

public WhiteSpaceCollapse whiteSpaceCollapse

lineBreak

public LineBreak lineBreak

tracking

public double tracking

kerning

public Kerning kerning

textAlpha

public double textAlpha

color

public int color

lineThrough

public boolean lineThrough

Constructor Detail

AbstractCharacterTextNode

public AbstractCharacterTextNode()

Method Detail

setAttribute

public void setAttribute(String name,
                String value,
                Collection<ICompilerProblem> problems)

This implementation processes character attributes that are common to <TextGraphic>, <p>, and <span>.

The right hand side of an ActionScript assignment is generated for each property based on the expected type of the attribute.

Character attributes include:

• fontFamily (String): The font family name used to render the text. Default value is Times New Roman (Times on Mac OS X).
• fontSize (Number): The size of the glyphs that is used to render the text, specified in point sizes. Default is 12. Minimum 1 point. Maximum 500 points.
• fontStyle (String): [normal, italic] The style of the glyphs that is used to render the text. Legal values are 'normal' and 'italic'. Default is normal.
• fontWeight (String): [normal, bold] The boldness or lightness of the glyphs that is used to render the text. Default is normal.
• lineHeight (Percent | Number): The leading, or the distance from the previous line's baseline to this one, in points. Default is 120%. Minimum value for percent or number is 0.
• tracking (Percent): Space added to the advance after each character, as a percentage of the current point size. Percentages can be negative, to bring characters closer together. Default is 0.
• textDecoration (String): [none, underline]: The decoration to apply to the text. Default is none.
• lineThrough (Boolean): true if text has strikethrough applied, false otherwise. Default is false.
• color (Color): The color of the text. Default is 0x000000.
• textAlpha (alpha): The alpha value applied to the text. Default is 1.0.
• whiteSpaceCollapse (String): [preserve, collapse] This is an enumerated value. A value of "collapse" converts line feeds, newlines, and tabs to spaces and collapses adjacent spaces to one. Leading and trailing whitespace is trimmed. A value of "preserve" passes whitespace through unchanged.
• lineBreak (String): [toFit, explicit] This is an enumeration. A value of "toFit" wraps the lines at the edge of the enclosing TextGraphic. A value of "explicit" breaks the lines only at a Unicode line end character (such as a newline or line separator). toFit is the default.
• kerning (String): [on, off, auto] If on, pair kerns are honored. If off, there is no font-based kerning applied. If auto, kerning is applied to all characters except Kanji, Hiragana or Katakana. The default is auto.

Specified by:

setAttribute in interface IFXGNode

Overrides:

setAttribute in class AbstractTextNode

Parameters:

name - - the unqualified attribute name

value - - the attribute value

problems - problem collection used to collect problems occurred within this method

getKerning

public static Kerning getKerning(IFXGNode node,
                 String value,
                 Collection<ICompilerProblem> problems)

Convert an FXG String value to a Kerning enumeration.

Parameters:

value - - the FXG String value.

Returns:

the matching Kerning value.

getLineBreak

public static LineBreak getLineBreak(IFXGNode node,
                     String value,
                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a LineBreak enumeration.

Parameters:

value - - the FXG String value.

Returns:

the matching LineBreak rule.

getWhiteSpaceCollapse

public static WhiteSpaceCollapse getWhiteSpaceCollapse(IFXGNode node,
                                       String value,
                                       Collection<ICompilerProblem> problems)

Convert an FXG String value to a WhiteSpaceCollapse enumeration.

Parameters:

value - - the FXG String value.

Returns:

the matching WhiteSpaceCollapse rule.