| Пакет | mx.collections |
| Класс | public class HierarchicalCollectionViewCursor |
| Наследование | HierarchicalCollectionViewCursor  EventDispatcher Object |
| Реализует | IHierarchicalCollectionViewCursor |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Связанные элементы API
Скрыть унаследованные общедоступные свойства
Показать унаследованные общедоступные свойства| Свойство | Определено | ||
|---|---|---|---|
| afterLast : Boolean [только для чтения]
Если курсор расположен после последнего элемента в представлении, это свойство равно true. | HierarchicalCollectionViewCursor | ||
| beforeFirst : Boolean [только для чтения]
Если курсор расположен перед первым элементом в представлении, это свойство равно true. | HierarchicalCollectionViewCursor | ||
| bookmark : CursorBookmark [только для чтения]
Предоставляет доступ к закладке, которая соответствует элементу, возвращаемому свойством current. | HierarchicalCollectionViewCursor | ||
 | constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| current : Object [только для чтения]
Предоставляет доступ к объекту в местоположении исходной коллекции, на которое ссылается данный курсор. | HierarchicalCollectionViewCursor | ||
| currentDepth : int [только для чтения]
Содержит глубину узла в местоположении в исходной коллекции, на которое ссылается курсор. | HierarchicalCollectionViewCursor | ||
| view : ICollectionView [только для чтения]
Ссылка на ICollectionView, с которым связан этот курсор. | HierarchicalCollectionViewCursor | ||
| Метод | Определено | ||
|---|---|---|---|
HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)
Конструктор. | HierarchicalCollectionViewCursor | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Посылает событие в поток событий. | EventDispatcher | |
Находит в коллекции элемент с указанными свойствами и позиционирует курсор на этом элементе. | HierarchicalCollectionViewCursor | ||
Находит в пределах коллекции первый элемент с указанными свойствами и позиционирует курсор на этом элементе. | HierarchicalCollectionViewCursor | ||
Находит в коллекции последний элемент с указанными свойствами и позиционирует курсор на этом элементе. | HierarchicalCollectionViewCursor | ||
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
Вставляет указанный элемент перед текущим расположением курсора. | HierarchicalCollectionViewCursor | ||
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
Перемещает курсор на следующий элемент коллекции. | HierarchicalCollectionViewCursor | ||
Перемещает курсор на предыдущий элемент коллекции. | HierarchicalCollectionViewCursor | ||
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
Удаляет текущий элемент и возвращает его. | HierarchicalCollectionViewCursor | ||
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
Перемещает курсор в местоположение, определяемое смещением от указанной закладки. | HierarchicalCollectionViewCursor | ||
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
afterLast | свойство |
afterLast:Boolean [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если курсор расположен после последнего элемента в представлении, это свойство равно true. Если ICollectionView пуст (длина == 0), данное свойство равно true.
Реализация
public function get afterLast():BooleanbeforeFirst | свойство |
beforeFirst:Boolean [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Если курсор расположен перед первым элементом в представлении, это свойство равно true. Если ICollectionView пуст (длина == 0), данное свойство равно true.
Реализация
public function get beforeFirst():Booleanbookmark | свойство |
bookmark:CursorBookmark [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Предоставляет доступ к закладке, которая соответствует элементу, возвращаемому свойством current. Закладку можно использовать для перемещения курсора на уже просмотренный элемент или на позицию, соответствующую данному элементу. (Для получения дополнительной информации см. описание метода seek())
Реализация
public function get bookmark():CursorBookmarkcurrent | свойство |
current:Object [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Предоставляет доступ к объекту в местоположении исходной коллекции, на которое ссылается данный курсор. Если курсор находится за пределами коллекции (beforeFirst, afterLast), то возвращается значение null.
Реализация
public function get current():ObjectcurrentDepth | свойство |
currentDepth:int [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Содержит глубину узла в местоположении в исходной коллекции, на которое ссылается курсор. Если курсор находится за пределами коллекции, это свойство имеет значение 0.
Реализация
public function get currentDepth():intview | свойство |
view:ICollectionView [только для чтения] | Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Ссылка на ICollectionView, с которым связан этот курсор.
Реализация
public function get view():ICollectionViewHierarchicalCollectionViewCursor | () | Конструктор |
public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конструктор.
Параметрыcollection:HierarchicalCollectionView — Экземпляр HierarchicalCollectionView, на который ссылается этот курсор.
| |
model:ICollectionView — Коллекция исходных данных.
| |
hierarchicalData:IHierarchicalData — Данные, используемые для создания экземпляра HierarchicalCollectionView.
|
findAny | () | метод |
public function findAny(values:Object):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Находит в коллекции элемент с указанными свойствами и позиционирует курсор на этом элементе. Если элемент не найден, то местоположение курсора не изменяется.
Метод findAny() может быть вызван только в представлениях с выполненной сортировкой; в противном случае возникает ошибка CursorError.
Если связанная коллекция является удаленной и не все ее элементы кэшированы локально, этот метод начинает асинхронную выборку из удаленной коллекции. Если выборка уже обрабатывается, то этот метод ожидает завершения ее обработки перед созданием другого запроса на выборку.
Если критериям поиска может соответствовать несколько элементов, то найденный элемент является недетерминированным. Если важно найти первое или последнее вхождение элемента в неуникальный индекс, следует использовать метод findFirst() или findLast().
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError.
Параметры
values:Object — Критерии поиска. Значения в объекте следует конфигурировать как пары «имя-значение», подобно ассоциативному массиву (или они будут фактическим объектом для поиска). Значения указанных имен должны соответствовать свойствам, указанным в сортировке. Например, если свойства x, y и z находятся в текущей сортировке, указанные значения должны быть равны (x: x-value, y: y-value, z: z-value}.
|
Boolean — Если все данные являются локальными, то этот метод возвращает true, если элемент можно найти, и false, если нет.
|
findFirst | () | метод |
public function findFirst(values:Object):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Находит в пределах коллекции первый элемент с указанными свойствами и позиционирует курсор на этом элементе. Если элемент не найден, то местоположение курсора не изменяется.
Метод findFirst() можно вызвать только в представлениях с выполненной сортировкой, в противном случае инициируется ошибка CursorError.
Если связанная коллекция является удаленной и не все ее элементы кэшированы локально, этот метод начинает асинхронную выборку из удаленной коллекции. Если выборка уже обрабатывается, то этот метод ожидает завершения ее обработки перед созданием другого запроса на выборку.
Если поиск первого вхождения элемента в групповой индекс не является обязательным, используйте findAny(), который может оказаться немного более быстрым, чем метод findFirst().
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError.
Параметры
values:Object — Критерии поиска. Значения в объекте следует конфигурировать как пары «имя-значение», подобно ассоциативному массиву (или они будут фактическим объектом для поиска). Значения указанных имен должны соответствовать свойствам, указанным в сортировке. Например, если свойства x, y и z находятся в текущей сортировке, указанные значения должны быть равны (x: x-value, y: y-value, z: z-value}.
|
Boolean — Если все данные являются локальными, то этот метод возвращает true, если элемент можно найти, и false, если нет.
|
findLast | () | метод |
public function findLast(values:Object):Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Находит в коллекции последний элемент с указанными свойствами и позиционирует курсор на этом элементе. Если элемент не найден, местоположение курсора не изменяется.
Метод findLast() может быть вызван только в представлениях с выполненной сортировкой; если сортировка в представлении не выполнена, инициируется ошибка CursorError.
Если связанная коллекция является удаленной и не все ее элементы кэшированы локально, этот метод начинает асинхронную выборку из удаленной коллекции. Если выборка уже обрабатывается, то этот метод ожидает завершения ее обработки перед созданием другого запроса на выборку.
Если поиск последнего вхождения элемента в групповой индекс не является обязательным, используйте метод findAny(), который может оказаться немного более быстрым.
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError.
Параметры
values:Object — Критерии поиска. Значения в объекте следует конфигурировать как пары «имя-значение», подобно ассоциативному массиву (или они будут фактическим объектом для поиска). Значения указанных имен должны соответствовать свойствам, указанным в сортировке. Например, если свойства x, y и z находятся в текущей сортировке, указанные значения должны быть равны (x: x-value, y: y-value, z: z-value}.
|
Boolean — Если все данные являются локальными, то этот метод возвращает true, если элемент можно найти, и false, если нет.
|
insert | () | метод |
public function insert(item:Object):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вставляет указанный элемент перед текущим расположением курсора. Если курсор – afterLast, вставка производится в конце представления. Если курсор – beforeFirst в непустом представлении, инициируется ошибка.
Параметры
item:Object — Элемент, вставляемый перед текущей позицией курсора.
|
moveNext | () | метод |
public function moveNext():Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Перемещает курсор на следующий элемент коллекции. При удачном выполнении свойство current обновляется для ссылки на объект в новом местоположении. Возвращает true, если результирующее свойство current является действительным, или false, если это не так (значение свойства равно afterLast).
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError. Для получения дополнительной информации об использовании ItemPendingError см. документацию по ItemPendingError и документацию по коллекциям.
ВозвращаетBoolean — Значение равно true, если по-прежнему в списке; false, если изначально значение было равно current, либо в данный момент равно afterLast.
|
movePrevious | () | метод |
public function movePrevious():Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Перемещает курсор на предыдущий элемент коллекции. При удачном выполнении свойство current обновляется для ссылки на объект в новом местоположении. Возвращает значение true, если результирующее свойство current является действительным, или false, если нет (значение свойства равно beforeFirst).
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError. Для получения дополнительной информации об использовании ItemPendingError см. документацию по ItemPendingError и документацию по коллекциям.
ВозвращаетBoolean — Значение равно true, если по-прежнему в списке; false, если начальное или текущее значение current равно beforeFirst. Например:
var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
var cursor:IViewCursor = myArrayCollection.createCursor();
cursor.seek(CursorBookmark.last);
while (!cursor.beforeFirst)
{
trace(current);
cursor.movePrevious();
}
|
remove | () | метод |
public function remove():Object| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Удаляет текущий элемент и возвращает его. Если местоположение курсора равно beforeFirst или afterLast, инициируется ошибка CursorError. При удалении любого элемента (кроме последнего) курсор перемещается на следующий элемент. При удалении последнего элемента курсор позиционируется на закладке AFTER_LAST.
Если элемент после удаленного элемента не является локальным и следует выполнить асинхронную операцию, инициируется ошибка ItemPendingError. Для получения дополнительной информации об использовании ItemPendingError см. документацию по ItemPendingError и документацию по коллекциям.
ВозвращаетObject — Удаленный элемент.
|
seek | () | метод |
public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Перемещает курсор в местоположение, определяемое смещением от указанной закладки. Если смещение является отрицательным числом, курсор позиционируется перед указанной закладкой на число элементов offset.
Если связанная коллекция является удаленной и не все ее элементы кэшированы локально, этот метод начинает асинхронную выборку из удаленной коллекции.
Если данные не являются локальными и необходимо выполнить асинхронную операцию, инициируется ошибка ItemPendingError. Для получения дополнительной информации об использовании ItemPendingError см. документацию по ItemPendingError и документацию по коллекциям.
Параметры
bookmark:CursorBookmark — Ссылка CursorBookmark на информацию о маркере, которая позволяет повторно установить его в указанное местоположение. Можно настроить этот параметр на значение, возвращаемое из свойства bookmark, или на одно из следующих постоянных значений закладки:
| |
offset:int (default = 0)beforeFirst или afterLast.
| |
prefetch:int (default = 0) |
Tue Jun 12 2018, 11:34 AM Z