HierarchicalCollectionView

Пакет	mx.collections
Класс	public class HierarchicalCollectionView
Наследование	HierarchicalCollectionView EventDispatcher Object
Реализует	IHierarchicalCollectionView, IXMLNotifiable

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Класс HierarchicalCollectionView обеспечивает иерархическое представление стандартной коллекции.

Синтаксис MXML expanded

Скрыть синтаксис MXML

The <mx.HierarchicalCollectionView> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:HierarchicalCollectionView
  Properties 
    showRoot="true|false"
    source="No default"
  />

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

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

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

	Свойство		Определено
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		hasRoot : Boolean [только для чтения] Флаг, который при значении true указывает, что текущий поставщик данных имеет корневой узел; например, отдельный узел верхнего уровня в иерархической структуре.	HierarchicalCollectionView
		length : int [только для чтения] Длина текущей анализируемой коллекции.	HierarchicalCollectionView
		openNodes : Object Массив объектов, содержащих элемент поставщика данных для всех открытых узлов ветви данных.	HierarchicalCollectionView
		showRoot : Boolean Логический флаг, указывающий, отобразить ли корневой узел поставщика данных.	HierarchicalCollectionView
		source : IHierarchicalData Исходные данные IHierarchicalCollectionView.	HierarchicalCollectionView

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

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

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

	Метод		Определено
		HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null) Конструктор.	HierarchicalCollectionView
		addChild(parent:Object, newChild:Object):Boolean Добавляет нижестоящий узел к узлу данных.	HierarchicalCollectionView
		addChildAt(parent:Object, newChild:Object, index:int):Boolean Добавление нижестоящего узла к узлу в указанной позиции индекса.	HierarchicalCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.	EventDispatcher
		closeNode(node:Object):void Закрывает узел, скрывая его нижестоящие элементы.	HierarchicalCollectionView
		contains(item:Object):Boolean Проверяет коллекцию на наличие элемента данных с использованием стандартной проверки равенства.	HierarchicalCollectionView
		createCursor():IViewCursor Возвращает новый экземпляр итератора представления по элементам в данном представлении.	HierarchicalCollectionView
		dispatchEvent(event:Event):Boolean Посылает событие в поток событий.	EventDispatcher
		getChildren(node:Object):ICollectionView Возвращает коллекцию нижестоящих элементов (при их наличии).	HierarchicalCollectionView
		getNodeDepth(node:Object):int Возвращает глубину узла в коллекции.	HierarchicalCollectionView
		getParentItem(node:Object):* Возвращает вышестоящий узел.	HierarchicalCollectionView
		hasEventListener(type:String):Boolean Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.	EventDispatcher
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		openNode(node:Object):void Открывает узел для отображения его нижестоящих узлов.	HierarchicalCollectionView
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		refresh():Boolean Применяет сортировку и фильтр к представлению.	HierarchicalCollectionView
		removeChild(parent:Object, child:Object):Boolean Удаляет нижестоящий узел из вышестоящего узла.	HierarchicalCollectionView
		removeChildAt(parent:Object, index:int):Boolean Удаляет нижестоящий узел из узла в указанной позиции индекса.	HierarchicalCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		toLocaleString():String Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.	EventDispatcher

События

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

Скрыть унаследованные события

Показать унаследованные события

	Событие		Сводка	Определено
		activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным.	EventDispatcher
		deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным.	EventDispatcher

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

hasRoot

свойство

hasRoot:Boolean [только для чтения]

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Флаг, который при значении true указывает, что текущий поставщик данных имеет корневой узел; например, отдельный узел верхнего уровня в иерархической структуре. XML и объект являются примерами типов данных, которые имеют корневой узел, тогда как списки и массивы – нет.

Реализация
public function get hasRoot():Boolean

length

свойство

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

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Длина текущей анализируемой коллекции.

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

openNodes

свойство

openNodes:Object

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Массив объектов, содержащих элемент поставщика данных для всех открытых узлов ветви данных.

Реализация
public function get openNodes():Object
public function set openNodes(value:Object):void

showRoot

свойство

showRoot:Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

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

Это свойство не влияет на источник без корневого узла, например на объекты списка и массива.

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

Это свойство можно использовать в качестве источника для связывания данных. При изменении этого свойства отправляется событие propertyChange .

Реализация
public function get showRoot():Boolean
public function set showRoot(value:Boolean):void

source

свойство

source:IHierarchicalData

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Исходные данные IHierarchicalCollectionView.

Реализация
public function get source():IHierarchicalData
public function set source(value:IHierarchicalData):void

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

()

Конструктор

public function HierarchicalCollectionView(hierarchicalData:IHierarchicalData = null, argOpenNodes:Object = null)

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

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

Параметры

	`hierarchicalData:IHierarchicalData` (default = `null`) — Структура данных, содержащая иерархические данные.

	`argOpenNodes:Object` (default = `null`) — Объект, определяющий появляющийся узел как открытый.

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

addChild

()

метод

public function addChild(parent:Object, newChild:Object):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Добавляет нижестоящий узел к узлу данных.

Параметры

	`parent:Object` — Объект, определяющий вышестоящий узел.

	`newChild:Object` — Объект, определяющий новый узел.

Возвращает

Boolean — Значение равно true при успешном добавлении узла.

addChildAt

()

метод

public function addChildAt(parent:Object, newChild:Object, index:int):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Добавление нижестоящего узла к узлу в указанной позиции индекса. Эта реализация позволяет выполнять следующее:

Если parent содержит значение null или undefined, вставляет child в указанную позицию index в коллекции, указанной с помощью параметра source.
Если parent имеет поле или свойство children, этот метод добавляет к нему child в указанной позиции index. В этом случае указывать source не требуется.
Если значение parent не имеет поля или свойства children, этот метод добавляет children к parent. Затем этот метод добавляет child к вышестоящему элементу в позиции index. В этом случае указывать source не требуется.
Если значение index превышает длину коллекции или количество нижестоящих элементов в вышестоящем узле, объект добавляется в качестве последнего нижестоящего элемента.

Параметры

	`parent:Object` — Объект, определяющий вышестоящий узел.

	`newChild:Object` — Объект, определяющий нижестоящий узел.

	`index:int` — Отсчитываемый от нуля индекс местоположения для вставки нижестоящего узла.

Возвращает

Boolean — Содержит значение true, если нижестоящий элемент добавлен успешно.

closeNode

()

метод

public function closeNode(node:Object):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Закрывает узел, скрывая его нижестоящие элементы.

Параметры

node:Object — Object, определяющий узел.

contains

()

метод

public function contains(item:Object):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Проверяет коллекцию на наличие элемента данных с использованием стандартной проверки равенства.

Параметры

item:Object — Object, определяющий узел для поиска.

Возвращает

Boolean — Содержит значение true, если элемент данных находится в коллекции, и false, если отсутствует.

createCursor

()

метод

public function createCursor():IViewCursor

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Возвращает новый экземпляр итератора представления по элементам в данном представлении.

Возвращает

IViewCursor — Экземпляр IViewCursor.

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

mx.utils.IViewCursor

getChildren

()

метод

public function getChildren(node:Object):ICollectionView

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Возвращает коллекцию нижестоящих элементов (при их наличии).

Параметры

node:Object — Object, определяющий узел. Если значение равно null, возвращает коллекцию узлов верхнего уровня.

Возвращает

ICollectionView — Экземпляр ICollectionView, включающий нижестоящие узлы.

getNodeDepth

()

метод

public function getNodeDepth(node:Object):int

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Возвращает глубину узла в коллекции.

Параметры

node:Object — Object, определяющий узел.

Возвращает

int — Глубина узла.

getParentItem

()

метод

public function getParentItem(node:Object):*

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Возвращает вышестоящий узел. Вышестоящий элемент узла верхнего уровня содержит значение null.

Параметры

node:Object — Object, определяющий узел.

Возвращает

* — Вышестоящий узел, содержащий данный узел; значение null для узла верхнего уровня и undefined, если вышестоящий узел определить невозможно.

openNode

()

метод

public function openNode(node:Object):void

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Открывает узел для отображения его нижестоящих узлов.

Параметры

node:Object — Object, определяющий узел.

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.

removeChild

()

метод

public function removeChild(parent:Object, child:Object):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Удаляет нижестоящий узел из вышестоящего узла.

Параметры

	`parent:Object` — Объект, который определяет вышестоящий узел, и значение `null` для узлов верхнего уровня.

	`child:Object` — Объект, который определяет нижестоящий узел, подлежащий удалению.

Возвращает

Boolean — Значение равно true, если узел успешно удален.

removeChildAt

()

метод

public function removeChildAt(parent:Object, index:int):Boolean

Язык версии:

ActionScript 3.0

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

Flex 3

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

Flash Player 9, AIR 1.1

Удаляет нижестоящий узел из узла в указанной позиции индекса.

Параметры

	`parent:Object` — Объект, определяющий вышестоящий узел.

	`index:int` — Отсчитываемый от нуля индекс нижестоящего узла, подлежащего удалению, по отношению к вышестоящему узлу.

Возвращает

Boolean — Содержит значение true, если нижестоящий узел успешно удален.

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

HierarchicalCollectionView - AS3 Flex

Классы x

hasRoot

length

openNodes

showRoot

source