Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
mx.events 

CollectionEvent  - AS3 Flex

Пакетmx.events
Классpublic class CollectionEvent
НаследованиеCollectionEvent Inheritance Event Inheritance Object

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Класс mx.events.CollectionEvent представляет событие, передаваемое при изменении связанной коллекции.

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



Общедоступные свойства
 СвойствоОпределено
 Inheritedbubbles : Boolean
[только для чтения] Определяет, является ли событие событием восходящей цепочки.
Event
 Inheritedcancelable : Boolean
[только для чтения] Указывает, можно ли предотвратить поведение, связанное с событием.
Event
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcurrentTarget : Object
[только для чтения] Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
Event
 InheritedeventPhase : uint
[только для чтения] Текущая фаза в потоке событий.
Event
  items : Array
Если значение kind равно CollectionEventKind.ADD или CollectionEventKind.REMOVE, свойство items представляет собой массив добавленных/удаленных элементов.
CollectionEvent
  kind : String
Указывает вид произошедшего события.
CollectionEvent
  location : int
Если значение kind равно CollectionEventKind.ADD, CollectionEventKind.MOVE, CollectionEventKind.REMOVE или CollectionEventKind.REPLACE, это свойство представляет собой отсчитываемый от нуля индекс коллекции элементов, указанных в свойстве items.
CollectionEvent
  oldLocation : int
Если значение kind равно CollectionEventKind.MOVE, это свойство представляет собой отсчитываемый от нуля индекс в целевой коллекции предыдущего местоположения элементов, указанных свойством items.
CollectionEvent
 Inheritedtarget : Object
[только для чтения] Целевой объект события.
Event
 Inheritedtype : String
[только для чтения] Тип события.
Event
Общедоступные методы
 МетодОпределено
  
CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)
Конструктор.
CollectionEvent
 Inherited
Создает дубликат экземпляра подкласса Event.
Event
 Inherited
formatToString(className:String, ... arguments):String
Служебная функция для реализации метода toString() в пользовательских классах ActionScript 3.0 Event.
Event
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Проверяет, выполнялся ли для события вызова метода preventDefault().
Event
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Отменяет поведение по умолчанию для события, если такое поведение можно отменить.
Event
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Отменяет обработку прослушивателей событий в текущем узле, а также во всех узлах, которые следуют в потоке событий за текущим узлом.
Event
 Inherited
Отменяет обработку прослушивателей событий в узлах, которые следуют в потоке событий за текущим узлом.
Event
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
 Inherited
Возвращает строку, содержащую все свойства объекта Event.
Event
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Общедоступные константы
 КонстантаОпределено
  COLLECTION_CHANGE : String = "collectionChange"
[статические] Константа CollectionEvent.COLLECTION_CHANGE определяет значение свойства type объекта события, передаваемого при изменении коллекции.
CollectionEvent
Сведения о свойстве

items

свойство
public var items:Array

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Если значение kind равно CollectionEventKind.ADD или CollectionEventKind.REMOVE , свойство items представляет собой массив добавленных/удаленных элементов. Если значение kind равно CollectionEventKind.REPLACE или CollectionEventKind.UPDATE, свойство items представляет собой массив объектов PropertyChangeEvent с информацией об элементах, задействованных событием. Если значение изменяется, следует запросить поля newValue и oldValue объектов PropertyChangeEvent для определения старых и новых значений. Если значение kind равно CollectionEventKind.REFRESH или CollectionEventKind.RESET, этот массив имеет нулевую длину.

Значением по умолчанию является [ ].

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

kind

свойство 
public var kind:String

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Указывает вид произошедшего события. Значение свойства может быть равно одному из значений класса CollectionEventKind или null, если вид неизвестен.

Значением по умолчанию является null.

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

location

свойство 
public var location:int

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Если значение kind равно CollectionEventKind.ADD, CollectionEventKind.MOVE, CollectionEventKind.REMOVE или CollectionEventKind.REPLACE, это свойство представляет собой отсчитываемый от нуля индекс коллекции элементов, указанных в свойстве items.

Значением по умолчанию является -1.

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

oldLocation

свойство 
public var oldLocation:int

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Если значение kind равно CollectionEventKind.MOVE, это свойство представляет собой отсчитываемый от нуля индекс в целевой коллекции предыдущего местоположения элементов, указанных свойством items.

Значением по умолчанию является -1.

Сведения о конструкторе

CollectionEvent

()Конструктор
public function CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Конструктор.

Параметры
type:String — Тип события; указывает действие, инициировавшее событие.
 
bubbles:Boolean (default = false) — Указывает, может ли событие передаваться вверх по иерархии списка отображения.
 
cancelable:Boolean (default = false) — Указывает, существует ли возможность предотвращения поведения, связанного с событием.
 
kind:String (default = null) — Указывает вид произошедшего события. Значение параметра может быть равно одному из значений в классе CollectionEventKind или null, если вид неизвестен.
 
location:int (default = -1) — Если значение kind равно CollectionEventKind.ADD, CollectionEventKind.MOVE, CollectionEventKind.REMOVE или CollectionEventKind.REPLACE, оно указывает, где в целевой коллекции находятся элементы, указанные в свойстве items.
 
oldLocation:int (default = -1) — Если значение kind равно CollectionEventKind.MOVE, оно определяет прежнее местоположение в целевой коллекции элементов, указанных свойством items.
 
items:Array (default = null) — Массив объектов с информацией об элементах, задействованных событием, как указано в свойстве items. Если значение kind равно CollectionEventKind.REFRESH или CollectionEventKind.RESET, этот массив имеет нулевую длину.
Сведения о константе

COLLECTION_CHANGE

Константа
public static const COLLECTION_CHANGE:String = "collectionChange"

Язык версии: ActionScript 3.0
Версия продукта: Flex 3
Версии среды выполнения: Flash Player 9, AIR 1.1

Константа CollectionEvent.COLLECTION_CHANGE определяет значение свойства type объекта события, передаваемого при изменении коллекции.

Свойства объекта события имеют следующие значения. Не все свойства являются значимыми для каждого из видов событий. Дополнительную информацию см. в подробных описаниях свойств.

СвойствоЗначение
bubblesfalse
cancelablefalse
currentTargetОбъект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton.
itemsМассив объектов с информацией об элементах, задействованных этим событием. Содержимое этого поля зависит от вида события; для получения подробной информации см. описание свойства items
kindВид события. Допустимые значения определены в классе CollectionEventKind как константы.
locationМестоположение внутри целевой коллекции элементов, указанное в свойстве items.
oldLocationпрежнее местоположение элемента в коллекции, указанное в свойстве items.
targetОбъект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие.
typeCollectionEvent.COLLECTION_CHANGE





[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.