| 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 |
Show MXML Syntax
Hide MXML SyntaxThe <mx:XMLListCollection> tag inherits all
the attributes of its superclass, and adds the following attributes:
<mx:XMLListCollection Properties source="null" />
Default MXML Propertysource
More examples
Learn more
Collection events and manual change notification
Hierarchical data objects
Data providers and the uid property
Related API Elements
| 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 : ISort
The ISort that will be applied to the ICollectionView. | ListCollectionView | |
| source : XMLList
The underlying XMLList for this collection. | XMLListCollection | ||
| Method | Defined By | ||
|---|---|---|---|
XMLListCollection(source:XMLList = null)
Constructor. | XMLListCollection | ||
|
Adds a list of items to the current list, placing them at the end of
the list in the order they are passed. | ListCollectionView | |
|
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 | |
|
Adds the specified item to the end of the list. | ListCollectionView | |
|
Adds the item at the specified index. | ListCollectionView | |
Calls the attribute() method of each XML object in the
XMLList and returns an XMLList of the results, which
match the given attributeName. | XMLListCollection | ||
Calls the attributes() method of each XML object in the
XMLList object and returns an XMList of attributes for each XML object. | XMLListCollection | ||
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 | ||
Calls the children() method of each XML object in the XMLList and
returns an XMLList containing the results. | XMLListCollection | ||
|
Returns whether the view contains the specified object. | ListCollectionView | |
Returns a deep copy of the XMLList object. | XMLListCollection | ||
|
Creates a new IViewCursor that works with this view. | ListCollectionView | |
Calls the descendants() method of each XML object in the
XMLList and returns an XMLList containing the results. | XMLListCollection | ||
|
Prevents changes to the collection itself and items within the
collection from being dispatched by the view. | ListCollectionView | |
|
Dispatches an event into the event flow. | ListCollectionView | |
Calls the elements() method of each XML object in the XMLList. | XMLListCollection | ||
|
Enables auto-updating. | ListCollectionView | |
|
Gets the item at the specified index. | ListCollectionView | |
|
Returns the index of the item if it is in the list such that
getItemAt(index) == item. | ListCollectionView | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | ListCollectionView | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Called automatically by the MXML compiler when the ListCollectionView
is created using an MXML tag. | ListCollectionView | |
|
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 | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Applies the sort and filter to the view. | ListCollectionView | |
|
Remove all items from the list. | ListCollectionView | |
|
Removes a listener from the EventDispatcher object. | ListCollectionView | |
|
Removes the item at the specified index and returns it. | ListCollectionView | |
|
Places the item at the specified index. | ListCollectionView | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
Calls the text() method of each XML object in
the XMLList and returns an XMLList containing the results. | XMLListCollection | ||
|
Returns an Array that is populated in the same order as the IList
implementation. | ListCollectionView | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string representation of the XMLList by calling the
toString() method for each XML object in the XMLList. | XMLListCollection | ||
Returns a string representation of the XMLList by calling the
toXMLString() method for each XML object in the XMLList. | XMLListCollection | ||
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | ListCollectionView | |
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):voidXMLListCollection | () | 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.
Parameterssource:XMLList (default = null) |
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.
|
XMLList — The XMLList of matching XML objects.
|
Related API Elements
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.
XMLList — The XMLList containing the resulting XML objects, listing
the attributes.
|
Related API Elements
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.
|
XMLList — An XMLList of matching children of the XML objects in the
original XMLList.
|
Related API Elements
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.
ReturnsXMLList — An XMLList of children of the XML objects in the original XMLList.
|
Related API Elements
copy | () | method |
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 = *) |
XMLList — XMLList of the matching descendents (children, grandchildren,
etc.) of the XML objects in the original XMLList.
|
Related API Elements
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 = "*") |
XMLList — XMLList of the matching child elements of the XML objects in the
original XMLList.
|
Related API 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.
XMLList — The XMLList that contains the result.
|
Related API Elements
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.
String — The string representation of the XMLList object.
|
Related API Elements
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.
String — The string representation of the XMLList.
|
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00