例 : カスタムクラスの記述

これまで、クラスファイルの基礎知識とクラスのコンテンツについて学習しました。ここでは、クラスファイルを作成する上での一般的なガイドラインについて学習します。この章の 1 番目の例では、クラスを記述する方法とパッケージする方法を示します。2 番目の例では、クラスファイルと FLA ファイルを使用する方法を示します。

注意

外部ファイル内の ActionScript コードは、FLA ファイルのパブリッシュ、書き出し、ムービープレビュー、またはデバッグ時に、SWF ファイルにコンパイルされます。このため、外部ファイルに何らかの変更を行った場合には、ファイルを保存し、その外部ファイルを使用している FLA ファイルを再コンパイルする必要があります。

カスタムクラスファイルの記述で説明したように、1 つのクラスは "宣言" と "本体" の 2 つの部分から構成されます。最も簡単なクラス宣言は、class ステートメントと、それに続くクラス名の識別子、そして左右の中カッコ ({}) から成ります。次の例のように、中カッコの中にあるものはすべてクラスの本体です。

class className {
  // クラスの本体
}

注意 : クラスを定義できるのは、外部 ActionScript ファイル内のみです。たとえば、FLA ファイル内のフレームスクリプト上でクラスを定義することはできません。したがって、この例では新しいファイルを作成する必要があります。

最も基本的な形式のクラス宣言では、class キーワード、その後にクラス名 (この例では Person)、最後に左右の中カッコ ({}) が続きます。中カッコの間に記述する部分がクラスの "本体" と呼ばれ、クラスのプロパティとメソッドは、ここで定義されます。

この例では、クラスファイルの基本的な構成順序は次のとおりです。

ドキュメントコメント
クラスの宣言
コンストラクタ関数
クラスの本体

この章では、サブクラスは作成しません。継承とサブクラスの詳細については、継承を参照してください。

この例では、次のトピックを扱います。

XML データとカスタムクラスファイルを使用して動的にメニューを作成する方法を示すサンプルについては、Flash サンプルページ (www.adobe.com/go/learn_fl_samples_jp) を参照してください。このサンプルでは、ActionScript XmlMenu() コンストラクタを呼び出し、XML メニューファイルへのパスおよび現在のタイムラインへの参照をパラメータとして渡します。"Samples" zip ファイルをダウンロードし解凍して、"ActionScript2.0/XML_Menu" フォルダに移動して次のサンプルにアクセスします。

XmlMenu.as
xmlmenu.fla

クラス作成に関する一般的なガイドラインについて

カスタムクラスファイルを記述する上でのガイドラインを以下に示します。クラスを正確でわかりやすく記述するのに役立ちます。これらのガイドラインは、以降の例で実際に使用します。

原則として、宣言は 1 行に 1 つずつ書き、型が同じでも同じ行に複数の宣言を記述しないでください。宣言は次の例のような形式で記述します。
```
private var SKU:Number; // 製品 SKU (識別) 番号
private var quantity:Number; // 製品数量
```
ローカル変数は、初期値が計算で決定される場合を除いて、宣言するときに初期化します。変数の初期化の詳細については、メソッドとプロパティの追加を参照してください。
変数は、使用する前に宣言する必要があります (ループの変数も同様です)。たとえば、次のコードでは、ループイテレータ変数 (i) を for ループで使用する前に、事前に宣言しています。
```
var my_array:Array = new Array("one", "two", "three");
var i:Number;
for (i = 0 ; i < my_array.length; i++) {
    trace(i + " = " + my_array[i]);
}
```
上位の宣言が見えなくなるようなローカル宣言は行わないでください。たとえば、次のように同じ変数を 2 度宣言することは望ましくありません。
```
// よくない例
var counter:Number = 0;
function myMethod() {
    var counter:Number;
    for (counter = 0; counter <= 4; counter++) {
        // ステートメント;
    }
}
```
このコードは、内側のブロックで同じ変数を宣言しています。
わかりにくくなるので、次の ActionScript サンプルコードに示すように 1 つのステートメントで複数の変数に同じ値を代入することは避けてください。
```
// よくない例
xPos = yPos = 15;
```
または
```
// よくない例
class User {
    private var m_username:String, m_password:String;
}
```
インスタンス変数、静的変数、クラス変数、またはメンバー変数をパブリックと宣言する場合は、相応の理由が必要です。そのような変数を作成する前に、明確にパブリックにする必要がある性質の変数かどうか確認してください。
メンバー変数は、パブリックにする適切な理由がない限り、原則としてプライベートにします。設計の観点から見た場合、メンバー変数はプライベートにして、getter 関数と setter 関数の小さなグループを通じてのみアクセスできるようにするのが適切です。

クラスファイルの命名について

クラス名は識別子になっている必要があります。つまり、先頭文字は英字、アンダースコア (_)、ドル記号 ($) のいずれかとし、それ以降の文字は、英字、数字、アンダースコア、ドル記号のいずれかである必要があります。通常、クラス名には英字だけを使用することをお勧めします。

クラス名は、それを含む ActionScript ファイルと同じ名前にする必要があります。大文字と小文字も区別されます。たとえば、Rock というクラスを作成する場合には、そのクラス定義を含む ActionScript ファイルの名前を "Rock.as" にする必要があります。次に例を示します。

// "Rock.as" ファイル
class Rock {
  // Rock クラスの本体
}

クラス定義の命名と作成は、次のセクションで行います。クラスファイルの作成、命名、パッケージ化については、クラスファイルの作成とパッケージ化を参照してください。クラスファイルの命名の詳細については、クラスとオブジェクトの命名を参照してください。

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/main/00000789.html