IList - Adobe ActionScript® 3 (AS3 Flex)

Пакет	mx.collections
Интерфейс	public interface IList extends IEventDispatcher
Средство реализации	ArrayList, AsyncListView, ListCollectionView, NumericDataProvider

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Коллекция элементов, организованных по порядку. Предоставляет методы получения и обработки, основанные на индексе.

IList может быть представлением данных, которые были извлечены из удаленного местоположения. При записи в коллекцию, которая может быть удаленной, важно предусмотреть возможность недоступности данных, в результате чего инициируется ошибка ItemPendingError.

ICollectionView является альтернативой IList.

Связанные элементы API

mx.collections.errors.ItemPendingError
mx.collections.ICollectionView
mx.collections.ListCollectionView

Общедоступные свойства

	Свойство		Определено
		length : int [только для чтения] Число элементов в данной коллекции.	IList

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.	IEventDispatcher
		addItem(item:Object):void Добавляет указанный элемент в конец списка.	IList
		addItemAt(item:Object, index:int):void Добавляет элемент в заданный индекс.	IList
		dispatchEvent(event:Event):Boolean Посылает событие в поток событий.	IEventDispatcher
		getItemAt(index:int, prefetch:int = 0):Object Получает элемент, расположенный по заданному индексу.	IList
		getItemIndex(item:Object):int Возвращает индекс элемента, если он находится в списке, где, например getItemAt(индекс) == элемент.	IList
		hasEventListener(type:String):Boolean Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.	IEventDispatcher
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Уведомляет представление об обновлении элемента.	IList
		removeAll():void Удаляет все элементы из списка.	IList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	IEventDispatcher
		removeItemAt(index:int):Object Удаляет элемент в указанной позиции индекса и возвращает его.	IList
		setItemAt(item:Object, index:int):Object Помещает элемент в заданную позицию индекса.	IList
		toArray():Array Возвращает массив, заполняемый в порядке, аналогичном реализации IList.	IList
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.	IEventDispatcher

События

Дополнительные сведения о событиях

	Событие		Сводка	Определено
		collectionChange	Передается при некоторых обновлениях IList.	IList

Сведения о свойстве

length

свойство

length:int [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Число элементов в данной коллекции. 0 означает отсутствие элементов, а -1 – неизвестную длину.

Реализация
public function get length():int

Сведения о методе

addItem

()

метод

public function addItem(item:Object):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Добавляет указанный элемент в конец списка. Эквивалентен addItemAt(item, length).

Параметры

item:Object — Добавляемый элемент.

addItemAt

()

метод

public function addItemAt(item:Object, index:int):void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Добавляет элемент в заданный индекс. Индекс любого элемента больше индекса добавляемого элемента, увеличенного на единицу. Если указанный индекс меньше нуля или больше длины списка, инициируется ошибка RangeError.

Параметры

	`item:Object` — Элемент, помещаемый в индекс.

	`index:int` — Индекс, в который помещается элемент.

Выдает

RangeError — если индекс меньше 0 или больше длины списка.

getItemAt

()

метод

public function getItemAt(index:int, prefetch:int = 0):Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Получает элемент, расположенный по заданному индексу.

Параметры

	`index:int` — Индекс в списке для извлечения элемента.

	`prefetch:int` (default = `0`) — Значение `int`, указывает как направление, так и число элементов, получаемых во время запроса, если элемент не является локальным.

Возвращает

Object — Элемент в этой позиции индекса или значение null, если элемент отсутствует.

Выдает

	`ItemPendingError` — если данные для этого индекса следует загрузить из удаленного местоположения.

	`RangeError` — если `index < 0` или `index > = length`.

getItemIndex

()

метод

public function getItemIndex(item:Object):int

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Возвращает индекс элемента, если он находится в списке, где, например 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 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Уведомляет представление об обновлении элемента. Рекомендуется использовать, если содержимое представления не реализует IEventDispatcher и передает PropertyChangeEvent. Если свойство указано, представление может оптимизировать свой механизм уведомления. В противном случае оно может выполнить простое обновление всего представления.

Параметры

	`item:Object` — Элемент представления, который был обновлен.

	`property:Object` (default = `null`) — Имя обновленного свойства.

	`oldValue:Object` (default = `null`) — Старое значение данного свойства. (Если свойство имело значение null, это могло быть старое значение элемента.)

	`newValue:Object` (default = `null`) — Новое значение данного свойства. (Если свойство имело значение null, его можно не указывать, поскольку предполагается, что элемент является новым значением.)

Связанные элементы API

mx.events.CollectionEvent
mx.events.PropertyChangeEvent

removeAll

()

метод

public function removeAll():void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Удаляет все элементы из списка.

Если какой-нибудь элемент не является локальным и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError.

Для получения дополнительной информации об использовании ItemPendingError см. документацию по ItemPendingError, а также документацию по коллекциям.

removeItemAt

()

метод

public function removeItemAt(index:int):Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Удаляет элемент в указанной позиции индекса и возвращает его. Любые элементы, прежде находившиеся после данного индекса, теперь соответствуют предыдущему индексу.

Параметры

index:int — Индекс, из которого необходимо удалить элемент.

Возвращает

Object — Удаленный элемент.

Выдает

RangeError — индекс меньше 0 или больше длины.

setItemAt

()

метод

public function setItemAt(item:Object, index:int):Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Помещает элемент в заданную позицию индекса. Если элемент уже занимает данную позицию индекса, новый элемент заменит его и будет возвращен.

Параметры

	`item:Object` — Новый элемент, для размещения в указанной позиции индекса.

	`index:int` — Индекс, в который помещается элемент.

Возвращает

Object — Замененный элемент или null в случае отсутствия элемента.

Выдает

RangeError — если индекс меньше 0 или больше длины.

toArray

()

метод

public function toArray():Array

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Возвращает массив, заполняемый в порядке, аналогичном реализации IList. Этот метод может инициировать ошибку ItemPendingError.

Возвращает

Array — Массив.

Выдает

ItemPendingError — Если данные не загружены полностью из удаленного местоположения.

Сведения о событии

collectionChange

Событие

Тип объекта события: mx.events.CollectionEvent
свойство CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Передается при некоторых обновлениях IList.

Константа 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

Юридическая информация | Политика конфиденциальности онлайн

IList - AS3 Flex

Классы x

length

addItem

addItemAt

getItemAt

getItemIndex

itemUpdated

removeAll

removeItemAt

setItemAt

toArray

collectionChange