List クラス

Top | Back | Next

Listクラス

　ComboBoxクラスではボタン、テキストフィールド、リストの３つが1つとなったものとなったオブジェクトと説明しましたが、今回はその中のリストの説明をします。リストは複数のアイテムを選択（Ctrlキーを押しながら）する事ができます。

コンポーネントインスペクタ

data

リストのデータとなる値の配列です。

labels

リストのラベル値となるテキスト配列です。

multipleSelection

　リストの値を複数選択できるかできないかをブール値で設定します。複数の値を選択できる (true)、または選択できない (false)

rowHeight

設定したラベル同士の間隔をピクセル数で表す事ができます。

`rowHeight` 20 の場合	`rowHeight` 30 の場合

Listの作成方法

　リストを作成するにはコンポーネントパネルからドラッグ& ドロップでステージ上に配置する方法があります。配置してからコンポーネントインスペクタのパラメータを設定します。

ActionScriptでリストを作る場合

createObject(linkageName,instanceName,depth,initObject)

linkageName　リンケージ識別子の名前
instanceName　インスタンス名
depth　深度
initObject　新しいインスタンスの初期化プロパティが含まれるオブジェクト

　下記の例ではインスタンス名myListというリストを作成します。作成時の配置位置はステージの一番左上(0,0)に作成されます。予めライブラリにListのシンボルを用意しておいてください。

this.createObject("List", "myList", 0);

　今度は_x プロパティ、_y プロパティで座標位置を決めて作成してみましょう。_x プロパティ、_y プロパティはUIObjectクラスのプロパティから継承されています。

this.createObject("List", "myList", 0);
this.myList._x = 150;
this.myList._y = 100;

List クラスのメソッドを使用

　ここではリストにインデックスを指定してアイテムを追加するメソッドList.addItemAt()を使用してインデックス1にappleというアイテムを追加しています。下記でList クラスのメソッドプロパティを紹介していますので参照してください。

List.addItemAt(インデックス番号,{label:ラベル名,data:データ名})

　今回ボタンを押したらインデックス位置1にアイテムを追加するようにしました。リストの中のラベルは配列なので、インデックス番号が割り当てられています。インデックス番号は0から始まりますので、1にアイテムを追加すると、リストの2番目の位置に表示されます。

※ ラベルが1つもないリストにインデックス番号を指定してアイテムを追加する事はできません。データはなくても構いませんが、ラベルは設定してください。

on (release) {
	myList.addItemAt(1, {label:'apple'});
}

　上記のコードではインデックス番号1にラベルappleを追加しました。通常はラベル名appleのデータとなる値を設定するので、下記のコードではdataをfruit（フルーツ）としました。

on (release) {
	myList.addItemAt(1, {label:'apple', data:fruit});
}

List クラスのメソッド一覧

次の表は List クラスのメソッドの一覧です。

メソッド	説明
List.addItem()	リストの末尾にアイテムを追加します。
List.addItemAt()	指定のインデックス位置にアイテムを追加します。
List.getItemAt()	指定のインデックス位置のアイテムを返します。
List.removeAll()	リストからすべてのアイテムを削除します。
List.removeItemAt()	指定されたインデックス位置の項目を削除します。
List.replaceItemAt()	指定のインデックス位置にあるアイテムを別のアイテムで置き換えます。
List.setPropertiesAt()	指定のアイテムに指定のプロパティを適用します。
List.sortItems()	リスト内のアイテムを指定の比較関数に従って並べ替えます。
List.sortItemsBy()	リスト内のアイテムを指定のプロパティに従って並べ替えます。

UIObject クラスから継承されるメソッド

次の表は List クラスが UIObject クラスから継承するメソッドの一覧です。これらのメソッドを呼び出すときは、listInstance.methodName の形式を使用します。

メソッド	説明
UIObject.createClassObject()	指定したクラスのオブジェクトを作成します。
UIObject.createObject()	オブジェクト上にサブオブジェクトを作成します。
UIObject.destroyObject()	コンポーネントインスタンスを破棄します。
UIObject.doLater()	プロパティインスペクタおよび [コンポーネントインスペクタ] パネルにパラメータが設定されている場合に、関数を呼び出します。
UIObject.getStyle()	スタイル宣言またはオブジェクトからスタイルプロパティを取得します。
UIObject.invalidate()	次のフレーム間隔で再描画されるようにオブジェクトにマークを付けます。
UIObject.move()	オブジェクトを指定の位置に移動します。
UIObject.redraw()	オブジェクトの検証を強制的に実行して、オブジェクトを現在のフレーム内に描画します。
UIObject.setSize()	オブジェクトのサイズを指定のサイズに変更します。
UIObject.setSkin()	オブジェクトのスキンを設定します。
UIObject.setStyle()	スタイル宣言またはオブジェクトのスタイルプロパティを設定します。

UIComponent クラスから継承されるメソッド

次の表は List クラスが UIComponent クラスから継承するメソッドの一覧です。これらのメソッドを呼び出すときは、listInstance.methodName の形式を使用します。

メソッド	説明
UIComponent.getFocus()	現在フォーカスがあるオブジェクトへの参照を返します。
UIComponent.setFocus()	このコンポーネントインスタンスにフォーカスを設定します。

List クラスのプロパティ一覧

次の表は List クラスのプロパティの一覧です。

プロパティ	説明
List.cellRenderer	リストの各行を表示するためのクラスまたはシンボルを割り当てます。
List.dataProvider	リストアイテムのソースです。
List.hPosition	リストの水平位置です。
List.hScrollPolicy	水平スクロールバーを表示するか (`"on"`)、表示しないか (`"off"`) を指定します。
List.iconField	各アイテム内のどのフィールドをアイコンの指定に使用するかを指定します。
List.iconFunction	使用するアイコンを決定する関数です。
List.labelField	各アイテム内のどのフィールドをラベルテキストとして使用するかを指定します。
List.labelFunction	各アイテム内のどのフィールドをラベルテキストとして使用するかを決定する関数です。
List.length	リスト内のアイテムの数です。このプロパティは読み取り専用です。
List.maxHPosition	List.hScrollPolicy が `"on"` に設定されているときに、リストを右方向にスクロールできるピクセル数を指定します。
List.multipleSelection	リスト内で複数選択を許可するか (`true`)、許可しないか (`false`) を指定します。
List.rowCount	リスト内に少なくとも部分的に表示される行数です。
List.rowHeight	リストの各行の高さをピクセル単位で表します。
List.selectable	リストが選択可能か (`true`)、そうでないか (`false`) を指定します。
List.selectedIndex	単一選択リスト内で選択されているアイテムのインデックスです。
List.selectedIndices	複数選択リスト内で選択されているアイテムの配列です。
List.selectedItem	単一選択リスト内で選択されているアイテムです。このプロパティは読み取り専用です。
List.selectedItems	複数選択リスト内で選択されているアイテムオブジェクト群です。このプロパティは読み取り専用です。
List.vPosition	リストの一番上に表示されるアイテムです。
List.vScrollPolicy	垂直スクロールバーを表示するか (`"on"`)、表示しないか (`"off"`)、必要に応じて表示するか (`"auto"`) を指定します。

UIObject クラスから継承されるプロパティ

次の表は List クラスが UIObject クラスから継承するプロパティの一覧です。これらのプロパティにアクセスするときは、listInstance.propertyName の形式を使用します。

プロパティ	説明
UIObject.bottom	オブジェクトの下端の位置を、親の下端の位置を基準にして表します。読み取り専用。
UIObject.height	オブジェクトの高さをピクセル単位で表します。読み取り専用。
UIObject.left	オブジェクトの左端の位置をピクセル単位で表します。読み取り専用。
UIObject.right	オブジェクトの右端の位置を、親の右端の位置を基準にして表します。読み取り専用。
UIObject.scaleX	オブジェクトの x 方向の伸縮率を、親を基準にして表した数値です。
UIObject.scaleY	オブジェクトの y 方向の伸縮率を、親を基準にして表した数値です。
UIObject.top	オブジェクトの上端の位置を、親の位置を基準にして表します。読み取り専用。
UIObject.visible	オブジェクトを表示するか (`true`)、表示しないか (`false`) を示すブール値です。
UIObject.width	オブジェクトの幅をピクセル単位で表します。読み取り専用。
UIObject.x	オブジェクトの左端の位置をピクセル単位で表します。読み取り専用。
UIObject.y	オブジェクトの上端をピクセル単位で表します。読み取り専用。

UIComponent クラスから継承されるプロパティ

次の表は List クラスが UIComponent クラスから継承するプロパティの一覧です。これらのプロパティにアクセスするときは、listInstance.propertyName の形式を使用します。

プロパティ	説明
UIComponent.enabled	コンポーネントがフォーカスと入力を受け付けられるかどうかを示します。
UIComponent.tabIndex	ドキュメント内のコンポーネントのタブ順序を示す数値です。

List クラスのイベント一覧

次の表は、List クラスのイベントの一覧です。

イベント	説明
List.change	ユーザーの操作によって選択が変更されたときにブロードキャストします。
List.itemRollOut	ポインタがリストアイテム上を離れたときにブロードキャストします。
List.itemRollOver	ポインタがリストアイテムの上に移動したときにブロードキャストします。
List.scroll	リストをスクロールするときにブロードキャストします。

UIObject クラスから継承されるイベント

次の表は List クラスが UIObject クラスから継承するイベントの一覧です。

イベント	説明
UIObject.draw	オブジェクトがグラフィックを描画しようとしているときにブロードキャストします。
UIObject.hide	オブジェクトの状態が可視から不可視に変化したときにブロードキャストします。
UIObject.load	サブオブジェクトが作成されたときにブロードキャストします。
UIObject.move	オブジェクトが移動したときにブロードキャストします。
UIObject.resize	オブジェクトのサイズが変更されたときにブロードキャストします。
UIObject.reveal	オブジェクトの状態が不可視から可視に変化したときにブロードキャストします。
UIObject.unload	サブオブジェクトがアンロードされるときにブロードキャストします。

UIComponent クラスから継承されるイベント

次の表は List クラスが UIComponent クラスから継承するイベントの一覧です。

イベント	説明
UIComponent.focusIn	オブジェクトがフォーカスを取得したときにブロードキャストします。
UIComponent.focusOut	オブジェクトがフォーカスを失ったときにブロードキャストします。
UIComponent.keyDown	キーが押されたときにブロードキャストします。
UIComponent.keyUp	キーが離されたときにブロードキャストします。

Top | Back | Next