Child pages
  • XMLList

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
attribute(attributeName)
It calls the method attribute of each object in this XMLList and returns the results in order
in an XMLList.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
attributes()
Calls the method attributes of each object in this XMLList and returns an XMLList with
the results in order.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
child(propertyName)
Calls the method child of each XML object in this XMLList object to return an XMLList
with the matching children in order.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
children()
Returns an XMLList with the children of all XML objects in this XMLList.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
comments()
Returns an XMLList with all the comment child nodes of XML objects in this XMLList in order.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
contains(value)
Returns true if there is (at least) one XML object in the list that compares equal to the value
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
copy()
Returns a deep copy of the XMLList it is called on.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
descendants()
Returns an XMLList with all of the matching descendants of all XML objects.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
descendants(name)
Returns an XMLList with all of the matching descendants of all XML objects.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
elements(name)
Returns an XMLList with the matching element children of all XML objects in this XMLList.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
hasComplexContent()
Returns true if the XMLList contains exactly one XML object which has complex content or if
the XMLList contains several XML objects.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
hasOwnProperty(propertyName)
Returns true if the XMLList object has a property of that name and false otherwise.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
hasSimpleContent()
Returns true if the XMLList is empty or contains exactly one XML object which has simple
content or contains no elements at all.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
length()
Returns the number of XML objects this XMLList contains.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
normalize()
Returns the XMLList object it is called on after joining adjacent text nodes
and removing empty text nodes.
Table Row (tr)
Table Cell (td)
XML
Table Cell (td)
parent()
Returns the common parent of all XML objects in this XMLList if all those objects
have the same parent.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
processingInstructions()
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
processingInstructions(name)
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
propertyIsEnumerable(propertyName)
Returns true if the property name converted to a number is greater than or equal to
0 and less than the length of this XMLList.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
text()
Returns an XMLList containing all the text child nodes of all the XML objects contained in this XMLList.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
toString()
Returns a string representation of the XMLList
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
toXMLString()
Returns the concatenation of toXMLString called on each XML object.
Table Row (tr)
Table Cell (td)
XMLList
Table Cell (td)
valueOf()
Simply returns the XMLList object it is called on.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idattribute-String
Table Row (tr)
idname
Table Cell (td)

attribute

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
attribute
Span
(attributeName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
It calls the method attribute of each object in this XMLList and returns the results in order
in an XMLList.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} attributeName
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.attribute(attributeName)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idattributes
Table Row (tr)
idname
Table Cell (td)

attributes

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
attributes
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Calls the method attributes of each object in this XMLList and returns an XMLList with
the results in order.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.attributes()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idchild-String
Table Row (tr)
idname
Table Cell (td)

child

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
child
Span
(propertyName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Calls the method child of each XML object in this XMLList object to return an XMLList
with the matching children in order.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} propertyName
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.child(propertyName)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idchildren
Table Row (tr)
idname
Table Cell (td)

children

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
children
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with the children of all XML objects in this XMLList.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.children()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcomments
Table Row (tr)
idname
Table Cell (td)

comments

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
comments
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with all the comment child nodes of XML objects in this XMLList in order.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.comments()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcontains-Object
Table Row (tr)
idname
Table Cell (td)

contains

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
contains
Span
(value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if there is (at least) one XML object in the list that compares equal to the value
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} value
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.contains(value)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcopy
Table Row (tr)
idname
Table Cell (td)

copy

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
copy
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a deep copy of the XMLList it is called on.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.copy()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddescendants
Table Row (tr)
idname
Table Cell (td)

descendants

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
descendants
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with all of the matching descendants of all XML objects.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.descendants([name])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddescendants-String
Table Row (tr)
idname
Table Cell (td)

descendants

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
descendants
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with all of the matching descendants of all XML objects.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.descendants([name])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idelements-String
Table Row (tr)
idname
Table Cell (td)

elements

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
elements
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with the matching element children of all XML objects in this XMLList.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.elements([name])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhasComplexContent
Table Row (tr)
idname
Table Cell (td)

hasComplexContent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
hasComplexContent
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the XMLList contains exactly one XML object which has complex content or if
the XMLList contains several XML objects.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.hasComplexContent()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhasOwnProperty-String
Table Row (tr)
idname
Table Cell (td)

hasOwnProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
hasOwnProperty
Span
(propertyName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the XMLList object has a property of that name and false otherwise.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} propertyName
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.hasOwnProperty(propertyName)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhasSimpleContent
Table Row (tr)
idname
Table Cell (td)

hasSimpleContent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
hasSimpleContent
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the XMLList is empty or contains exactly one XML object which has simple
content or contains no elements at all.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.hasSimpleContent()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idlength
Table Row (tr)
idname
Table Cell (td)

length

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
length
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the number of XML objects this XMLList contains.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.length()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnormalize
Table Row (tr)
idname
Table Cell (td)

normalize

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
normalize
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the XMLList object it is called on after joining adjacent text nodes
and removing empty text nodes.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.normalize()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idparent
Table Row (tr)
idname
Table Cell (td)

parent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XML
Span
stylefont-weight: bold;
parent
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the common parent of all XML objects in this XMLList if all those objects
have the same parent.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XML
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.parent()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprocessingInstructions
Table Row (tr)
idname
Table Cell (td)

processingInstructions

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
processingInstructions
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.processingInstructions([name])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprocessingInstructions-String
Table Row (tr)
idname
Table Cell (td)

processingInstructions

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
processingInstructions
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList with all the matching processing instruction child nodes of all
XML objects in this XMLList.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.processingInstructions([name])
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idpropertyIsEnumerable-String
Table Row (tr)
idname
Table Cell (td)

propertyIsEnumerable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
propertyIsEnumerable
Span
(propertyName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the property name converted to a number is greater than or equal to
0 and less than the length of this XMLList.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} propertyName
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.propertyIsEnumerable(propertyName)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtext
Table Row (tr)
idname
Table Cell (td)

text

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
text
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an XMLList containing all the text child nodes of all the XML objects contained in this XMLList.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.text()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtoString
Table Row (tr)
idname
Table Cell (td)

toString

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
toString
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a string representation of the XMLList
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.toString()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtoXMLString
Table Row (tr)
idname
Table Cell (td)

toXMLString

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
toXMLString
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the concatenation of toXMLString called on each XML object. The result for each XML
object is put on a separate line if XML.prettyPrinting is true.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.toXMLString()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idvalueOf
Table Row (tr)
idname
Table Cell (td)

valueOf

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
XMLList
Span
stylefont-weight: bold;
valueOf
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Simply returns the XMLList object it is called on.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
XMLList
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
xmlList.valueOf()
Table Row (tr)
classlastDetailRow
Table Cell (td)