Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
mx.collections 

ArrayList  - AS3 Flex

パッケージmx.collections
クラスpublic class ArrayList
継承ArrayList Inheritance EventDispatcher Inheritance Object
実装 IList, IExternalizable, IPropertyChangeNotifier
サブクラス Conflicts

言語バージョン: ActionScript 3.0
製品バージョン: Flex 4
ランタイムバージョン: Flash Player 10, AIR 1.5

ArrayList クラスは、IList の単純な実装であり、補助配列をデータソースとして使用します。補助配列のアイテムにアクセスして操作するには、IList インターフェイスのメソッドとプロパティを使用します。ArrayList インスタンスに対して操作を行うと、データソースが変更されます。例えば、ArrayList の removeItemAt() メソッドを使用すると、基になる Array からアイテムが削除されます。この基本クラスは、ItemPendingErrors をスローしませんが、サブクラスはスローする場合があります。
  <mx:ArrayList
  Properties
  source="null"
  />
  

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



パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
  length : int
[読み取り専用] リスト内のアイテムの数を取得します。
ArrayList
  source : Array
この ArrayList のソース配列。
ArrayList
  uid : String
このリストの一意の ID へのアクセスを提供します。
ArrayList
パブリックメソッド
 メソッド定義元
  
ArrayList(source:Array = null)
指定された配列をそのソースとして使用して、新しい ArrayList を作成します。
ArrayList
  
addAll(addList:IList):void
アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。
ArrayList
  
addAllAt(addList:IList, index:int):void
アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。
ArrayList
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
指定されたアイテムをリストの末尾に追加します。
ArrayList
  
addItemAt(item:Object, index:int):void
指定されたインデックス位置にアイテムを追加します。
ArrayList
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
  
getItemAt(index:int, prefetch:int = 0):Object
指定されたインデックス位置にあるアイテムを取得します。
ArrayList
  
アイテムがリスト内にある場合、インデックスを返します(getItemAt(index) == item)。
ArrayList
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
  
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
アイテムが更新されたビューを通知します。
ArrayList
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
リストからすべてのアイテムを削除します。
ArrayList
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
  
指定されたアイテムをリストから削除します(存在する場合)。
ArrayList
  
指定されたインデックス位置にあるアイテムを削除し、返します。
ArrayList
  
setItemAt(item:Object, index:int):Object
指定されたインデックス位置にアイテムを配置します。
ArrayList
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
IList 実装と同じ順序で指定された配列を返します。
ArrayList
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
  
[オーバーライド] この ArrayList のコンテンツをストリングに出力して、返します。
ArrayList
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
プロテクトメソッド
 メソッド定義元
  
リストに含まれるアイテムが ObjectChange イベントを送出すると呼び出されます。
ArrayList
  
アイテムが IEventDispatcher の場合は、それが更新されていないかどうかを監視します。
ArrayList
  
アイテムが IEventDispatcher の場合は、それが更新されていないかどうかの監視を停止します。
ArrayList
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
  IList が何らかの方法で更新されると送出されます。ArrayList
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
プロパティの詳細

length

プロパティ
length:int  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

リスト内のアイテムの数を取得します。ArrayList は、-1 を返さないように常にその長さを認識している必要があります。ただし、サブクラスがその動作をオーバーライドする場合があります。

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



実装
    public function get length():int

source

プロパティ 
source:Array

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

この ArrayList のソース配列。IList インターフェイスを通じて行った変更はすべて、ソース配列に反映されます。ソース配列が指定されなかった場合、ArrayList は、ソース配列を内部的に作成します。基になる配列に対して直接変更を加えても(例えば、List.source.pop() の呼び出しなど)、CollectionEvents は送出されません。



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

uid

プロパティ 
uid:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

このリストの一意の ID へのアクセスを提供します。



実装
    public function get uid():String
    public function set uid(value:String):void
コンストラクターの詳細

ArrayList

()コンストラクター
public function ArrayList(source:Array = null)

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定された配列をそのソースとして使用して、新しい ArrayList を作成します。ソースが指定されていない場合は、空の配列が使用されます。

パラメーター
source:Array (default = null) — ArrayList のソースとして使用する Array です。
メソッドの詳細

addAll

()メソッド
public function addAll(addList:IList):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。

パラメーター

addList:IList — 現在のリストに追加するアイテムのリストです。

addAllAt

()メソッド 
public function addAllAt(addList:IList, index:int):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。アイテムはインデックス位置に、返される順序で配置されます。

パラメーター

addList:IList — 現在のリストに追加するアイテムのリストです。
 
index:int — 新しいアイテムを追加する、現在のリストの位置です。

addItem

()メソッド 
public function addItem(item:Object):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたアイテムをリストの末尾に追加します。addItemAt(item, length) と同等です。

パラメーター

item:Object — 追加するアイテム

addItemAt

()メソッド 
public function addItemAt(item:Object, index:int):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたインデックス位置にアイテムを追加します。このインデックス位置の後にあったすべてのアイテムは、1 つだけ移動されます。

パラメーター

item:Object — インデックス位置に配置するアイテム
 
index:int — アイテムを配置するインデックス位置


例外
RangeError — インデックスが 0 未満であるか、または長さより大きい場合

getItemAt

()メソッド 
public function getItemAt(index:int, prefetch:int = 0):Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたインデックス位置にあるアイテムを取得します。

パラメーター

index:int — アイテムを取得するリストのインデックス
 
prefetch:int (default = 0) — アイテムがローカルでない場合に要求時に取得するアイテムの方向と量を示す int 値です。

戻り値
Object — そのインデックス位置にあるアイテムです。アイテムがない場合は null です

例外
Error — そのインデックスのデータをリモートからロードする必要がある場合
 
RangeError — index < 0 または index >= length の場合

getItemIndex

()メソッド 
public function getItemIndex(item:Object):int

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムがリスト内にある場合、インデックスを返します(getItemAt(index) == item)。この実装では、検索は直線的に行われるため、O(n) である点に注意してください。

パラメーター

item:Object — 検索するアイテム

戻り値
int — アイテムのインデックスで、アイテムがリスト内にない場合は -1 です。

itemUpdated

()メソッド 
public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムが更新されたビューを通知します。これは、ビューのコンテンツが IEventDispatcher を実装しない場合に便利です。プロパティを指定すると、ビューは通知メカニズムを最適化できます。 プロパティを指定しないと、ビュー全体の単純な更新が選択されます。

パラメーター

item:Object — 更新されたビュー内のアイテムです。
 
property:Object (default = null) — 更新されたプロパティを指定する String、QName または int です。
 
oldValue:Object (default = null) — そのプロパティの古い値です。 プロパティが null の場合はアイテムの古い値を指定できます。
 
newValue:Object (default = null) — そのプロパティの新しい値です。 プロパティが null の場合、アイテムは新しい値と見なされるので、指定する必要はありません。

関連する API エレメント

itemUpdateHandler

()メソッド 
protected function itemUpdateHandler(event:PropertyChangeEvent):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

リストに含まれるアイテムが ObjectChange イベントを送出すると呼び出されます。CollectionEventKind.UPDATE オブジェクトでそれをラップします。

パラメーター

event:PropertyChangeEvent — ObjectChange イベントのイベントオブジェクトです。

removeAll

()メソッド 
public function removeAll():void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

リストからすべてのアイテムを削除します。

removeItem

()メソッド 
public function removeItem(item:Object):Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたアイテムをリストから削除します(存在する場合)。

パラメーター

item:Object — 削除する必要のあるアイテムへのオブジェクト参照。

戻り値
Boolean — アイテムが削除されたかどうかを示すブール値。

removeItemAt

()メソッド 
public function removeItemAt(index:int):Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたインデックス位置にあるアイテムを削除し、返します。このインデックスより後にあったアイテムは、インデックスが 1 つずつ前になります。

パラメーター

index:int — アイテムが削除されるインデックスです。

戻り値
Object — 削除されたアイテムです。

例外
RangeError — index < 0 または index >= length の場合。

setItemAt

()メソッド 
public function setItemAt(item:Object, index:int):Object

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

指定されたインデックス位置にアイテムを配置します。アイテムが既にそのインデックス位置にある場合は、新しいアイテムに置き換えられ、インデックス位置にあったアイテムが返されます。

パラメーター

item:Object — インデックスの新しい値
 
index:int — アイテムを配置するインデックス位置

戻り値
Object — 置き換えられたアイテムです。アイテムがない場合は null です

例外
RangeError — インデックスが 0 未満であるか、または長さ以上の場合

startTrackUpdates

()メソッド 
protected function startTrackUpdates(item:Object):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムが IEventDispatcher の場合は、それが更新されていないかどうかを監視します。このメソッドは、addItemAt メソッドによって呼び出され、ソースが最初に割り当てられるときに呼び出されます。

パラメーター

item:ObjectaddItemAt() メソッドに渡されるアイテムです。

stopTrackUpdates

()メソッド 
protected function stopTrackUpdates(item:Object):void

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

アイテムが IEventDispatcher の場合は、それが更新されていないかどうかの監視を停止します。このメソッドは removeItemAt() メソッドと removeAll() メソッドによって呼び出され、新しいソースが割り当てられる前に呼び出されます。

パラメーター

item:ObjectremoveItemAt() メソッドに渡されるアイテムです。

toArray

()メソッド 
public function toArray():Array

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

IList 実装と同じ順序で指定された配列を返します。

戻り値
Array — IList 実装と同じ順序で指定された配列です。

例外
Error — リモートからのデータのロードがまだ完了していない場合

toString

()メソッド 
override public function toString():String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

この ArrayList のコンテンツをストリングに出力して、返します。

戻り値
String — ArrayList の内容を含む文字列です。
イベントの詳細

collectionChange

イベント
イベントオブジェクトの型: mx.events.CollectionEvent
プロパティ CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

IList が何らかの方法で更新されると送出されます。

CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されたときに送出されるイベントのイベントオブジェクトの type プロパティ値を定義します。

イベントオブジェクトの各プロパティには次の値が設定されています。 イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。

プロパティ
bubblesfalse
cancelablefalse
currentTargetイベント処理を行うイベントリスナーの定義用オブジェクトを表します。 例えば、イベントリスナーの登録に myButton.addEventListener() を使用すると、myButton の値は currentTarget となります。
itemsイベントの影響を受けるアイテムの情報を持つオブジェクトの配列です。 このフィールドの内容はイベントの種類に応じて異なります。詳細については、items プロパティを参照してください。
kindイベントの種類です。 有効な値が定数として CollectionEventKind クラスに定義されます。
locationitems プロパティで指定されたアイテムのターゲットコレクション内における位置です。
oldLocationitems プロパティで指定されたアイテムのコレクション内における以前の位置です。
targetイベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。 イベントを受け取るオブジェクトに常にアクセスするには、currentTarget プロパティを使用してください。
typeCollectionEvent.COLLECTION_CHANGE




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。