fxElement interface

This returns the first child node found within the node in the following order. Augmenation Before, Augmentation References, children, Augmenation After. Otherwise, this returns null.

augFirstChild
Access	read-only
Returns	Node

This returns the last child node found within the node in the following order. Augmenation After, children, Augmentation References, Augmenation Before. Otherwise, this returns null.

augLastChild
Access	read-only
Returns	Node

This returns the node logically following this node within it's parent, including augmentation. The logical order is: Augmenation Before, Augmentation References, children, Augmenation After. Otherwise, this returns null.

augNextSibling
Access	read-only
Returns	Node

The parent of this node. If this node is at the root of augmentation, this returns the Node the augmentation is attached. Otherwise this returns the normal parent.

augParentNode
Access	read-only
Returns	Node

This returns the node logically preceding this node within it's parent, including augmentation. The logical order is: Augmenation After, children, Augmentation References, Augmenation Before. Otherwise, this returns null.

augPreviousSibling
Access	read-only
Returns	Node

This property adds additional support for DOMs attached to a fTag.TYPE_XML_TREE type stream which has augmentation enabled.

If this node is within augmentation, this returns the Node which was used as the primary reference for this node. This will usually be the Node in which the augmenation is attached. If created to replace a matching context, this returns the node which matched. Otherwise, this returns itself.

augRefererNode
Access	read-only
Returns	Node

endContent
Access	read-only
Returns	int

endPosition
Access	read-only
Returns	int

extendedNodeType
Access	read-only
Returns	unsigned short

This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This returns an int representing the Augmentation present on the current node, see fxNode.AugmentationType.

hasAugmentation
Access	read-only
Returns	int

namespaceDefinitions
Access	read-only
Returns	fArray

namespacesInScope
Access	read-only
Returns	fArray

nodeNumber
Access	read-only
Returns	int

significantWhitespace
Access	read-only
Returns	int

startContent
Access	read-only
Returns	int

startPosition
Access	read-only
Returns	int

validAttributes
Access	read-only
Returns	String

validContent
Access	read-only
Returns	String

This property adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This returns true if the current node is within augmenation of an ancestor.

withinAugmentation
Access	read-only
Returns	boolean

augSerializecontentOnlyprettyPrint
Parameters	booleancontentOnly If false (the default), the name and attributes of the node are included in the serialization. If true, the name and attributes of the node are omitted. In both cases, all information from the nodes children is included booleanprettyPrint If true, will format the serialized augmented node. If contentOnly is true, then it will not format the augmented node.
Returns	String. The serialized version of the augmented node.

This method adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This method will clone the provided Node into the Augment After position. Any existing Augmentation will be removed.

augmentAfternode
Parameters	Nodenode The Node to set as the Augmentation After, or null to remove.
Returns	Node. The Node that was created for the augmentation.

This method adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This method will clone the provided Node into the Augmentation Before position. Any existing Augmentation will be removed.

augmentBeforenode
Parameters	Nodenode The Node to set as the Augmentation Before or null to remove.
Returns	Node. The Node that was created for the augmentation

This method adds additional support for DOMs attached to an fTag.TYPE_XML_TREE stream. This method will create internal PIs between the Augmentation Before and the normal children of the node. These A3B2T PIs will result in APP calling the referenced Tag directly during formatting.

augmentReferencereferencemode
Parameters	Stringreference The reference text to use on the PI. e.g. 'resetCounter counter="test"'. intmode The mode to handle the reference. If 0, the reference is prepended to the internal reference list. If 1, the reference is appended to the internal reference list. If 2, the reference is removed from the internal reference list.
Returns	Node. The Node that was created for the augmentation.

evaluateXPathexpression
Parameters	Stringexpression The XPath expression string to be parsed and evaluated.
Returns	XPathResult. The result of the evaluation of the XPath expression.
Throws	XPathException INVALID_EXPRESSION_ERR: Raised if the expression is not legal according to the rules of the XPathEvaluator.

Returns the language at this element. The language is determined by the nearest ancestor or self language attribute set. See attributes defaultLanguage amd languageAttrName and the setLanguageMapping method on fxDocument for configuration of language determination.

getLanguage
Parameters	None
Returns	String. The language.

getNodePathmode
Parameters	intmode If not specified, or 0, the returned path uses expanded local-name and namespace-uri syntax for elements within namespaces. If 1, the returned path uses the specifed prefix on elements within a namespace. mode 0: /document/chapter[1]/section[5]/node()[ local-name()="title" and namespace-uri()="URN:example:urn" ] mode 1: /document/chapter[1]/section[5]/ex:title
Returns	String. Returns the absolute location path to this xmlNode.

getPage
Parameters	None
Returns	fPage

Retrieves the string associated to a key on the xmlNode. The string must first have been set to this node by calling setUserString with the same key.

getUserStringkey
Parameters	Stringkey The key to the associated string.
Returns	String. The userString associated to the given key on this xmlNode, or NULL if there was none.

Used to search for the base URI for this xmlNode. It does not return the base URI for the document.

getXmlBase
Parameters	None
Returns	String. Returns the base URI string.

The default definition. This function normally searches for the language of the xmlElement node. This can not be set for the base xmlNode - the relevant derived class will redefine this function to set it.

getXmlLang
Parameters	None
Returns	String. In the default definition, returns an empty string.

The default definition. This function normally searches for the space preserving behaviour of an xmlElement. This can not be set for the base xmlNode - the relevant derived classes will redefine this function to set it.

getXmlSpace
Parameters	None
Returns	String. In the default definition, returns -1.

hasNamespacesInScope
Parameters	None
Returns	booleantrue if this node has a list of namespaces, false otherwise.

Returns the URI associated with the prefix passed in. If the prefix is not associated with a namespace, or a prefix is not passed in, the method returns null.

lookupNamespacePrefixprefix
Parameters	Stringprefix The prefix to search for.
Returns	String. Returns the associated namespace URI or null if none is found.

serializecontentOnlyprettyPrint
Parameters	booleancontentOnly If false (the default), the name and attributes of the node are included in the serialization. If true, the name and attributes of the node are omitted. In both cases, all information from the nodes children is included booleanprettyPrint If true, will format the serialized node. If contentOnly is true, then it will not format the node.
Returns	String. The serialized version of the node.

setUserStringkeydata
Parameters	Stringkey The key to associate the string to. Stringdata The string to associate to the given key, or NULL to remove any existing association to that key
Returns	String. The string previously associated to the given key on this node, or NULL if there was none.