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

Interface E4XXMLListFunctions

All Superinterfaces:

JSObjectFunctions

All Known Implementing Classes:

E4XXMLList

public interface E4XXMLListFunctions
extends JSObjectFunctions

Property Summary

Properties inherited from interface org.fife.rsta.ac.js.ecma.api.ecma3.functions.JSObjectFunctions

hasOwnProperty

Method Summary

Modifier and Type	Method and Description
E4XXMLList	attribute(JSString attributeName) function attribute(attributeName) calls the attribute method of each XML object in this XMLList object passing attributeName as a parameter and returns an XMLList containing the results in order.
E4XXMLList	attributes() function attributes() calls the attributes() method of each XML object in this XMLList object and returns an XMLList containing the results in order.
E4XXMLList	child(JSString propertyName) function child(propertyName) calls the child() method of each XML object in this XMLList object and returns an XMLList containing the results in order.
E4XXMLList	children() function children() calls the children() method of each XML object in this XMLList object and returns an XMLList containing the results concatenated in order.
E4XXMLList	comments() function comments() calls the comments method of each XML object in this XMLList object and returns an XMLList containing the results concatenated in order.
JSBoolean	contains(E4XXML value) function contains(value) returns a boolean value indicating whether this XMLList object contains an XML object that compares equal to the given value.
JSBoolean	copy() function copy() returns a deep copy of the XMLList object.
E4XXMLList	descendants(JSString name) function descendants(name) calls the descendants method of each XML object in this XMLList object with the optional parameter name (or the string "*" if name is omitted) and returns an XMLList containing the results concatenated in order.
E4XXMLList	elements(JSString name) function elements(name) calls the elements method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order.
JSBoolean	hasComplexContent() function hasComplexContent() returns a Boolean value indicating whether this XMLList object contains complex content.
JSBoolean	hasSimpleContent() function hasSimpleContent() returns a Boolean value indicating whether this XMLList contains simple content.
JSNumber	length() function length() returns the number of properties in this XMLList object.
E4XXMLList	normalize() function normalize() puts all text nodes in this XMLList, all the XML objects it contains and the descendents of all the XML objects it contains into a normal form by merging adjacent text nodes and eliminating empty text nodes.
E4XXML	parent() function parent() If all items in this XMLList object have the same parent, it is returned.
E4XXMLList	processingInstructions(JSString name) function processingInstructions(name) calls the processingInstructions method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order.
E4XXMLList	text() function text() calls the text method of each XML object contained in this XMLList object and returns an XMLList containing the results concatenated in order.
JSString	toXMLString() function toXMLString() returns the toXMLString() method returns an XML encoded string representation of this XML object.

Methods inherited from interface org.fife.rsta.ac.js.ecma.api.ecma3.functions.JSObjectFunctions

hasOwnProperty, isPrototypeOf, propertyIsEnumerable, toLocaleString, toString, valueOf

Method Detail

attribute

E4XXMLList attribute(JSString attributeName)

function attribute(attributeName) calls the attribute method of each XML object in this XMLList object passing attributeName as a parameter and returns an XMLList containing the results in order.

Parameters:

attributeName - name of attribute to find.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.attribute();

attributes

E4XXMLList attributes()

function attributes() calls the attributes() method of each XML object in this XMLList object and returns an XMLList containing the results in order.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.attributes();

child

E4XXMLList child(JSString propertyName)

function child(propertyName) calls the child() method of each XML object in this XMLList object and returns an XMLList containing the results in order.

Parameters:

propertyName - name of XML element to find.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.child();

children

E4XXMLList children()

function children() calls the children() method of each XML object in this XMLList object and returns an XMLList containing the results concatenated in order.

Example

 // get all the children of all the items in the order
 var allitemchildren = order.item.children();
 
 // get all grandchildren of the order that have the name price
 var grandChildren = order.children().price;
 

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.children();

comments

E4XXMLList comments()

function comments() calls the comments method of each XML object in this XMLList object and returns an XMLList containing the results concatenated in order.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.comments();

contains

JSBoolean contains(E4XXML value)

function contains(value) returns a boolean value indicating whether this XMLList object contains an XML object that compares equal to the given value.

Parameters:

value - XML object to test.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

copy

JSBoolean copy()

function copy() returns a deep copy of the XMLList object.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

descendants

E4XXMLList descendants(JSString name)

function descendants(name) calls the descendants method of each XML object in this XMLList object with the optional parameter name (or the string "*" if name is omitted) and returns an XMLList containing the results concatenated in order.

Parameters:

name - optional parameter to identity the decendants. If omitted all decendants are returned.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.descendants();

elements

E4XXMLList elements(JSString name)

function elements(name) calls the elements method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order.

Parameters:

name - optional parameter to identity the element. If omitted all children are returned.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.elements();

hasComplexContent

JSBoolean hasComplexContent()

function hasComplexContent() returns a Boolean value indicating whether this XMLList object contains complex content. An XMLList object is considered to contain complex content if it is not empty, contains a single XML item with complex content or contains elements.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

hasSimpleContent

JSBoolean hasSimpleContent()

function hasSimpleContent() returns a Boolean value indicating whether this XMLList contains simple content. An XMLList object is considered to contain simple content if it is empty, contains a single XML item with simple content or contains no elements.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

length

JSNumber length()

function length() returns the number of properties in this XMLList object.

Example

 for (var i = 0; i < e..name.length(); i++) {
   print("Employee name:" + e..name[i]);
 }
 

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

normalize

E4XXMLList normalize()

function normalize() puts all text nodes in this XMLList, all the XML objects it contains and the descendents of all the XML objects it contains into a normal form by merging adjacent text nodes and eliminating empty text nodes.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

parent

E4XXML parent()

function parent() If all items in this XMLList object have the same parent, it is returned. Otherwise, the parent method returns undefined.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList

processingInstructions

E4XXMLList processingInstructions(JSString name)

function processingInstructions(name) calls the processingInstructions method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order.

Parameters:

name - optional node name filter.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.processingInstructions();

text

E4XXMLList text()

function text() calls the text method of each XML object contained in this XMLList object and returns an XMLList containing the results concatenated in order.

Returns:

an XMLList containing the results concatenated in order.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList, XML.text();

toXMLString

JSString toXMLString()

function toXMLString() returns the toXMLString() method returns an XML encoded string representation of this XML object. Unlike the toString method, toXMLString provides no special treatment for XML objects that contain only XML text nodes (i.e., primitive values). The toXMLString method always includes the start tag, attributes and end tag of the XML object regardless of its content. It is provided for cases when the default XML to string conversion rules are not desired.

Returns:

Serializes this XML object as parseable XML.

Since:

Standard ECMA-357 2nd. Edition

See Also:

XMLList