RichTextNode (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.fxg.dom.AbstractFXGNode
- - org.apache.flex.compiler.internal.fxg.dom.GraphicContentNode
  - - org.apache.flex.compiler.internal.fxg.dom.RichTextNode

All Implemented Interfaces:

IFXGNode, IMaskableNode, IPreserveWhiteSpaceNode, ITextNode

Direct Known Subclasses:

FlexRichTextNode
```
public class RichTextNode
extends GraphicContentNode
implements ITextNode
```
Represents a <RichText> element of an FXG Document.

Field Summary

Fields
Modifier and Type	Field and Description
`AlignmentBaseline`	`alignmentBaseline`
`NumberInherit`	`backgroundAlpha`
`ColorWithEnum`	`backgroundColor`
`protected static double`	`BASELINEOFFSET_MAX_INCLUSIVE`
`protected static double`	`BASELINEOFFSET_MIN_INCLUSIVE`
`BaselineShift`	`baselineShift`
`protected static double`	`BASELINESHIFT_MAX_INCLUSIVE`
`protected static double`	`BASELINESHIFT_MIN_INCLUSIVE`
`BlockProgression`	`blockProgression`
`BreakOpportunity`	`breakOpportunity`
`int`	`color`
`NumberAuto`	`columnCount`
`protected static int`	`COLUMNCOUNT_MAX_INCLUSIVE`
`protected static int`	`COLUMNCOUNT_MIN_INCLUSIVE`
`NumberInherit`	`columnGap`
`protected static double`	`COLUMNGAP_MAX_INCLUSIVE`
`protected static double`	`COLUMNGAP_MIN_INCLUSIVE`
`NumberAuto`	`columnWidth`
`protected static double`	`COLUMNWIDTH_MAX_INCLUSIVE`
`protected static double`	`COLUMNWIDTH_MIN_INCLUSIVE`
`protected List<ITextNode>`	`content` This node's child text nodes.
`DigitCase`	`digitCase`
`DigitWidth`	`digitWidth`
`Direction`	`direction`
`DominantBaseline`	`dominantBaseline`
`BaselineOffset`	`firstBaselineOffset`
`String`	`fontFamily`
`double`	`fontSize`
`protected static double`	`FONTSIZE_MAX_INCLUSIVE`
`protected static double`	`FONTSIZE_MIN_INCLUSIVE`
`FontStyle`	`fontStyle`
`FontWeight`	`fontWeight`
`double`	`height`
`JustificationRule`	`justificationRule`
`JustificationStyle`	`justificationStyle`
`Kerning`	`kerning`
`LeadingModel`	`leadingModel`
`LigatureLevel`	`ligatureLevel`
`LineBreak`	`lineBreak`
`double`	`lineHeight`
`protected static double`	`LINEHEIGHT_PERCENT_MAX_INCLUSIVE`
`protected static double`	`LINEHEIGHT_PERCENT_MIN_INCLUSIVE`
`protected static double`	`LINEHEIGHT_PIXEL_MAX_INCLUSIVE`
`protected static double`	`LINEHEIGHT_PIXEL_MIN_INCLUSIVE`
`boolean`	`lineThrough`
`TextLayoutFormatNode`	`linkActiveFormat`
`TextLayoutFormatNode`	`linkHoverFormat`
`TextLayoutFormatNode`	`linkNormalFormat`
`String`	`locale`
`protected static double`	`PADDING_MAX_INCLUSIVE`
`protected static double`	`PADDING_MIN_INCLUSIVE`
`NumberInherit`	`paddingBottom`
`NumberInherit`	`paddingLeft`
`NumberInherit`	`paddingRight`
`NumberInherit`	`paddingTop`
`protected static double`	`PARAGRAPH_INDENT_MAX_INCLUSIVE`
`protected static double`	`PARAGRAPH_INDENT_MIN_INCLUSIVE`
`protected static double`	`PARAGRAPH_SPACE_MAX_INCLUSIVE`
`protected static double`	`PARAGRAPH_SPACE_MIN_INCLUSIVE`
`double`	`paragraphEndIndent`
`double`	`paragraphSpaceAfter`
`double`	`paragraphSpaceBefore`
`double`	`paragraphStartIndent`
`protected Map<String,ITextNode>`	`properties` This node's child property nodes.
`String`	`tabStops`
`TextAlign`	`textAlign`
`TextAlign`	`textAlignLast`
`double`	`textAlpha`
`protected Map<String,String>`	`textAttributes` The attributes set on this node.
`TextDecoration`	`textDecoration`
`double`	`textIndent`
`protected static double`	`TEXTINDENT_MAX_INCLUSIVE`
`protected static double`	`TEXTINDENT_MIN_INCLUSIVE`
`TextJustify`	`textJustify`
`TextRotation`	`textRotation`
`protected static double`	`TRACKING_MAX_INCLUSIVE`
`protected static double`	`TRACKING_MIN_INCLUSIVE`
`double`	`trackingLeft`
`double`	`trackingRight`
`TypographicCase`	`typographicCase`
`VerticalAlign`	`verticalAlign`
`WhiteSpaceCollapse`	`whiteSpaceCollapse`
`double`	`width`

Fields inherited from class org.apache.flex.compiler.internal.fxg.dom.GraphicContentNode
alpha, alphaSet, blendMode, colorTransform, filters, id, isPartofClipMask, luminosityClip, luminosityInvert, mask, maskType, maskTypeSet, matrix, rotation, rotationSet, scaleSet, scaleX, scaleY, translateSet, visible, x, y

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

RichTextNode()

Constructors
Constructor and Description
`RichTextNode()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(IFXGNode child, Collection<ICompilerProblem> problems)` This method is invoked for only non-content children.
`void`	`addContentChild(IFXGNode child, Collection<ICompilerProblem> problems)` <RichText> content allows child <p>, <span> and <br /> tags, as well as character data (text content).
`void`	`addTextProperty(String propertyName, ITextNode node, Collection<ICompilerProblem> problems)` A RichText node can also have special child property nodes that represent complex property values that cannot be set via a simple attribute.
`List<IFXGNode>`	`getChildren()` debug method, do not use
`String`	`getNodeName()`
`Map<String,String>`	`getTextAttributes()`
`List<ITextNode>`	`getTextChildren()`
`Map<String,ITextNode>`	`getTextProperties()`
`protected void`	`rememberAttribute(String name, String value)` Remember that an attribute was set on this node.
`void`	`setAttribute(String name, String value, Collection<ICompilerProblem> problems)` Sets an FXG attribute on this RichText node.

Methods inherited from class org.apache.flex.compiler.internal.fxg.dom.GraphicContentNode
convertTransformAttrToMatrix, createGraphicContext, getId, getLuminosityClip, getLuminosityInvert, getMask, getMaskType, parseBlendMode, setId, setParentGraphicContext

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.internal.fxg.dom.ITextNode
getId, setId

Methods inherited from interface org.apache.flex.compiler.fxg.dom.IFXGNode
getDocumentNode, getDocumentPath, getEndColumn, getEndLine, 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
  - PADDING_MIN_INCLUSIVE
```
protected static final double PADDING_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - PADDING_MAX_INCLUSIVE
```
protected static final double PADDING_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - BASELINEOFFSET_MIN_INCLUSIVE
```
protected static final double BASELINEOFFSET_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - BASELINEOFFSET_MAX_INCLUSIVE
```
protected static final double BASELINEOFFSET_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - BASELINESHIFT_MIN_INCLUSIVE
```
protected static final double BASELINESHIFT_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - BASELINESHIFT_MAX_INCLUSIVE
```
protected static final double BASELINESHIFT_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNCOUNT_MIN_INCLUSIVE
```
protected static final int COLUMNCOUNT_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNCOUNT_MAX_INCLUSIVE
```
protected static final int COLUMNCOUNT_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNGAP_MIN_INCLUSIVE
```
protected static final double COLUMNGAP_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNGAP_MAX_INCLUSIVE
```
protected static final double COLUMNGAP_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNWIDTH_MIN_INCLUSIVE
```
protected static final double COLUMNWIDTH_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - COLUMNWIDTH_MAX_INCLUSIVE
```
protected static final double COLUMNWIDTH_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - LINEHEIGHT_PERCENT_MIN_INCLUSIVE
```
protected static final double LINEHEIGHT_PERCENT_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - LINEHEIGHT_PERCENT_MAX_INCLUSIVE
```
protected static final double LINEHEIGHT_PERCENT_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - LINEHEIGHT_PIXEL_MIN_INCLUSIVE
```
protected static final double LINEHEIGHT_PIXEL_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - LINEHEIGHT_PIXEL_MAX_INCLUSIVE
```
protected static final double LINEHEIGHT_PIXEL_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - PARAGRAPH_INDENT_MIN_INCLUSIVE
```
protected static final double PARAGRAPH_INDENT_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - PARAGRAPH_INDENT_MAX_INCLUSIVE
```
protected static final double PARAGRAPH_INDENT_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - PARAGRAPH_SPACE_MIN_INCLUSIVE
```
protected static final double PARAGRAPH_SPACE_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - PARAGRAPH_SPACE_MAX_INCLUSIVE
```
protected static final double PARAGRAPH_SPACE_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - TEXTINDENT_MIN_INCLUSIVE
```
protected static final double TEXTINDENT_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - TEXTINDENT_MAX_INCLUSIVE
```
protected static final double TEXTINDENT_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - TRACKING_MIN_INCLUSIVE
```
protected static final double TRACKING_MIN_INCLUSIVE
```
    See Also:
    Constant Field Values
  - TRACKING_MAX_INCLUSIVE
```
protected static final double TRACKING_MAX_INCLUSIVE
```
    See Also:
    Constant Field Values
  - width
```
public double width
```
  - height
```
public double height
```
  - blockProgression
```
public BlockProgression blockProgression
```
  - paddingLeft
```
public NumberInherit paddingLeft
```
  - paddingRight
```
public NumberInherit paddingRight
```
  - paddingTop
```
public NumberInherit paddingTop
```
  - paddingBottom
```
public NumberInherit paddingBottom
```
  - lineBreak
```
public LineBreak lineBreak
```
  - columnGap
```
public NumberInherit columnGap
```
  - columnCount
```
public NumberAuto columnCount
```
  - columnWidth
```
public NumberAuto columnWidth
```
  - firstBaselineOffset
```
public BaselineOffset firstBaselineOffset
```
  - verticalAlign
```
public VerticalAlign verticalAlign
```
  - textAlign
```
public TextAlign textAlign
```
  - textAlignLast
```
public TextAlign textAlignLast
```
  - textIndent
```
public double textIndent
```
  - paragraphStartIndent
```
public double paragraphStartIndent
```
  - paragraphEndIndent
```
public double paragraphEndIndent
```
  - paragraphSpaceBefore
```
public double paragraphSpaceBefore
```
  - paragraphSpaceAfter
```
public double paragraphSpaceAfter
```
  - direction
```
public Direction direction
```
  - justificationRule
```
public JustificationRule justificationRule
```
  - justificationStyle
```
public JustificationStyle justificationStyle
```
  - textJustify
```
public TextJustify textJustify
```
  - leadingModel
```
public LeadingModel leadingModel
```
  - tabStops
```
public String tabStops
```
  - fontFamily
```
public String fontFamily
```
  - fontSize
```
public double fontSize
```
  - fontStyle
```
public FontStyle fontStyle
```
  - fontWeight
```
public FontWeight fontWeight
```
  - kerning
```
public Kerning kerning
```
  - lineHeight
```
public double lineHeight
```
  - textDecoration
```
public TextDecoration textDecoration
```
  - lineThrough
```
public boolean lineThrough
```
  - color
```
public int color
```
  - textAlpha
```
public double textAlpha
```
  - whiteSpaceCollapse
```
public WhiteSpaceCollapse whiteSpaceCollapse
```
  - backgroundAlpha
```
public NumberInherit backgroundAlpha
```
  - backgroundColor
```
public ColorWithEnum backgroundColor
```
  - baselineShift
```
public BaselineShift baselineShift
```
  - breakOpportunity
```
public BreakOpportunity breakOpportunity
```
  - digitCase
```
public DigitCase digitCase
```
  - digitWidth
```
public DigitWidth digitWidth
```
  - dominantBaseline
```
public DominantBaseline dominantBaseline
```
  - alignmentBaseline
```
public AlignmentBaseline alignmentBaseline
```
  - ligatureLevel
```
public LigatureLevel ligatureLevel
```
  - locale
```
public String locale
```
  - typographicCase
```
public TypographicCase typographicCase
```
  - trackingLeft
```
public double trackingLeft
```
  - trackingRight
```
public double trackingRight
```
  - textRotation
```
public TextRotation textRotation
```
  - linkNormalFormat
```
public TextLayoutFormatNode linkNormalFormat
```
  - linkHoverFormat
```
public TextLayoutFormatNode linkHoverFormat
```
  - linkActiveFormat
```
public TextLayoutFormatNode linkActiveFormat
```
  - textAttributes
```
protected Map<String,String> textAttributes
```
    The attributes set on this node.
  - content
```
protected List<ITextNode> content
```
    This node's child text nodes.
  - properties
```
protected Map<String,ITextNode> properties
```
    This node's child property nodes.
- Constructor Detail
  - RichTextNode
```
public RichTextNode()
```
- Method Detail
  - getTextAttributes
```
public Map<String,String> getTextAttributes()
```
    Specified by:
    
    getTextAttributes in interface ITextNode
    
    Returns:
    A Map recording the attribute names and values set on this text node.
  - getTextChildren
```
public List<ITextNode> getTextChildren()
```
    Specified by:
    
    getTextChildren in interface ITextNode
    
    Returns:
    The List of child nodes of this text node.
  - getTextProperties
```
public Map<String,ITextNode> getTextProperties()
```
    Specified by:
    
    getTextProperties in interface ITextNode
    
    Returns:
    The List of child property nodes of this text node.
  - addTextProperty
```
public void addTextProperty(String propertyName,
                   ITextNode node,
                   Collection<ICompilerProblem> problems)
```
    A RichText node can also have special child property nodes that represent complex property values that cannot be set via a simple attribute.
    
    Specified by:
    
    addTextProperty in interface ITextNode
    
    Parameters:
    propertyName - - the property's local name
    node - - the value node
    problems - problems to collect
  - addContentChild
```
public void addContentChild(IFXGNode child,
                   Collection<ICompilerProblem> problems)
```
    <RichText> content allows child <p>, <span> and <br /> tags, as well as character data (text content).
    
    Parameters:
    child - - a child FXG node to be added to this node.
    problems - problem collection used to collect problems occurred within this method
  - rememberAttribute
```
protected void rememberAttribute(String name,
                     String value)
```
    Remember that an attribute was set on this node.
    
    Parameters:
    name - - the unqualified attribute name.
    value - - the attribute value.
  - addChild
```
public void addChild(IFXGNode child,
            Collection<ICompilerProblem> problems)
```
    This method is invoked for only non-content children.
    
    Specified by:
    
    addChild in interface IFXGNode
    
    Overrides:
    
    addChild in class GraphicContentNode
    
    Parameters:
    child - - a child FXG node to be added to this node.
    problems - problem collection used to collect problems occurred within this method
  - getChildren
```
public List<IFXGNode> getChildren()
```
    Description copied from interface: IFXGNode
    
    debug method, do not use
    
    Specified by:
    
    getChildren in interface IFXGNode
    
    Overrides:
    
    getChildren in class GraphicContentNode
    
    Returns:
    a list of the children of this node
  - getNodeName
```
public String getNodeName()
```
    Specified by:
    
    getNodeName in interface IFXGNode
    
    Returns:
    The unqualified name of a RichText node, without tag markup.
  - setAttribute
```
public void setAttribute(String name,
                String value,
                Collection<ICompilerProblem> problems)
```
    Sets an FXG attribute on this RichText node. In addition to the attributes supported by all graphic content nodes, RichText supports the following attributes.
    - width (Number): The width of the text box to render text in.
    - height (Number): The height of the text box to render text in.
    - paddingLeft (Number): Inset from left edge to content area. Units in pixels, defaults to 0.
    - paddingRight (Number): Inset from right edge to content area. Units in pixels, defaults to 0.
    - paddingTop (Number): Inset from top edge to content area. Units in pixels, defaults to 0.
    - paddingBottom (Number): Inset from bottom edge to content area. Units in pixels, defaults to 0.
    Specified by:
    
    setAttribute in interface IFXGNode
    
    Overrides:
    
    setAttribute in class GraphicContentNode
    
    Parameters:
    name - - the unqualified attribute name.
    value - - the attribute value.
    problems - problem collection used to collect problems occurred within this method

Class RichTextNode

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flex.compiler.internal.fxg.dom.ITextNode

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

Field Detail

FONTSIZE_MIN_INCLUSIVE

FONTSIZE_MAX_INCLUSIVE

PADDING_MIN_INCLUSIVE

PADDING_MAX_INCLUSIVE

BASELINEOFFSET_MIN_INCLUSIVE

BASELINEOFFSET_MAX_INCLUSIVE

BASELINESHIFT_MIN_INCLUSIVE

BASELINESHIFT_MAX_INCLUSIVE

COLUMNCOUNT_MIN_INCLUSIVE

COLUMNCOUNT_MAX_INCLUSIVE

COLUMNGAP_MIN_INCLUSIVE

COLUMNGAP_MAX_INCLUSIVE

COLUMNWIDTH_MIN_INCLUSIVE

COLUMNWIDTH_MAX_INCLUSIVE

LINEHEIGHT_PERCENT_MIN_INCLUSIVE

LINEHEIGHT_PERCENT_MAX_INCLUSIVE

LINEHEIGHT_PIXEL_MIN_INCLUSIVE

LINEHEIGHT_PIXEL_MAX_INCLUSIVE

PARAGRAPH_INDENT_MIN_INCLUSIVE

PARAGRAPH_INDENT_MAX_INCLUSIVE

PARAGRAPH_SPACE_MIN_INCLUSIVE

PARAGRAPH_SPACE_MAX_INCLUSIVE

TEXTINDENT_MIN_INCLUSIVE

TEXTINDENT_MAX_INCLUSIVE

TRACKING_MIN_INCLUSIVE

TRACKING_MAX_INCLUSIVE

width

height

blockProgression

paddingLeft

paddingRight

paddingTop

paddingBottom

lineBreak

columnGap

columnCount

columnWidth

firstBaselineOffset

verticalAlign

textAlign

textAlignLast

textIndent

paragraphStartIndent

paragraphEndIndent

paragraphSpaceBefore

paragraphSpaceAfter

direction

justificationRule

justificationStyle

textJustify

leadingModel

tabStops

fontFamily

fontSize

fontStyle

fontWeight

kerning

lineHeight

textDecoration

lineThrough

color

textAlpha

whiteSpaceCollapse

backgroundAlpha

backgroundColor

baselineShift

breakOpportunity

digitCase