mx.collections.XMLListCollection - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.collections
Class	public class XMLListCollection
Inheritance	XMLListCollection ListCollectionView Proxy Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The XMLListCollection class provides collection functionality to an XMLList object and makes available some of the methods of the native XMLList class.

MXML Syntax expanded

Hide MXML Syntax

The <mx:XMLListCollection> tag inherits all the attributes of its superclass, and adds the following attributes:

  <mx:XMLListCollection
  Properties
  source="null"
  />

Default MXML Propertysource

See also

XMLList
XML

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		filterFunction : Function A function that the view will use to eliminate items that do not match the function's criteria.	ListCollectionView
		length : int [read-only] The number of items in this view.	ListCollectionView
		list : IList The IList that this collection view wraps.	ListCollectionView
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		sort : Sort The Sort that will be applied to the ICollectionView.	ListCollectionView
		source : XMLList The underlying XMLList for this collection.	XMLListCollection

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		localIndex : Array When the view is sorted or filtered the localIndex property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order.	ListCollectionView

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		XMLListCollection(source:XMLList = null) Constructor.	XMLListCollection
		addAll(addList:IList):void Adds a list of items to the current list, placing them at the end of the list in the order they are passed.	ListCollectionView
		addAllAt(addList:IList, index:int):void Adds a list of items to the current list, placing them at the position index passed in to the function.	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ListCollectionView
		addItem(item:Object):void Adds the specified item to the end of the list.	ListCollectionView
		addItemAt(item:Object, index:int):void Adds the item at the specified index.	ListCollectionView
		attribute(attributeName:Object):XMLList Calls the attribute() method of each XML object in the XMLList and returns an XMLList of the results, which match the given attributeName.	XMLListCollection
		attributes():XMLList Calls the attributes() method of each XML object in the XMLList object and returns an XMList of attributes for each XML object.	XMLListCollection
		child(propertyName:Object):XMLList Calls the child() method of each XML object in the XMLList and returns an XMLList containing the children of with the specified property name, in order.	XMLListCollection
		children():XMLList Calls the children() method of each XML object in the XMLList and returns an XMLList containing the results.	XMLListCollection
		contains(item:Object):Boolean Returns whether the view contains the specified object.	ListCollectionView
		copy():XMLList Returns a deep copy of the XMLList object.	XMLListCollection
		createCursor():IViewCursor Creates a new IViewCursor that works with this view.	ListCollectionView
		descendants(name:Object = *):XMLList Calls the descendants() method of each XML object in the XMLList and returns an XMLList containing the results.	XMLListCollection
		disableAutoUpdate():void Prevents changes to the collection itself and items within the collection from being dispatched by the view.	ListCollectionView
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ListCollectionView
		elements(name:String = "*"):XMLList Calls the elements() method of each XML object in the XMLList.	XMLListCollection
		enableAutoUpdate():void Enables auto-updating.	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object Gets the item at the specified index.	ListCollectionView
		getItemIndex(item:Object):int Returns the index of the item if it is in the list such that getItemAt(index) == item.	ListCollectionView
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ListCollectionView
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.	ListCollectionView
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Notifies the view that an item has been updated.	ListCollectionView
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		refresh():Boolean Applies the sort and filter to the view.	ListCollectionView
		removeAll():void Remove all items from the list.	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ListCollectionView
		removeItemAt(index:int):Object Removes the item at the specified index and returns it.	ListCollectionView
		setItemAt(item:Object, index:int):Object Places the item at the specified index.	ListCollectionView
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		text():XMLList Calls the text() method of each XML object in the XMLList and returns an XMLList containing the results.	XMLListCollection
		toArray():Array Returns an Array that is populated in the same order as the IList implementation.	ListCollectionView
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string representation of the XMLList by calling the toString() method for each XML object in the XMLList.	XMLListCollection
		toXMLString():String Returns a string representation of the XMLList by calling the toXMLString() method for each XML object in the XMLList.	XMLListCollection
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	ListCollectionView

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		collectionChange	Dispatched when the ICollectionView has been updated in some way.	ListCollectionView

Property Detail

source

property

source:XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The underlying XMLList for this collection. The XMLListCollection object does not represent any changes that you make directly to the source XMLList object. Always use the XMLListCollection methods to modify the collection.

This property can be used as the source for data binding. When this property is modified, it dispatches the listChanged event.

Implementation
public function get source():XMLList
public function set source(value:XMLList):void

Constructor Detail

XMLListCollection

()

Constructor

public function XMLListCollection(source:XMLList = null)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Creates a new XMLListCollection object using the specified XMLList object.

Parameters

source:XMLList (default = null) — The XMLList object containing the data to be represented by the XMLListCollection object.

Method Detail

attribute

()

method

public function attribute(attributeName:Object):XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the attribute() method of each XML object in the XMLList and returns an XMLList of the results, which match the given attributeName.

Parameters

attributeName:Object — The attribute that you want to match in the XML objects of the XMLList.

Returns

XMLList — The XMLList of matching XML objects.

See also

XML.attribute()

attributes

()

method

public function attributes():XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the attributes() method of each XML object in the XMLList object and returns an XMList of attributes for each XML object.

Returns

XMLList — The XMLList containing the resulting XML objects, listing the attributes.

See also

XML.attributes()

child

()

method

public function child(propertyName:Object):XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the child() method of each XML object in the XMLList and returns an XMLList containing the children of with the specified property name, in order.

Parameters

propertyName:Object — The propery to match.

Returns

XMLList — An XMLList of matching children of the XML objects in the original XMLList.

See also

XML.child()

children

()

method

public function children():XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the children() method of each XML object in the XMLList and returns an XMLList containing the results.

Returns

XMLList — An XMLList of children of the XML objects in the original XMLList.

See also

XML.children()

copy

()

method

public function copy():XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a deep copy of the XMLList object.

Returns

XMLList — The copy of the XMLList object.

descendants

()

method

public function descendants(name:Object = *):XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the descendants() method of each XML object in the XMLList and returns an XMLList containing the results. The name parameter is passed to the XML object's descendants() method. If you do not specify a parameter, the string "*" is passed to the descendants() method.

Parameters

name:Object (default = *) — The name of the elements to match.

Returns

XMLList — XMLList of the matching descendents (children, grandchildren, etc.) of the XML objects in the original XMLList.

See also

XML.descendants()

elements

()

method

public function elements(name:String = "*"):XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the elements() method of each XML object in the XMLList. The name parameter is passed to the XML object's elements() method. If you do not specify a parameter, the string "*" is passed to the elements() method.

Parameters

name:String (default = "*") — The name of the elements to match.

Returns

XMLList — XMLList of the matching child elements of the XML objects in the original XMLList.

See also

XML.elements()

text

()

method

public function text():XMLList

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Calls the text() method of each XML object in the XMLList and returns an XMLList containing the results.

Returns

XMLList — The XMLList that contains the result.

See also

XML.text()

toString

()

method

override public function toString():String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a string representation of the XMLList by calling the toString() method for each XML object in the XMLList. If the prettyPrinting property of the XML class is set to true, then the results for each XML object in the XMLList are separated by the return character. Otherwise, if prettyPrinting is set to false, then the results are simply concatenated, without separating return characters.

The toString() method strips out the following in the returned string for an XML object that has simple content: the start tag, attributes, namespace declarations, and the end tag. Use the toXMLString() method if you want to preserve these in the returned string for XML objects with simple content.

Returns

String — The string representation of the XMLList object.

See also

XML.prettyPrinting

toXMLString

()

method

public function toXMLString():String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns a string representation of the XMLList by calling the toXMLString() method for each XML object in the XMLList. If the prettyPrinting property of the XML class is set to true, then the results for each XML object in the XMLList are separated by the return character. Otherwise, if prettyPrinting is set to false, then the results are concatenated, without separating return characters.

The toXMLString() method preserves the following in the returned string for an XML object that has simple content: the start tag, attributes, namespace declarations, and the end tag. Use the toString() method if you want to strip these from the returned string for XML objects with simple content.

Returns

String — The string representation of the XMLList.

See also

XML.prettyPrinting