XMLListCollection

パッケージ	mx.collections
クラス	public class XMLListCollection
継承	XMLListCollection ListCollectionView Proxy

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLListCollection クラスは、XMLList オブジェクトにコレクション機能を提供し、ネイティブ XMLList クラスのメソッドのいくつかを使用可能にします。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:XMLListCollection> tag inherits all the attributes of its superclass, and adds the following attributes:

  <mx:XMLListCollection
  Properties
  source="null"
  />

デフォルトの MXML プロパティsource

関連する API エレメント

XMLList
XML

パブリックプロパティ

継承されるパブリックプロパティを隠す

継承されるパブリックプロパティを表示

	プロパティ		定義元
		filterFunction : Function 関数の条件に一致しないアイテムを削除するためにビューが使用する関数です。	ListCollectionView
		length : int [読み取り専用] このビュー内のアイテムの数です。	ListCollectionView
		list : IList このコレクションビューがラップする IList です。	ListCollectionView
		sort : ISort ICollectionView に適用される ISort です。	ListCollectionView
		source : XMLList このコレクションの基になる XMLList です。	XMLListCollection

プロテクトプロパティ

継承されるプロテクトプロパティを隠す

継承されるプロテクトプロパティを表示

	プロパティ		定義元
		localIndex : Array ビューにソートまたはフィルターを適用すると、ソートによりアイテムの順序が変更されたか、またはフィルターによりアイテム数が減ったビューに含まれるアイテムの配列が localIndex プロパティにソート順に入れられます。	ListCollectionView

パブリックメソッド

継承されるパブリックメソッドを隠す

継承されるパブリックメソッドを表示

	メソッド		定義元
		XMLListCollection(source:XMLList = null) コンストラクターです。	XMLListCollection
		addAll(addList:IList):void アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。	ListCollectionView
		addAllAt(addList:IList, index:int):void アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	ListCollectionView
		addItem(item:Object):void 指定されたアイテムをリストの末尾に追加します。	ListCollectionView
		addItemAt(item:Object, index:int):void 指定されたインデックス位置にアイテムを追加します。	ListCollectionView
		attribute(attributeName:Object):XMLList XMLList 内の各 XML オブジェクトの attribute() メソッドを呼び出し、指定した attributeName と一致する結果オブジェクトの XMLList を返します。	XMLListCollection
		attributes():XMLList XMLList オブジェクト内の各 XML オブジェクトの attributes() メソッドを呼び出し、各 XML オブジェクトの属性の XMLList を返します。	XMLListCollection
		child(propertyName:Object):XMLList XMLList 内の各 XML オブジェクトの child() メソッドを呼び出し、指定したプロパティ名を持つ子を順に格納した XMLList を返します。	XMLListCollection
		children():XMLList XMLList 内の各 XML オブジェクトの children() メソッドを呼び出し、その結果を含む XMLList を返します。	XMLListCollection
		contains(item:Object):Boolean 指定されたオブジェクトをビューに含めるかどうかを返します。	ListCollectionView
		copy():XMLList XMLList オブジェクトの deep コピーを返します。	XMLListCollection
		createCursor():IViewCursor このビューに対して使用する新しい IViewCursor を作成します。	ListCollectionView
		descendants(name:Object = *):XMLList XMLList 内の各 XML オブジェクトの descendants() メソッドを呼び出し、その結果を含む XMLList を返します。	XMLListCollection
		disableAutoUpdate():void コレクション自体およびコレクション内のアイテムの変更がビューから送出されないようにします。	ListCollectionView
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	ListCollectionView
		elements(name:String = "*"):XMLList XMLList の各 XML オブジェクトの elements() メソッドを呼び出します。	XMLListCollection
		enableAutoUpdate():void 自動更新を有効にします。	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object 指定されたインデックス位置にあるアイテムを取得します。	ListCollectionView
		getItemIndex(item:Object):int リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。	ListCollectionView
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	ListCollectionView
		initialized(document:Object, id:String):void MXML タグを使用して ListCollectionView を作成したときに、MXML コンパイラーによって自動的に呼び出されます。	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void アイテムが更新されたビューを通知します。	ListCollectionView
		refresh():Boolean ビューにソートとフィルターを適用します。	ListCollectionView
		removeAll():void リストからすべてのアイテムを削除します。	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	ListCollectionView
		removeItemAt(index:int):Object 指定されたインデックス位置にあるアイテムを削除し、返します。	ListCollectionView
		setItemAt(item:Object, index:int):Object 指定されたインデックス位置にアイテムを配置します。	ListCollectionView
		text():XMLList XMLList 内の各 XML オブジェクトの text() メソッドを呼び出し、その結果を含む XMLList を返します。	XMLListCollection
		toArray():Array IList 実装と同じ順序で指定された配列を返します。	ListCollectionView
		toString():String [オーバーライド] XMLList の各 XML オブジェクトの toString() メソッドを呼び出して、XMLList のストリング表現を返します。	XMLListCollection
		toXMLString():String XMLList の各 XML オブジェクトの toXMLString() メソッドを呼び出して、XMLList のストリング表現を返します。	XMLListCollection
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	ListCollectionView

イベント

イベントの詳細についてはここをクリックしてください

継承されるイベントを隠す

継承されるイベントを表示

	イベント		概要	定義元
		collectionChange	ICollectionView が何らかの方法で更新されると送出されます。	ListCollectionView

プロパティの詳細

source

プロパティ

source:XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このコレクションの基になる XMLList です。 XMLListCollection オブジェクトは、元の XMLList オブジェクトに直接加えた変更を表しません。コレクションを変更するには、常に XMLListCollection メソッドを使用します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 listChanged イベントが送出されます。

実装
public function get source():XMLList
public function set source(value:XMLList):void

コンストラクターの詳細

()

コンストラクター

public function XMLListCollection(source:XMLList = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コンストラクターです。

指定された XMLList オブジェクトを使用して新しい XMLListCollection オブジェクトを作成します。

パラメーター

source:XMLList (default = null) — XMLListCollection オブジェクトによって表されるデータを保持する XMLList オブジェクトです。

メソッドの詳細

attribute

()

メソッド

public function attribute(attributeName:Object):XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList 内の各 XML オブジェクトの attribute() メソッドを呼び出し、指定した attributeName と一致する結果オブジェクトの XMLList を返します。

パラメーター

attributeName:Object — XMLList にある XML オブジェクトの、照合する属性です。

戻り値

XMLList — 一致する XML オブジェクトの XMLList です。

関連する API エレメント

XML.attribute()

attributes

()

メソッド

public function attributes():XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList オブジェクト内の各 XML オブジェクトの attributes() メソッドを呼び出し、各 XML オブジェクトの属性の XMLList を返します。

戻り値

XMLList — 結果の XML オブジェクトと属性の一覧を含む XMLList です。

関連する API エレメント

XML.attributes()

child

()

メソッド

public function child(propertyName:Object):XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList 内の各 XML オブジェクトの child() メソッドを呼び出し、指定したプロパティ名を持つ子を順に格納した XMLList を返します。

パラメーター

propertyName:Object — 照合するプロパティです。

戻り値

XMLList — 元の XMLList 内の XML オブジェクトの子のうち、一致した子の XMLList です。

関連する API エレメント

XML.child()

children

()

メソッド

public function children():XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList 内の各 XML オブジェクトの children() メソッドを呼び出し、その結果を含む XMLList を返します。

戻り値

XMLList — 元の XMLList 内の、XML オブジェクトの子の XMLList です。

関連する API エレメント

XML.children()

copy

()

メソッド

public function copy():XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList オブジェクトの deep コピーを返します。

戻り値

XMLList — XMLList オブジェクトのコピーです。

descendants

()

メソッド

public function descendants(name:Object = *):XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList 内の各 XML オブジェクトの descendants() メソッドを呼び出し、その結果を含む XMLList を返します。 name パラメーターは、XML オブジェクトの descendants() メソッドに渡されます。名前を指定しない場合は、descendants() メソッドに空のストリング（"*"）が渡されます。

パラメーター

name:Object (default = *) — 照合するエレメントの名前です。

戻り値

XMLList — 元の XMLList 内の XML オブジェクトの子孫（子、孫など）のうち、一致する子孫の XMLList です。

関連する API エレメント

XML.descendants()

elements

()

メソッド

public function elements(name:String = "*"):XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList の各 XML オブジェクトの elements() メソッドを呼び出します。 name パラメーターは、XML オブジェクトの elements() メソッドに渡されます。名前を指定しない場合は、elements() メソッドに空のストリング（"*"）が渡されます。

パラメーター

name:String (default = "*") — 照合するエレメントの名前です。

戻り値

XMLList — 元の XMLList 内の XML オブジェクトの子エレメントのうち、一致する子エレメントの XMLList です。

関連する API エレメント

XML.elements()

text

()

メソッド

public function text():XMLList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList 内の各 XML オブジェクトの text() メソッドを呼び出し、その結果を含む XMLList を返します。

戻り値

XMLList — 結果を含む XMLList です。

関連する API エレメント

XML.text()

toString

()

メソッド

override public function toString():String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList の各 XML オブジェクトの toString() メソッドを呼び出して、XMLList のストリング表現を返します。 prettyPrinting プロパティ（XML クラス）を true に設定すると、XMLList 内の各 XML オブジェクトの結果は、改行文字で区切られます。そうでない場合、prettyPrinting を false に設定すると、結果が返されるだけで、改行文字で区切られません。

toString() メソッドでは、単純なコンテンツを持つ XML オブジェクトに返されるストリングから、開始タグ、属性、名前空間宣言および終了タグが削除されます。単純なコンテンツを持つ XML オブジェクトに対して返されるストリングで上記が削除されないようにするには、toXMLString() メソッドを使用します。

戻り値

String — XMLList オブジェクトのストリング表現です。

関連する API エレメント

XML.prettyPrinting

toXMLString

()

メソッド

public function toXMLString():String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

XMLList の各 XML オブジェクトの toXMLString() メソッドを呼び出して、XMLList のストリング表現を返します。 prettyPrinting プロパティ（XML クラス）を true に設定すると、XMLList 内の各 XML オブジェクトの結果は、改行文字で区切られます。そうでない場合、prettyPrinting を false に設定すると、結果は連結されるだけで、改行文字で区切られません。

toXMLString() メソッドでは、単純なコンテンツを持つ XML オブジェクトに返されるストリングに、開始タグ、属性、名前空間宣言および終了タグが保持されます。単純なコンテンツを持つ XML オブジェクトに対して返されるストリングで上記を削除するには、toString() メソッドを使用します。

戻り値

String — XMLList のストリング表現です。

関連する API エレメント

XML.prettyPrinting

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

XMLListCollection - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.collections

source