Class E4XXML

java.lang.Object

org.fife.rsta.ac.js.ecma.api.e4x.E4XXML

All Implemented Interfaces:

E4XXMLFunctions, JSObjectFunctions

public abstract class E4XXML
extends Object
implements E4XXMLFunctions

Object XML

Since:

Standard ECMA-357 2nd. Edition

Field Summary

Fields

Modifier and Type	Field	Description
protected JSFunction	constructor	property constructor
static JSBoolean	ignoreProcessingInstructions	property ignoreProcessingInstructions The initial value of the ignoreProcessingInstructions property is true.
static JSBoolean	ignoreWhitespace	property ignoreWhitespace The initial value of the ignoreWhitespace property is true.
static JSBoolean	ignoringComments	property ignoringComments The initial value of the ignoreComments property is true.
static JSNumber	prettyIndent	property prettyIndent The initial value of the prettyIndent property is 2.
static JSBoolean	prettyPrinting	property prettyPrinting The initial value of the prettyPrinting property is true.
E4XXML	protype	property prototype

Constructor Summary

Constructors

Constructor	Description
E4XXML(JSObject xml)	Object XML(xml)

Method Summary

Modifier and Type	Method	Description
static JSObject	defaultSettings()	function defaultSettings() The defaultSettings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.
static void	setSettings(JSObject settings)	function setSetting(settings) The setSettings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.
static JSObject	settings()	function settings() The settings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.

Methods inherited from class Object

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

Methods inherited from interface E4XXMLFunctions

addNamespace, appendChild, attribute, attributes, child, child, childIndex, children, comments, contains, contains, copy, descendants, elements, hasComplexContent, hasSimpleContent, inScopeNamespaces, insertChildAfter, insertChildBefore, length, localName, name, namespace, namespaceDeclarations, nodeKind, normalize, parent, prependChild, processingInstructions, removeNamespace, replace, replace, setChildren, setChildren, setLocalName, setName, setNamespace, text, toXMLString

Methods inherited from interface JSObjectFunctions

hasOwnProperty, isPrototypeOf, propertyIsEnumerable, toLocaleString, toString, valueOf

Field Details

protype

public E4XXML protype

property prototype

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

constructor

protected JSFunction constructor

property constructor

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

ignoringComments

public static JSBoolean ignoringComments

property ignoringComments The initial value of the ignoreComments property is true. If ignoreComments is true, XML comments are ignored when constructing new XML objects.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

ignoreProcessingInstructions

public static JSBoolean ignoreProcessingInstructions

property ignoreProcessingInstructions The initial value of the ignoreProcessingInstructions property is true. If ignoreProcessingInstructions is true, XML processing instructions are ignored when constructing new XML objects.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

ignoreWhitespace

public static JSBoolean ignoreWhitespace

property ignoreWhitespace The initial value of the ignoreWhitespace property is true. If ignoreWhitespace is true, insignificant whitespace characters are ignored when processing constructing new XML objects.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

prettyPrinting

public static JSBoolean prettyPrinting

property prettyPrinting The initial value of the prettyPrinting property is true. If prettyPrinting is true, the ToString and ToXMLString operators will normalize whitespace characters between certain tags to achieve a uniform and aesthetic appearance.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

prettyIndent

public static JSNumber prettyIndent

property prettyIndent The initial value of the prettyIndent property is 2. If the prettyPrinting property of the XML constructor is true, the ToString and ToXMLString operators will normalize whitespace characters between certain tags to achieve a uniform and aesthetic appearance. Certain child nodes will be indented relative to their parent node by the number of spaces specified by prettyIndent.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

Constructor Details

E4XXML

public E4XXML(JSObject xml)

Object XML(xml)

Parameters:

xml - The XML definition

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

Method Details

settings

public static JSObject settings()

function settings() The settings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.

Example

// Create a general purpose function that may need to save and restore XML settings
function getXMLCommentsFromString(xmlString) {
  // save previous XML settings and make sure comments are not ignored
  var settings = XML.settings();
  XML.ignoreComments = false;
  var comments = XML(xmlString).comment();
  // restore settings and return result
  XML.setSettings(settings);
  return comments;
}

Returns:

an object containing the properties of the XML constructor used for storing XML settings.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

setSettings

public static void setSettings(JSObject settings)

function setSetting(settings) The setSettings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML

defaultSettings

public static JSObject defaultSettings()

function defaultSettings() The defaultSettings method is a convenience method for managing the collection of global XML settings stored as properties of the XML constructor.

Since:

Standard ECMA-357 2nd. Edition, Level 3 Document Object Model Core Definition.

See Also:

• XML