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

Class AbstractRichTextNode

java.lang.Object

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

org.apache.flex.compiler.internal.fxg.dom.richtext.AbstractRichTextNode

All Implemented Interfaces:

IFXGNode, IPreserveWhiteSpaceNode, ITextNode

Direct Known Subclasses:

AbstractRichTextLeafNode

public abstract class AbstractRichTextNode
extends AbstractFXGNode
implements ITextNode

A base class for all FXG nodes concerned with formatted text.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ITextNode>	content This nodes child text nodes.
protected String	id
IFXGNode	parentNode Keep a reference to the parent node.
protected Map<String,String>	textAttributes The attributes set on this node.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(IFXGNode child, Collection<ICompilerProblem> problems) Check child node to ensure that exception isn't thrown for ignorable white spaces.
void	addTextProperty(String propertyName, ITextNode node, Collection<ICompilerProblem> problems) A text node may 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	getId() An id attribute provides a well defined name to a text node.
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 text node.
void	setId(String value) Sets the node id.
void	setParent(IFXGNode parent) Set the parent node.

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

id

protected String id

textAttributes

protected Map<String,String> textAttributes

The attributes set on this node.

content

protected List<ITextNode> content

This nodes child text nodes.

parentNode

public IFXGNode parentNode

Keep a reference to the parent node.

Constructor Detail

AbstractRichTextNode

public AbstractRichTextNode()

Method Detail

getId

public String getId()

An id attribute provides a well defined name to a text node.

Specified by:

getId in interface ITextNode

Returns:

the node id.

setId

public void setId(String value)

Sets the node id.

Specified by:

setId in interface ITextNode

Parameters:

value - - the node id as a String.

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 Map of child property nodes of this text node.

addTextProperty

public void addTextProperty(String propertyName,
                   ITextNode node,
                   Collection<ICompilerProblem> problems)

A text node may 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

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.

setParent

public void setParent(IFXGNode parent)

Set the parent node.

Parameters:

parent - - the parent node.

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 AbstractFXGNode

Returns:

a list of the children of this node

addChild

public void addChild(IFXGNode child,
            Collection<ICompilerProblem> problems)

Check child node to ensure that exception isn't thrown for ignorable white spaces.

Specified by:

addChild in interface IFXGNode

Overrides:

addChild in class AbstractFXGNode

Parameters:

child - - a child FXG node to be added to this node.

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

setAttribute

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

Sets an FXG attribute on this text node.

Specified by:

setAttribute in interface IFXGNode

Overrides:

setAttribute in class AbstractFXGNode

Parameters:

name - - the unqualified attribute name.

value - - the attribute value.

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