Пакет | mx.collections |
Класс | public class AsyncListView |
Наследование | AsyncListView OnDemandEventDispatcher Object |
Реализует | IList |
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
getItemAt()
, removeItemAt()
и toArray()
.
Метод getItemAt()
обрабатывает ItemPendingErrors при возврате временного ожидающего выполнения элемента до успешного или неудачного выполнения основного запроса. Временный элемент создается путем вызова функции, указанной свойством createPendingItemFunction
. Если запрос успешно выполнен, то фактический элемент заменяет временный. При неудачном выполнении временный элемент заменяется элементом, возвращенным при вызове функции, указанной свойством createFailedItemFunction
.
Этот класс делегирует методы и свойства IList для list
. Если список не указан, методы, видоизменяющие коллекцию, являются пустыми командами, а методы, запрашивающие коллекцию, возвращают пустое значение, например null или нуль соответственно.
Этот класс предназначен для использования с компонентами Spark, основанными на DataGroup, например List и ComboBox Классы Spark не предоставляют встроенную поддержку для обработки ItemPendingError.
AsyncListView не поддерживает повторную вставку ожидающих обработки или неудачно выполненных элементов. После удаления неудачно выполненного или ожидающего обработки элемента его подключение к запросу в очереди для данных прерывается. Перемещение ожидающего обработки элемента в ASyncListView путем перетаскивания или сортировка ASyncListView, который содержит ожидающие обработки или неудачно выполненные элементы, не поддерживается, поскольку эти операции удаляют и затем повторно вставляют элементы списка.
Синтаксис MXMLСкрыть синтаксис MXMLThe <mx:AsyncListView>
tag inherits all the attributes of its
superclass, and adds the following attributes:
<mx:AsyncListView Properties createFailedItemFunction="null" createPendingItemFunction="null" list="null" />
Свойство | Определено | ||
---|---|---|---|
constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | ||
createFailedItemFunction : Function
Функция обратного вызова, используемая для создания элемента замены, если запрос, вызвавший ошибку ItemPendingError, впоследствии неудачно выполнен. | AsyncListView | ||
createPendingItemFunction : Function
Функция обратного вызова, используемая для создания временного элемента, когда начальный запрос вызывает ошибку ItemPendingError. | AsyncListView | ||
length : int [только для чтения]
Число элементов в данной коллекции. | AsyncListView | ||
list : IList
Объект IList, вставляющий строки в данную коллекцию. | AsyncListView |
Метод | Определено | ||
---|---|---|---|
AsyncListView(list:IList = null)
Конструктор. | AsyncListView | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | OnDemandEventDispatcher | ||
Добавляет указанный элемент в конец списка. | AsyncListView | ||
Добавляет элемент в заданный индекс. | AsyncListView | ||
Посылает событие в поток событий. | OnDemandEventDispatcher | ||
Возвращает значение list.getItemAt(index). | AsyncListView | ||
Возвращает индекс элемента, если он находится в списке, где, например getItemAt(индекс) == элемент. | AsyncListView | ||
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | OnDemandEventDispatcher | ||
Показывает, определено ли заданное свойство для объекта. | Object | ||
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | ||
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Уведомляет представление об обновлении элемента. | AsyncListView | ||
Показывает наличие заданного свойства и его перечисляемость. | Object | ||
Удаляет все элементы из списка. | AsyncListView | ||
Удаляет прослушиватель из объекта EventDispatcher. | OnDemandEventDispatcher | ||
Удаляет действительный или ожидающий обработки элемент в указанном индексе и возвращает его. | AsyncListView | ||
Помещает элемент в заданную позицию индекса. | AsyncListView | ||
Задает доступность динамического свойства для операций цикла. | Object | ||
Возвращает массив с теми же элементами, что и в этом AsyncListView. | AsyncListView | ||
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | ||
Возвращает строку, которая содержит длину списка и количество ожидающих запросов элемента. | AsyncListView | ||
Возвращает элементарное значение заданного объекта. | Object | ||
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | OnDemandEventDispatcher |
Событие | Сводка | Определено | ||
---|---|---|---|---|
Отправляется при изменении длины списка или замене элемента списка. | AsyncListView |
createFailedItemFunction | свойство |
createFailedItemFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Функция обратного вызова, используемая для создания элемента замены, если запрос, вызвавший ошибку ItemPendingError
, впоследствии неудачно выполнен. Существующий элемент, обычно являющийся ожидающим обработки элементом, созданным функцией обратного вызова, указанной свойством createPendingItemFunction()
, замещается неудачно выполненным элементом.
Значением этого свойства должна быть функция с двумя параметрами: индексом запрошенного элемента и информационным объектом сбоя, который передан из метода IResponder fault()
. В большинстве случаев второй параметр может быть проигнорирован. Ниже приведен пример реализации функции обратного вызова:
function createFailedItem(index:int, info:Object):Object { return "[" + index + "request failed]"; }
Установка этого свойства не влияет на неудавшиеся элементы, которые уже были созданы. Установка этого свойства на значение null препятствует созданию неудавшихся элементов.
Значением по умолчанию является A function that unconditionally returns null..
Реализация
public function get createFailedItemFunction():Function
public function set createFailedItemFunction(value:Function):void
Связанные элементы API
createPendingItemFunction | свойство |
createPendingItemFunction:Function
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Функция обратного вызова, используемая для создания временного элемента, когда начальный запрос вызывает ошибку ItemPendingError
. Если запрос успешно выполнен, временный элемент автоматически заменяется фактическим элементом. При неудачном выполнении запроса этот элемент заменяется элементом, созданным с помощью функции обратного вызова, указанной свойством createFailedItemFunction
.
Значением этого свойства должна быть функция с двумя параметрами: индексом запрошенного элемента поставщика данных и ItemPendingError. В большинстве случаев второй параметр можно проигнорировать. Ниже приведен пример реализации функции обратного вызова:
function createPendingItem(index:int, ipe:ItemPendingError):Object { return "[" + index + "request is pending...]"; }
Установка этого свойства не влияет на временные элементы очереди, которые уже были созданы. Установка этого свойства на значение null препятствует созданию временных элементов, ожидающих обработки.
Значением по умолчанию является A function that unconditionally returns null..
Реализация
public function get createPendingItemFunction():Function
public function set createPendingItemFunction(value:Function):void
Связанные элементы API
length | свойство |
length:int
[только для чтения] Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Число элементов в данной коллекции. 0 означает отсутствие элементов, а -1 – неизвестную длину.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие collectionChange
.
Реализация
public function get length():int
list | свойство |
list:IList
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Объект IList, вставляющий строки в данную коллекцию. Это означает объект, которому передаются все методы IList.
Если это свойство имеет значение null, методы видоизменения IList, например setItemAt()
, являются пустыми командами. Методы запроса IList, например getItemAt()
, возвращают null или нуль (-1 для getItemIndex()
) соответственно.
Значением по умолчанию является null.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие listChanged
.
Реализация
public function get list():IList
public function set list(value:IList):void
AsyncListView | () | Конструктор |
addItem | () | метод |
addItemAt | () | метод |
public function addItemAt(item:Object, index:int):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Добавляет элемент в заданный индекс. Индекс любого элемента больше индекса добавляемого элемента, увеличенного на единицу. Если указанный индекс меньше нуля или больше длины списка, инициируется ошибка RangeError.
Параметры
item:Object — Элемент, помещаемый в индекс.
| |
index:int — Индекс, в который помещается элемент.
|
getItemAt | () | метод |
public function getItemAt(index:int, prefetch:int = 0):Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает значение list.getItemAt(index)
.
Этот метод перехватывает ItemPendingErrors (IPE), созданные в результате вызова getItemAt()
. Если IPE создается, IResponder
добавляется к IPE, и возвращается временный элемент очереди, созданный функций createPendingItemFunction
. Если основной запрос успешно выполнен, элемент очереди заменяется фактическим элементом. Если запрос не удалось выполнить, элемент очереди заменяется значением, созданным при вызове createFailedItemFunction
.
Параметры
index:int — Индекс списка, из которого необходимо извлечь элемент.
| |
prefetch:int (default = 0 ) — Значение int , указывает как направление, так и число элементов, получаемых во время запроса, если элемент не является локальным.
|
Object — Элемент списка с заданным индексом.
|
Выдает
RangeError — если index < 0 или index > = length .
|
Связанные элементы API
getItemIndex | () | метод |
public function getItemIndex(item:Object):int
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает индекс элемента, если он находится в списке, где, например getItemAt(индекс) == элемент.
Примечание. В отличие от методов IViewCursor.findxxx()
метод getItemIndex()
не может содержать параметр, состоящий исключительно из подмножества полей искомого элемента. Данный метод всегда выполняет поиск элемента, точно соответствующего входным параметрам.
Параметры
item:Object — Искомый элемент.
|
int — Индекс элемента или -1, если элемент отсутствует в списке.
|
itemUpdated | () | метод |
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Уведомляет представление об обновлении элемента. Рекомендуется использовать, если содержимое представления не реализует IEventDispatcher
и передает PropertyChangeEvent
. Если свойство указано, представление может оптимизировать свой механизм уведомления. В противном случае оно может выполнить простое обновление всего представления.
Параметры
item:Object — Элемент представления, который был обновлен.
| |
property:Object (default = null ) — Имя обновленного свойства.
| |
oldValue:Object (default = null ) — Старое значение данного свойства. (Если свойство имело значение null, это могло быть старое значение элемента.)
| |
newValue:Object (default = null ) — Новое значение данного свойства. (Если свойство имело значение null, его можно не указывать, поскольку предполагается, что элемент является новым значением.)
|
removeAll | () | метод |
public function removeAll():void
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Удаляет все элементы из списка.
Если какой-нибудь элемент не является локальным и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError
.
Для получения дополнительной информации об использовании ItemPendingError
см. документацию по ItemPendingError, а также документацию по коллекциям.
removeItemAt | () | метод |
public function removeItemAt(index:int):Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Удаляет действительный или ожидаемый элемент в указанном индексе и возвращает его. Индекс всех элементов с индексом, превышающим указанный индекс, уменьшается на 1.
Если в указанном индексе отсутствует фактический или ожидающий обработки элемент, например по причине того, что вызов getItemAt(index)
не привел к разбивке данных на страницы, то базовый list
может создать ItemPendingError. Данная реализация игнорирует ItemPendingError и возвращает null.
Параметры
index:int — Индекс списка, из которого необходимо извлечь элемент.
|
Object — Элемент, который был удален или имеет значение null.
|
Выдает
RangeError — если index < 0 или index > = length .
|
setItemAt | () | метод |
public function setItemAt(item:Object, index:int):Object
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Помещает элемент в заданную позицию индекса. Если элемент уже занимает данную позицию индекса, новый элемент заменит его и будет возвращен.
Параметры
item:Object — Новый элемент, для размещения в указанной позиции индекса.
| |
index:int — Индекс, в который помещается элемент.
|
Object — Замененный элемент или null в случае отсутствия элемента.
|
toArray | () | метод |
public function toArray():Array
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает массив с теми же элементами, что и в этом AsyncListView. Инициализация массива выполняется путем восстановления каждого элемента с getItemAt()
, поэтому ожидающие обработки элементы заменяются в тех случаях, когда фактические значения еще не доступны. Массив не будет обновляться, когда AsyncListView заменяет ожидающие обработки элементы фактическими (или неудачно выполненными) значениями.
Array — массив с теми же элементами, что и в этом AsyncListView.
|
toString | () | метод |
public function toString():String
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 4 |
Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Возвращает строку, которая содержит длину списка и количество ожидающих запросов элемента. Запросы, ожидающие обработки, не инициируются.
ВозвращаетString — Краткое описание списка.
|
collectionChange | Событие |
mx.events.CollectionEvent
свойство CollectionEvent.type =
mx.events.CollectionEvent.COLLECTION_CHANGE
Язык версии: | ActionScript 3.0 |
Версия продукта: | Flex 3 |
Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется при изменении длины списка или замене элемента списка.
Константа CollectionEvent.COLLECTION_CHANGE определяет значение свойстваtype
объекта события, передаваемого при изменении коллекции.
Свойства объекта события имеют следующие значения. Не все свойства являются значимыми для каждого из видов событий. Дополнительную информацию см. в подробных описаниях свойств.
Свойство | Значение |
---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
items | Массив объектов с информацией об элементах, задействованных этим событием. Содержимое этого поля зависит от вида события; для получения подробной информации см. описание свойства items |
kind | Вид события. Допустимые значения определены в классе CollectionEventKind как константы. |
location | Местоположение внутри целевой коллекции элементов, указанное в свойстве items . |
oldLocation | прежнее местоположение элемента в коллекции, указанное в свойстве items . |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
type | CollectionEvent.COLLECTION_CHANGE |
Tue Jun 12 2018, 11:34 AM Z