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 データプロバイダーのルートノードを表示するかどうかを指定する 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 と Object はルートノードがあるデータ型の例であり、リストと配列はルートノードがないタイプの例です。

実装
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

データプロバイダーのルートノードを表示するかどうかを指定する Boolean フラグです。このプロパティを false に設定すると、ソースデータにルートノードがある場合でも、コレクションにルートアイテムは含まれません。ルートアイテムの下位要素のみがコレクションに含まれます。

このプロパティは、List オブジェクトや Array オブジェクトなどのルートノードのないソースには影響しません。

デフォルト値： 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 または未定義の場合、child をコレクション内の index（source で指定）に挿入します。
parent に children フィールドまたはプロパティが存在する場合、このメソッドは child を index の位置に追加します。この場合、source は不要です。
parent に children フィールドまたはパラメーターがない場合、このメソッドは children を parent に追加します。次にこのメソッドは、child を parent の index の位置に追加します。この場合、source は不要です。
index の値がコレクションの長さより大きいか、親に含まれている子の数より大きい場合、オブジェクトを最後の子として追加します。

パラメーター

	`parent:Object` — 親ノードを定義するオブジェクトです。

	`newChild:Object` — 子ノードを定義するオブジェクトです。

	`index:int` — 子ノードを挿入する位置の 0 から始まるインデックスです。

戻り値

Boolean — 子が正常に追加された場合は true です。

closeNode

()

メソッド

public function closeNode(node:Object):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ノードを閉じて子を非表示にします。

パラメーター

node:Object — ノードを定義するオブジェクトです。

contains

()

メソッド

public function contains(item:Object):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

標準の等価テストを使用して、データアイテムのコレクションをチェックします。

パラメーター

item:Object — 検索するノードを定義するオブジェクトです。

戻り値

Boolean — データアイテムがコレクションに含まれている場合は true、含まれていない場合は false です。

createCursor

()

メソッド

public function createCursor():IViewCursor

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビューのアイテムを列挙するビューイテレータの新しいインスタンスを返します。

戻り値

IViewCursor — IViewCursor インスタンスです。

getChildren

()

メソッド

public function getChildren(node:Object):ICollectionView

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

子のコレクションが存在する場合は、このコレクションを返します。

パラメーター

node:Object — ノードを定義するオブジェクトです。 null の場合、最上位ノードのコレクションを返します。

戻り値

ICollectionView — 子ノードを含む ICollectionView インスタンスです。

getNodeDepth

()

メソッド

public function getNodeDepth(node:Object):int

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コレクション内のノードの深さを返します。

パラメーター

node:Object — ノードを定義するオブジェクトです。

戻り値

int — ノードの深さです。

getParentItem

()

メソッド

public function getParentItem(node:Object):*

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ノードの親を返します。最上位ノードの親は null です。

パラメーター

node:Object — ノードを定義するオブジェクトです。

戻り値

* — ノードを含む親ノードです。最上位ノードの場合は null、親を決定できない場合は undefined です。

openNode

()

メソッド

public function openNode(node:Object):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ノードを開いて子を表示します。

パラメーター

node:Object — ノードを定義するオブジェクトです。

refresh

()

メソッド

public function refresh():Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューにソートとフィルターを適用します。 ICollectionView は、ソートまたはフィルターの変更を自動検出しません。したがって、refresh() メソッドを呼び出してビューを更新する前に、sort プロパティまたは filterFunction プロパティを設定する必要があります。 ICollectionView が IMXMLObject インターフェイスも実装する場合は、refresh() メソッドを initialized() メソッドから呼び出す必要があります。

更新が正常に完了した場合は true を返し、ソートが完了していない場合（アイテムが保留中の場合など）は false を返します。ビューのクライアントは、CollectionEventKind.REFRESH kind プロパティを含む CollectionEvent イベントを待機して、refresh() 操作が完了したことを確認する必要があります。

戻り値

Boolean — refresh() が完了した場合は 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` — 削除する子ノードの、親からの相対的な位置を示す、0 から始まるインデックスです。

戻り値

Boolean — 子が正常に削除された場合は true です。

法律上の注意 | プライバシーポリシー

HierarchicalCollectionView - AS3 Flex

クラス x

hasRoot

length

openNodes

showRoot

source