| Пакет | mx.collections |
| Класс | public class ListCollectionView |
| Наследование | ListCollectionView  Proxy |
| Реализует | ICollectionView, IList, IMXMLObject |
| Подклассы | ArrayCollection, XMLListCollection |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
ICollectionView к объекту, который соответствует интерфейсу IList. В итоге можно использовать объект этого класса в ситуациях, предусматривающих IList или ICollectionView.
Этот класс также позволяет использовать нотацию массива [] для доступа к методам getItemAt() и setItemAt(). При использовании кода, например myListCollectionView[index], Flex вызывает метод getItemAt() или setItemAt() объекта myListCollectionView.
Показать синтаксис MXML
Скрыть синтаксис MXMLThe <mx:ListCollectionView> has the following attributes,
which all of its subclasses inherit:
<mx:ListCollectionView Properties filterFunction="null" list="null" sort="null" Events collectionChange="No default" />
| Свойство | Определено | ||
|---|---|---|---|
| filterFunction : Function
Функция, которую представление использует для устранения элементов, несоответствующих критериям функции. | ListCollectionView | ||
| length : int [только для чтения]
Число элементов в данном представлении. | ListCollectionView | ||
| list : IList
IList, вставляющий строки в данное представление коллекции. | ListCollectionView | ||
| sort : ISort
ISort, применяемый к ICollectionView. | ListCollectionView | ||
| Свойство | Определено | ||
|---|---|---|---|
| localIndex : Array
Если представление является отсортированным или отфильтрованным, свойство localIndex содержит массив элементов в отсортированном или отфильтрованном (упорядоченном, уменьшенном) представлении в порядке сортировки. | ListCollectionView | ||
| Метод | Определено | ||
|---|---|---|---|
ListCollectionView(list:IList = null)
Конструктор ListCollectionView. | ListCollectionView | ||
Добавляет список элементов к текущему списку, помещая их в конце списка в порядке передачи. | ListCollectionView | ||
Добавляет список элементов к текущему списку, помещая их в позиции индекса, передаваемого в функцию. | ListCollectionView | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | ListCollectionView | ||
Добавляет указанный элемент в конец списка. | ListCollectionView | ||
Добавляет элемент в заданный индекс. | ListCollectionView | ||
Возвращает значение, определяющее, содержит ли данное представление указанный объект. | ListCollectionView | ||
Создает новый IViewCursor, работающий с данным представлением. | ListCollectionView | ||
Предотвращает передачу представлением информации об изменениях коллекции и ее элементов. | ListCollectionView | ||
Посылает событие в поток событий. | ListCollectionView | ||
Активирует автоматическое обновление. | ListCollectionView | ||
Получает элемент, расположенный по заданному индексу. | ListCollectionView | ||
Возвращает индекс элемента, если он находится в списке, где, например getItemAt(индекс) == элемент. | ListCollectionView | ||
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | ListCollectionView | ||
Автоматически вызывается компилятором MXML при создании ListCollectionView с помощью тега MXML. | ListCollectionView | ||
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Уведомляет представление об обновлении элемента. | ListCollectionView | ||
Применяет сортировку и фильтр к представлению. | ListCollectionView | ||
Удаляет все элементы из списка. | ListCollectionView | ||
Удаляет прослушиватель из объекта EventDispatcher. | ListCollectionView | ||
Удаляет элемент в указанной позиции индекса и возвращает его. | ListCollectionView | ||
Помещает элемент в заданную позицию индекса. | ListCollectionView | ||
Возвращает массив, заполняемый в порядке, аналогичном реализации IList. | ListCollectionView | ||
Вводит содержимое данного представления в строку и возвращает ее. | ListCollectionView | ||
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | ListCollectionView | ||
| Событие | Сводка | Определено | ||
|---|---|---|---|---|
| Передается при обновлении ICollectionView. | ListCollectionView | |||
filterFunction | свойство |
filterFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция, которую представление использует для устранения элементов, несоответствующих критериям функции. Ожидается следующая подпись filterFunction:
f(item:Object):Booleanгде возвращаемым значением является
true, если указанный элемент следует оставить в представлении.
Если фильтр не поддерживается, в Flex инициируется ошибка при доступе к данному свойству. Для обновления представления следует вызвать refresh() после установки свойства filterFunction.
Примечание. Реализации ICollectionView в Flex извлекают все элементы из удаленного местоположения перед выполнением функции фильтрации. При использовании подкачки страниц следует применить фильтр к удаленной коллекции перед извлечением данных.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие filterFunctionChanged .
Реализация
public function get filterFunction():Function public function set filterFunction(value:Function):voidСвязанные элементы API
length | свойство |
length:int [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Число элементов в данном представлении. Значение 0 означает отсутствие элементов, -1 – неизвестную длину.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие collectionChange .
Реализация
public function get length():intlist | свойство |
list:IList| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
IList, вставляющий строки в данное представление коллекции.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие listChanged .
Реализация
public function get list():IList public function set list(value:IList):voidlocalIndex | свойство |
protected var localIndex:Array| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если представление является отсортированным или отфильтрованным, свойство localIndex содержит массив элементов в отсортированном или отфильтрованном (упорядоченном, уменьшенном) представлении в порядке сортировки. Класс ListCollectionView использует данное свойство для доступа к элементам в представлении. Свойство localIndex никогда не содержит данных, отсутствующих в источнике, но может не включать все данные источника. Это свойство содержит значение null при отсутствии сортировки.
sort | свойство |
sort:ISort| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
ISort, применяемый к ICollectionView. Установка сортировки не обновляет представление автоматически, поэтому после установки данного свойства следует вызвать метод refresh(). Если сортировка не поддерживается, то при доступе к этому свойству инициируется ошибка.
Примечание. Реализации ICollectionView в Flex извлекают все элементы из удаленного местоположения перед выполнением сортировки. При использовании подкачки страниц с сортированным списком к удаленной коллекции перед извлечением данных следует применить сортировку.
Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие sortChanged .
Реализация
public function get sort():ISort public function set sort(value:ISort):voidСвязанные элементы API
ListCollectionView | () | Конструктор |
addAll | () | метод |
public function addAll(addList:IList):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Добавляет список элементов к текущему списку, помещая их в конце списка в порядке передачи.
Параметры
addList:IList — Список элементов, добавляемых к текущему списку
|
addAllAt | () | метод |
public function addAllAt(addList:IList, index:int):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Добавляет список элементов к текущему списку, помещая их в позиции индекса, передаваемого в функцию. Элементы помещаются в позиции индекса в порядке их получения.
Параметры
addList:IList — Список элементов, добавляемых к текущему списку
| |
index:int — Местоположение текущего списка для размещения новых элементов.
|
Выдает
RangeError — если индекс меньше 0 или больше длины списка.
|
addEventListener | () | метод |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. Можно регистрировать прослушиватели событий в любом узле из списка отображения для каждого типа события, фазы и приоритета.
После успешной регистрации прослушивателя событий невозможно изменить его приоритет путем дополнительных вызовов addEventListener(). Для изменения приоритета прослушивателя следует вначале вызвать removeEventListener(). Затем можно снова зарегистрировать прослушиватель с новым приоритетом.
После регистрации прослушивателя последующие вызовы addEventListener() со значениями, отличающимися от type и useCapture приводят к его отдельной регистрации. Например, прослушиватель, изначально зарегистрированный со значением useCapture, равным true, прослушивает только во время фазы захвата. После повторного вызова addEventListener() с помощью аналогичного объекта прослушивания, но со значением useCapture, равным false, активными становятся два отдельных прослушивателя: один прослушивает во время фазы захвата, второй – во время целевой фазы и фазы восходящей цепочки.
Невозможно зарегистрировать прослушиватель события только для целевой фазы или для фазы восходящей цепочки. Эти фазы соединены при регистрации, поскольку восходящая цепочка применяется только к предшественникам целевого узла.
При отсутствии необходимости в прослушивателе события он может быть удален с помощью вызова EventDispatcher.removeEventListener(); в противном случае могут возникнуть проблемы с памятью. Объекты с зарегистрированными прослушивателями события автоматически не удаляются из памяти, поскольку сборщик мусора не удаляет объекты, на которые имеются ссылки.
Копирование экземпляра EventDispatcher не приводит к копированию прослушивателей событий, присоединенных к нему. (Если для вновь создаваемого узла требуется прослушиватель событий, его необходимо присоединить после создания узла.) При этом при перемещении экземпляра EventDispatcher присоединенные к нему прослушиватели событий перемещаются вместе с ним.
Прослушиватель событий, регистрируемый на узле, на котором в это время обрабатывается событие, не запускается в ходе текущей фазы, но может быть запущен в потоке событий более поздней фазы, например фазы восходящей цепочки.
Прослушиватель событий, удаленный из узла во время обработки события на этом узле, будет запускаться текущими операциями. После удаления прослушиватель событий никогда не вызывается повторно (если только он не был повторно зарегистрирован для будущей обработки).
Параметры
type:String — Тип события.
| |
listener:Function — Функция прослушивателя, обрабатывающая событие. Эта функция принимает объект события как единственный параметр и ничего не возвращает, например:
| |
useCapture:Boolean (default = false)useCapture равно true, прослушиватель обрабатывает событие только во время фазы захвата, но не во время целевой фазы или фазы восходящей цепочки. Если значение useCapture равно false, то прослушиватель обрабатывает событие только в целевой фазе или фазе восходящей цепочки. Для прослушивания события во всех трех фазах следует дважды вызвать addEventListener(), первый раз с useCapture, равным true, а второй раз с useCapture, равным false.
| |
priority:int (default = 0) | |
useWeakReference:Boolean (default = false)Функции элементов уровня класса не подлежат удалению в качестве мусора, вследствие чего можно установить |
addItem | () | метод |
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 — Индекс, в который помещается элемент.
|
contains | () | метод |
public function contains(item:Object):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает значение, определяющее, содержит ли данное представление указанный объект. В отличие от методов IViewCursor.findxxx, этот поиск будет успешным только при нахождении элемента, точно соответствующего данному параметру. При наличии фильтра, применяемого к представлению, данный метод может вернуть false даже в случае, если элемент действительно содержится в основной коллекции.
Параметры
item:Object — Искомый объект.
|
Boolean — Значение равно true, если ICollectionView содержит элемент после применения любого фильтра; в противном случае значение равно false.
|
Связанные элементы API
createCursor | () | метод |
public function createCursor():IViewCursor| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Создает новый IViewCursor, работающий с данным представлением.
ВозвращаетIViewCursor — Новая реализация IViewCursor.
|
disableAutoUpdate | () | метод |
public function disableAutoUpdate():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Предотвращает передачу представлением информации об изменениях коллекции и ее элементов. Также предотвращает обновление позиций элементов в представлении при изменении позиций в коллекции. Эти изменения устанавливаются в очередь и передаются после вызова enableAutoUpdate. Если для отдельного элемента происходит больше событий, чем обновлений, представление может завершиться сбросом. Метод disableAutoUpdate действует кумулятивно; для передачи и обновления событий в представлении требуется одинаковое число вызовов enableAutoUpdate. Учтите, что disableAutoUpdate влияет только на отдельные представления; редактирование может быть обнаружено другими представлениями на базе отдельного представления.
Связанные элементы API
dispatchEvent | () | метод |
public function dispatchEvent(event:Event):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Посылает событие в поток событий. Адресатом события является объект EventDispatcher, в котором вызывается dispatchEvent().
Параметры
event:Event — Объект события, переданный в поток событий.
|
Boolean — Значение равно true до тех пор, пока preventDefault() не будет вызван для события; в этом случае возвращается значение false.
|
enableAutoUpdate | () | метод |
public function enableAutoUpdate():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Активирует автоматическое обновление. Для получения дополнительной информации см. disableAutoUpdate.
Связанные элементы API
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, если элемент отсутствует.
|
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, если элемент отсутствует в списке.
|
hasEventListener | () | метод |
public function hasEventListener(type:String):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. Это позволяет определить, где объект EventDispatcher изменил обработку типа события в иерархии потока событий. Для определения, действительно ли определенный тип события запускает прослушиватель события, следует использовать IEventDispatcher.willTrigger().
Различие между hasEventListener() и willTrigger() заключается в том, что hasEventListener() анализирует только объект, к которому он принадлежит, тогда как willTrigger() — весь поток событий для события, указанного параметром type.
Параметры
type:String — Тип события.
|
Boolean — Значение true, если прослушиватель указанного типа зарегистрирован; в противном случае – false.
|
initialized | () | метод |
public function initialized(document:Object, id:String):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Автоматически вызывается компилятором MXML при создании ListCollectionView с помощью тега MXML. При создании ListCollectionView посредством ActionScript требуется вызвать этот метод, протекающий в документе MXML и null для id.
Параметры
document:Object — MXML-документ, содержащий данный ListCollectionView.
| |
id:String — Игнорируется.
|
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 |
Уведомляет представление об обновлении элемента. Этот метод рекомендуется использовать, если содержимое представления не реализует IPropertyChangeNotifier. Если вызов этого метода включает параметр property, представление может оптимизировать его механизм уведомления. В противном случае оно может выполнить простое обновление всего представления.
Параметры
item:Object — Элемент представления, который был обновлен.
| |
property:Object (default = null) | |
oldValue:Object (default = null) | |
newValue:Object (default = null) |
Связанные элементы API
refresh | () | метод |
public function refresh():Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Применяет сортировку и фильтр к представлению. ICollectionView не обнаруживает автоматически изменения сортировки или фильтра, поэтому для обновления представления после установки свойства sort или filterFunction следует вызвать метод refresh(). Если в реализации ICollectionView также используется интерфейс IMXMLObject, следует вызвать метод refresh() из метода initialized().
Возвращает true, если обновление было успешным, и false, если сортировка еще не закончена (например, элементы еще находятся в состоянии ожидания). Клиент представления должен ожидать события CollectionEvent со значением свойства CollectionEventKind.REFRESH, равным kind для обеспечения завершения операции refresh().
Boolean — Значение равно true, если refresh() был завершен; в противном случае значение равно false.
|
removeAll | () | метод |
public function removeAll():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Удаляет все элементы из списка.
removeEventListener | () | метод |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Удаляет прослушиватель из объекта EventDispatcher. При отсутствии прослушивателя, зарегистрированного с объектом EventDispatcher, вызов этого метода не оказывает эффекта.
Параметры
type:String — Тип события.
| |
listener:Function — Удаляемый объект прослушивателя.
| |
useCapture:Boolean (default = false)removeEventListener(): один вызов с useCapture, равным true, и второй вызов с useCapture, равным false.
|
removeItemAt | () | метод |
public function removeItemAt(index:int):Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Удаляет элемент в указанной позиции индекса и возвращает его. Любые элементы, прежде находившиеся после данного индекса, теперь соответствуют предыдущему индексу.
Параметры
index:int — Индекс, из которого необходимо удалить элемент.
|
Object — Удаленный элемент.
|
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 в случае отсутствия элемента.
|
toArray | () | метод |
toString | () | метод |
willTrigger | () | метод |
public function willTrigger(type:String):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. Этот метод возвращает значение true, если прослушиватель события запускается в течение любой фазы потока событий, когда событие указанного типа передается объекту EventDispatcher или любому из его нижестоящих элементов.
Различие между hasEventListener() и willTrigger() заключается в том, что hasEventListener() анализирует только объект, к которому он принадлежит, тогда как willTrigger() — весь поток событий для события, указанного параметром type.
Параметры
type:String — Тип события.
|
Boolean — Значение равно true при запуске прослушивателя указанного типа; в противном случае значение равно false.
|
collectionChange | Событие |
mx.events.CollectionEventсвойство CollectionEvent.type =
mx.events.CollectionEvent.COLLECTION_CHANGE| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Передается при обновлении ICollectionView.
Константа 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