Paquete | mx.collections |
Interfaz | public interface IList extends IEventDispatcher |
Implementadores | ArrayList, AsyncListView, ListCollectionView, NumericDataProvider |
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
An IList
may be a view onto data
that has been retrieved from a remote location.
When writing for a collection that may be remote,
it is important to handle the case where data
may not yet be available, which is indicated
by the ItemPendingError
.
The ICollectionView
is an alternative
to the IList
.
Elementos de API relacionados
mx.collections.ICollectionView
mx.collections.ListCollectionView
Propiedad | Definido por | ||
---|---|---|---|
length : int [solo lectura]
The number of items in this collection. | IList |
Método | Definido por | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | IEventDispatcher | ||
Adds the specified item to the end of the list. | IList | ||
Adds the item at the specified index. | IList | ||
Distribuye un evento en el flujo del evento. | IEventDispatcher | ||
Gets the item at the specified index. | IList | ||
Returns the index of the item if it is in the list such that
getItemAt(index) == item. | IList | ||
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | IEventDispatcher | ||
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated. | IList | ||
Removes all items from the list. | IList | ||
Elimina un detector del objeto EventDispatcher. | IEventDispatcher | ||
Removes the item at the specified index and returns it. | IList | ||
Places the item at the specified index. | IList | ||
Returns an Array that is populated in the same order as the IList
implementation. | IList | ||
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | IEventDispatcher |
Evento | Resumen | Definido por | ||
---|---|---|---|---|
Dispatched when the IList has been updated in some way. | IList |
length | propiedad |
addItem | () | método |
addItemAt | () | método |
public function addItemAt(item:Object, index:int):void
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Adds the item at the specified index. The index of any item greater than the index of the added item is increased by one. If the the specified index is less than zero or greater than the length of the list, a RangeError is thrown.
Parámetros
item:Object — The item to place at the index.
| |
index:int — The index at which to place the item.
|
Emite
RangeError — if index is less than 0 or greater than the length of the list.
|
getItemAt | () | método |
public function getItemAt(index:int, prefetch:int = 0):Object
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Gets the item at the specified index.
Parámetros
index:int — The index in the list from which to retrieve the item.
| |
prefetch:int (default = 0 ) — An int indicating both the direction
and number of items to fetch during the request if the item is
not local.
|
Object — The item at that index, or null if there is none.
|
Emite
ItemPendingError — if the data for that index needs to be
loaded from a remote location.
| |
RangeError — if index < 0
or index >= length .
|
getItemIndex | () | método |
public function getItemIndex(item:Object):int
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns the index of the item if it is in the list such that getItemAt(index) == item.
Note: unlike IViewCursor.findxxx()
methods,
The getItemIndex()
method cannot take a parameter with
only a subset of the fields in the item being serched for;
this method always searches for an item that exactly matches
the input parameter.
Parámetros
item:Object — The item to find.
|
int — The index of the item, or -1 if the item is not in the list.
|
itemUpdated | () | método |
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Notifies the view that an item has been updated.
This is useful if the contents of the view do not implement
IEventDispatcher
and dispatches a
PropertyChangeEvent
.
If a property is specified the view may be able to optimize its
notification mechanism.
Otherwise it may choose to simply refresh the whole view.
Parámetros
item:Object — The item within the view that was updated.
| |
property:Object (default = null ) — The name of the property that was updated.
| |
oldValue:Object (default = null ) — The old value of that property. (If property was null,
this can be the old value of the item.)
| |
newValue:Object (default = null ) — The new value of that property. (If property was null,
there's no need to specify this as the item is assumed to be
the new value.)
|
Elementos de API relacionados
removeAll | () | método |
public function removeAll():void
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Removes all items from the list.
If any item is not local and an asynchronous operation must be
performed, an ItemPendingError
will be thrown.
See the ItemPendingError documentation as well as
the collections documentation for more information
on using the ItemPendingError
.
removeItemAt | () | método |
public function removeItemAt(index:int):Object
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Removes the item at the specified index and returns it. Any items that were after this index are now one index earlier.
Parámetros
index:int — The index from which to remove the item.
|
Object — The item that was removed.
|
Emite
RangeError — is index is less than 0 or greater than length.
|
setItemAt | () | método |
public function setItemAt(item:Object, index:int):Object
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Places the item at the specified index. If an item was already at that index the new item will replace it and it will be returned.
Parámetros
item:Object — The new item to be placed at the specified index.
| |
index:int — The index at which to place the item.
|
Object — The item that was replaced, or null if none.
|
Emite
RangeError — if index is less than 0 or greater than length.
|
toArray | () | método |
public function toArray():Array
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Returns an Array that is populated in the same order as the IList implementation. This method can throw an ItemPendingError.
Valor devueltoArray — The array.
|
Emite
ItemPendingError — If the data is not yet completely loaded
from a remote location.
|
collectionChange | Evento |
mx.events.CollectionEvent
propiedad CollectionEvent.type =
mx.events.CollectionEvent.COLLECTION_CHANGE
Versión del lenguaje: | ActionScript 3.0 |
Versión de producto: | Flex 3 |
Versiones de motor de ejecución: | Flash Player 9, AIR 1.1 |
Dispatched when the IList has been updated in some way.
The CollectionEvent.COLLECTION_CHANGE constant defines the value of thetype
property of the event object for an event that is
dispatched when a collection has changed.
The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
items | An Array of objects with
information about the items affected by the event.
The contents of this field depend on the event kind;
for details see the items property |
kind | The kind of event. The valid values are defined in the CollectionEventKind class as constants. |
location | Location within the target collection
of the item(s) specified in the items property. |
oldLocation | the previous location in the collection
of the item specified in the items property. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | CollectionEvent.COLLECTION_CHANGE |
Tue Jun 12 2018, 02:12 PM Z