マイクによるサウンドのゲイン(増幅率)は、シグナルが転送前にマイクで増幅される量を表します。[読み取り専用] マイクのインデックスです。names から返される配列のインデックスと同じです。[読み取り専用] ユーザーがマイクへのアクセスを拒否している(true)か、許可している(false)かを指定します。[読み取り専用] サウンドキャプチャハードウェアから返される現在のサウンドキャプチャデバイスの名前です。[静的] [読み取り専用] 使用可能なすべてのサウンドキャプチャデバイスの名前を含むストリングの配列です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。マイクのサウンドキャプチャレート(kHz)です。[読み取り専用] マイクを有効化したり、activity イベントを送出するために必要な音量です。[読み取り専用] マイクがサウンド検知を停止してから activity イベントが送出されるまでの時間(ミリ秒単位)です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントをイベントフローに送出します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。マイクによってキャプチャされたオーディオをローカルスピーカーに転送します。ループ処理に対するダイナミックプロパティの可用性を設定します。サウンドと見なす最小入力レベルと、実際に無音状態が始まったと見なすまでの無音時間の長さを設定します。後者は省略可能です。オーディオコーデックのエコー抑制機能を使用するかどうかを指定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。マイクがセッションを開始または終了したときに送出されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。マイクがそのステータスをレポートしたときに送出されます。
プロパティの詳細
マイクが検知している音量です。値の範囲は 0(サウンドが検知されていない)~ 100(非常に大音量が検知されている)です。オーディオ圧縮に使用するコーデックです。Speex コーデックを使用する場合の、エンコードされた音質です。デフォルト値は 6 です。次の表に示すとおり、値が大きいほど質は高くなりますが、必要な帯域幅も増えます。リストされたビットレートの値はネットのビットレートを表し、パケットのオーバーヘッドは含まれません。
必要なビットレート(1 秒あたりのキロビット数)
各フレームの長さは 20 ミリ秒です。デフォルト値は、1 パケットあたり 2 フレームです。メッセージ内の Speex フレーム数が増えるほど、必要な帯域幅が減りますが、メッセージ送信時の遅延が長くなります。Speex フレーム数が減るほど、必要な帯域幅が増えますが、遅延が短くなります。マイクによるサウンドのゲイン(増幅率)は、シグナルが転送前にマイクで増幅される量を表します。値 0 は 0 倍、つまりサウンドが送信されないことを示します。この設定はステレオのボリュームつまみのようなものと考えることができます。0 は消音、50 は通常のボリューム、50 より小さい値は通常よりも低いボリューム、50 より大きい値は通常よりも大きいボリュームを表します。マイクのインデックスです。names から返される配列のインデックスと同じです。ユーザーがマイクへのアクセスを拒否しているか(true)、許可しているか(false)を指定します。この値が変わると、status イベントが送出されます。サウンドキャプチャハードウェアから返される現在のサウンドキャプチャデバイスの名前です。使用可能なすべてのサウンドキャプチャデバイスの名前を含むストリングの配列です。
この配列により、各サウンドキャプチャデバイスの 0 から始まるインデックスと、システム上の各サウンドキャプチャデバイスの数(Microphone
詳細については、Array クラスのエントリを参照してください。names プロパティを呼び出すと、ハードウェアを広範囲にわたって調べる必要があり、配列を作成するまでに数秒間かかることがあります。ほとんどの場合は、デフォルトのマイクをそのまま使用できます。注意:現在のマイクの名前を調べるには、name プロパティを使用します。マイクのサウンドキャプチャレート(kHz)です。デフォルト値は 8 kHz ですが、サウンドキャプチャデバイスがこの値に対応している必要があります。対応していない場合、デフォルト値はそのサウンドキャプチャデバイスが対応している 8 kHz よりも高いレートのうち、8 kHz に最も近い値になります。マイクを有効化したり、activity イベントを送出するために必要な音量です。マイクがサウンド検知を停止してから、activity イベントが送出されるまでの時間(ミリ秒単位)です。エコー抑制が有効になっている場合は true、それ以外の場合は false に設定します。
メソッドの詳細
get() を複数回呼び出すと、同じマイクが参照されます。[マイク] パネルを使用することで、アプリケーションで使用するデフォルトのマイクをユーザーが指定できます。index で値を渡すと、ユーザーが使用するのとは異なるマイクが参照される可能性があります。index を使用できるのは、アプリケーションで 2 つのマイクから同時にオーディオをキャプチャする場合など、特殊な場合です。attachAudio() を呼び出すなど)、プライバシーダイアログボックスが表示され、そのマイクへのアクセスを許可するか拒否するかをユーザーが選択できます。ステージのサイズは必ず 215 × 138 ピクセル以上に設定してください。これは、ダイアログボックスを表示するために必要な最小サイズです。ユーザーがこのダイアログボックスに応答すると、ユーザーの応答を示す status イベントが送出されます。muted プロパティを確認して、ユーザーがマイクへのアクセスを許可したか、拒否したかを判別することもできます。Muted" である場合、SWF ファイルのマイクへのアクセスをユーザーが拒否しています。マイクによってキャプチャされたオーディオをローカルスピーカーに転送します。サウンドと見なす最小入力レベルと、実際に無音状態が始まったと見なすまでの無音時間の長さを設定します。後者は省略可能です。アクティビティ検知とは、人が話していることをオーディオレベルに基づいて検知する機能のことです。誰も話していないときは、関連付けられているオーディオストリームを送信する必要がないので、帯域幅を節約できます。この情報を利用して、ユーザー(または他の誰か)が話していないことを視覚的なフィードバックとして示すこともできます。サイレンス値はアクティビティ値に直接対応します。完全なサイレンスのアクティビティ値は 0 です。継続的な大音量(現在のゲイン設定に基づく最大の音量)のアクティビティ値は 100 です。ゲイン(増幅率)を適切に調整すると、話していないときにはアクティビティ値がサイレンス値よりも小さくなります。話しているときには、アクティビティ値はサイレンス値よりも大きくなります。どちらのメソッドも、activity イベントの送出タイミングを指定するために使用します。ただし、パブリッシュするストリームに対する影響という点では、この 2 つのメソッドは大きく異なります。ビデオストリームでモーションが検知されない間も、ビデオは送信されます。オーディオストリームが無音と考えられる場合には、オーディオデータは送信されません。代わりに、無音状態が始まったことを示すメッセージが送信されます。オーディオコーデックのエコー抑制機能を使用するかどうかを指定します。エコー抑制とは、スピーカーから出たサウンドが同じコンピュータのマイクによって拾われるオーディオフィードバックの影響を減らす機能のことです。これは、フィードバックを完全に除去するエコー除去機能とは異なります。一般に、キャプチャするサウンドをヘッドセットではなく同じコンピュータのスピーカーで再生する場合には、エコー抑制機能を使用することが推奨されます。
サウンド出力デバイスをユーザーが選択できるようにした SWF ファイルでは、ユーザーがスピーカーを選択し、マイクも使用する場合に Microphone
イベントの詳細
マイクがセッションを開始または終了したときに送出されます。このイベントには、次のプロパティがあります。デバイスがアクティブになっている場合は true、非アクティブになっている場合は false です。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。マイクがそのステータスをレポートしたときに送出されます。Muted" である場合、SWF ファイルのマイクへのアクセスをユーザーが拒否しています。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。オブジェクトのステータスの説明です。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。そのステータスをレポートするオブジェクトです。
例 例の使用法
次の例では、コンピュータのマイクへのアクセスを許可した後に、エコー抑制を使用してマイクからサウンドをキャプチャします。このメソッドはイベントの情報をトレースします。注意:この例を正しく機能させるには、コンピュータにマイクを接続しておく必要があります。
0 言語およびコンポーネントリファレンス
Sound クラスを使用すると、アプリケーション内のサウンドを処理することができます。Sound クラスを使用すると、Sound オブジェクトの作成や、外部 MP3 ファイルのオブジェクトへのロードと再生ができます。また、サウンドストリームを閉じたり、サウンド関連のデータ (ストリームおよび ID3 メタデータのバイト数などの情報) にアクセスしたりできます。5 以降では、このクラスを使用して、動的に生成されたサウンドを処理することもできます。この場合、サウンドデータのポーリングには、sampleData イベントハンドラに割り当てられた関数が使用されます。サウンドは、サウンドデータに設定された ByteArray オブジェクトから取得され、再生されます。抽出したサウンドデータは、ストリームに書き戻して再生する前に処理できます。0 とは異なります。0 では、取得して階層内に配置した Sound オブジェクトのプロパティを制御することができません。このクラスを使用するときは、次のセキュリティモデルを考慮してください。呼び出し元ファイルがネットワークサンドボックスにあり、ロードするサウンドファイルがローカルにある場合、サウンドのロードおよび再生はできません。呼び出し元ファイルがローカルにあり、リモートサウンドのロードおよび再生を試行する場合、デフォルトでは、サウンドのロードや再生ができません。この種のアクセスを許可するには、ユーザーが明示的な許可を与える必要があります。サウンドを処理する特定の操作が制限されます。ロードされたサウンドのデータには、クロスドメインポリシーファイルを実装していない限り、別のドメインに存在するファイルからアクセスできないことに注意してください。ただし、Adobe AIR では、アプリケーションセキュリティサンドボックス内のコンテンツ (AIR アプリケーションと共にインストールされたコンテンツ) は、これらのセキュリティ制限による制限を受けません。セキュリティ情報について詳しくは、以下を参照してください。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
[読み取り専用] この Sound オブジェクトで現在利用できるデータのバイト数を返します。[読み取り専用] この Sound オブジェクトの合計バイト数を返します。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。[読み取り専用] MP3 ファイルの一部であるメタデータに対するアクセスを提供します。[読み取り専用] 外部 MP3 ファイルのバッファリング状態を返します。[読み取り専用] 現在のサウンドの継続時間を示すミリ秒数です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。[読み取り専用] サウンドがロードされる URL です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。ストリームを閉じて、データのダウンロードを中止します。イベントをイベントフローに送出します。Sound オブジェクトから生のサウンドデータを抽出します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。データが正常にロードされたときに送出されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。入出力エラーが発生して読み込み操作が失敗したときに送出されます。読み込み操作が開始したときに送出されます。ロード処理の実行中にデータを受信したときに送出されます。
プロパティの詳細
この Sound オブジェクトで現在利用できるデータのバイト数を返します。このプロパティは、通常、外部から読み込むファイルのみに使用します。この Sound オブジェクトの合計バイト数を返します。MP3 ファイルの一部であるメタデータに対するアクセスを提供します。MP3 サウンドファイルには、ファイルについてのメタデータを示す ID3 タグを含めることができます。load() メソッドを使用してロードした MP3 サウンドに ID3 タグが含まれる場合は、これらのプロパティを調べることができます。4)のタグをサポートしています。0 タグと、そのタグが表すコンテンツタイプを示します。TIME などの形式を使用してこれらのタグにアクセスできます。0 プロパティ名または ActionScript プロパティ名のいずれかを使用してアクセスできるタグを示します。次の表は、サポートされているものの、Sound クラスに定義済みのプロパティが存在しない ID3 タグを示します。
内容の属するグループの説明
タイトル/曲名/内容の説明
サブタイトル/説明の追加情報
オリジナルのアルバム/ムービー/ショーのタイトル
オリジナルのファイル名
オリジナルの作詞家/文書作成者
オリジナルのアーティスト/演奏者
オリジナルのリリース年
ファイルの所有者/ライセンス保持者
主な演奏者/ソリスト
翻訳、リミックス、その他の修正を行った人
セット中の位置
トラック番号/セット内の位置
インターネットラジオ局の名前
インターネットラジオ局の所有者
エンコードに使用したソフトウェア/ハードウェアと設定
このプロパティを使用するときは、Flash Player セキュリティモデルを考慮してください。Sound オブジェクトの id3 プロパティは、サウンドファイルと同じセキュリティサンドボックス内にある SWF ファイルで常に使用できます。他のサンドボックス内のファイルには、セキュリティチェックがあります。ポリシーファイルが存在しており、そのファイルでロード元 SWF ファイルのドメインからのアクセスが許可されている場合、Sound オブジェクトの id3 プロパティにアクセスできます。それ以外の場合は、アクセスできません。ただし、Adobe AIR では、アプリケーションセキュリティサンドボックス内のコンテンツ (AIR アプリケーションと共にインストールされたコンテンツ) は、これらのセキュリティ制限による制限を受けません。セキュリティ情報について詳しくは、以下を参照してください。次の例では、サウンドファイルから ID3 情報を読み取り、テキストフィールドに表示します。コンストラクタで、サウンドファイルがロードされますが、再生するように設定されていません。ここでは、ファイルが SWF ディレクトリにあると想定しています。ロードされるサウンドファイルの ID3 タグを読み取るために、システムにアクセス権がある必要があります。
ファイル内に ID3 情報が存在し、プログラムに読み取ることが許可されている場合、Event
ID3 イベントが送出され、サウンドファイルの id3 プロパティに値が設定されます。テキストフィールドがインスタンス化され、ID3 タグの一覧が表示されます。0 タグが繰り返し処理され、テキストフィールドの内容に名前と値が追加されます。4 がサポートされます。0 タグだけが表示されます。ただし、以前のバージョンからのデータも曲の id3 プロパティに保存され、ID3 info クラスのプロパティを使用してアクセスできます。0 のタグはファイルに末尾にあります。0 タグはファイルの先頭にあります。以前のバージョンと最新バージョンのタグがファイルの同じ場所にある場合があります。
ファイルが、ファイルの先頭と末尾にあるバージョン 1
最初にバージョン 2
0 が読み込まれ、次にバージョン 1
0 が読み込まれます。TITS プロパティによって曲名が取得されます。この例にはエラー処理の記述がないため、ID3 の内容が長い場合、結果が表示可能領域を超える場合があります。外部 MP3 ファイルのバッファリング状態を返します。値が true の場合、再生は現在中断され、オブジェクトがデータを待機しています。現在のサウンドの継続時間を示すミリ秒数です。サウンドがロードされる URL です。url プロパティには、サウンドがロードされる元の最終的な絶対 URL が格納されます。また、元の URL 要求が HTTP サーバーによってリダイレクトされると、url プロパティの値はサウンドファイルが実際にダウンロードされた URL を示します。
コンストラクタの詳細
呼び出さないと、ストリームがロードされません。別のサウンドファイルをロードするには、新しい Sound オブジェクトを作成します。これは、バッファ時間 (Sound オブジェクトのバッファに保持する MP3 データのミリ秒単位の最小数) を定義でき、また、アプリケーションがサウンドをロードする前にクロスドメインポリシーを確認すべきかどうかを指定できます。
メソッドの詳細
ストリームを閉じて、データのダウンロードを中止します。close() メソッドの呼び出し後は、ストリームからデータを読み込みません。IOError — ストリームを閉じることができないか、またはストリームが開いていません。close() メソッドが呼び出され、サウンドがストリーミングを停止します。コンストラクタで、[開始] ボタンおよび [停止] ボタン用のテキストフィールドが作成されます。このメソッドは、サウンドファイルの開始と停止を処理します。ネットワーク接続によって、またはユーザーが [停止] ボタンを押したときにファイルの多くがロードされてしまっているため、サウンドファイルの再生を停止するのにしばらく時間がかかる場合があります。
ストリームを閉じている間に発生する可能性のある IO エラーをキャッチするために、try
例えば、サウンドがローカルディレクトリからロードされ、ストリームされない場合、エラー 2029 がキャッチされ、"この URLStream オブジェクトには開いているストリームがありません" というメッセージが表示されます。Sound オブジェクトから生のサウンドデータを抽出します。このメソッドは、動的に生成されたオーディオを処理する場合に、別の Sound オブジェクトの sampleData イベントに割り当てられた関数を使って使用するように設計されています。つまり、このメソッドを使用して Sound オブジェクトからサウンドデータを抽出できます。次に、別の Sound オブジェクトによってダイナミックオーディオのストリーミングに使用されているバイト配列に、そのデータを書き込むことができます。オーディオデータは、対象のバイト配列に、現在の位置から配置されます。サンプルには、2 つの 32 ビット浮動小数点数を意味する左チャンネルと右チャンネルがあります。upOctave() メソッドは、ソースのオーディオデータに基づいて、変更されたオーディオデータのバイト配列を返します。ソースデータのオーディオサンプルを 1 つおきにスキップすることにより、1 オクターブ高いオーディオが返されます。mp3 ファイルを SWF ファイルと同じディレクトリに追加してください。別のサウンドファイルをロードするには、新しい Sound オブジェクトを作成します。このメソッドを使用するときは、次のセキュリティモデルを考慮してください。信頼できるローカルのサンドボックスまたはネットワーク接続したローカルのサンドボックスからアクセスするには、URL ポリシーファイルを使用して Web サイトで許可する必要があります。一般的な予約ポートには接続できません。0 のプログラミング』)の「ネットワーク API の制限」を参照してください。POST 処理は、マウスのクリックやキーの押下などのユーザーが開始したアクションに応答して実行する必要があります。POST 処理がクロスドメインである (POST ターゲットが、POST 要求を送信中の SWF ファイルと同じサーバー上にない) 場合は、クロスドメインアクセスを許可する URL ポリシーファイルをターゲットサーバーが提供する必要があります。シンタックスが有効でない場合は、アップロードに適用されるセキュリティ規則によって POST 処理が拘束されます。Adobe AIR では、アプリケーションセキュリティサンドボックス内のコンテンツ (AIR アプリケーションと共にインストールされたコンテンツ) は、これらのセキュリティ制限による制限を受けません。セキュリティ情報について詳しくは、以下を参照してください。これは、バッファ時間 (Sound オブジェクトのバッファに保持する MP3 データのミリ秒単位の最小数) を定義でき、また、アプリケーションがサウンドをロードする前にクロスドメインポリシーを確認すべきかどうかを指定できます。IOError — このロードの失敗原因であるネットワークエラーです。0 のプログラミング』のセキュリティに関する章の「ネットワーク API の制限」を参照してください。次の例では、サウンドファイルのロードの進行状況を表示します。コンストラクタで、アドビ システムズ社のポッドキャストであるサウンドファイルの位置を識別する URLRequest オブジェクトが作成されます。
ファイルのロード中に発生する可能性のあるエラーをキャッチするために、ファイルが try
IO エラーが発生すると、errorHandler() メソッドも呼び出され、進行状況をレポートするテキストフィールドにエラーメッセージが書き出されます。PROGRESS イベントがロードの進行状況を計算するタイマとして使用されます。次に、これらの値がテキストフィールドに表示されます。ファイルが小さいか、キャッシュされているか、ローカルディレクトリにある場合、進行状況が目立たない場合があります。このオブジェクトにアクセスして、サウンドの停止、およびボリュームの監視を行います。ボリュームの制御、パン、バランスの設定を行うには、サウンドチャンネルに割り当てられた SoundTransform オブジェクトにアクセスします。このメソッドは、サウンドカードがない場合、または使用できるサウンドチャンネルが不足した場合は null を返します。一度に使用できるサウンドチャンネルの最大数は 32 チャンネルです。次の例では、ファイルがロードされると、グラフィックバーを使用するユーザーは、サウンドファイルの開始位置(開始時点)を選択できます。load() メソッドを呼び出して、サウンドデータのロードを開始します。play() メソッドを呼び出して、十分なデータがロードされ次第、サウンドの再生を開始します。テキストフィールドにはユーザーに対する説明が表示されます。ユーザーが再生を開始しようとしているサウンドの内容が確実にロードされているようにするため、ファイルのロードが完了してから bar Sprite オブジェクトが作成され、表示されます。
ファイルが正常にロードされると、Event
インタラクティブ機能をサポートするために、Shape オブジェクトの代わりに Sprite オブジェクトが使用されます。localX を使用して、ユーザーがファイルの開始を指定した場所が特定されます。バーは 100 ピクセルであり、x 座標の 100 ピクセルの位置から開始するので、位置の割合(パーセント)は簡単に特定されます。また、ファイルがロードされるため、サウンドファイルの length プロパティに、完全なファイルの長さ(ミリ秒単位)が設定されます。サウンドファイルの長さと行内の位置を使用して、サウンドファイルの開始位置が特定されます。サウンドの再生を停止した後は、startTime パラメータとして play() メソッドに渡される選択した開始位置からサウンドファイルの再生が再開されます。次の例では、ユーザーがボタンをシングルクリックするか、ダブルクリックするかに応じて、サウンドを 1 回または 2 回再生します。インタラクティブ機能をサポートするために、Shape オブジェクトの代わりに Sprite オブジェクトが使用されます。ここでは、サウンドファイルが SWF ファイルと同じディレクトリにあると想定しています。この例には、エラー処理コードはありません。マウスのシングルクリックとダブルクリックに応答するために、2 つのイベントリスナーが設定されます。ユーザーがボタンをシングルクリックすると、clickHandler() メソッドが呼び出され、サウンドが再生されます。これは、サウンドが開始時点に 1 回ループバックされ、再び再生されることを意味します。1 つ目の引数(開始時点)は 0 に設定されます。これは、ファイルが最初から再生されることを意味します。次の例では、サウンドファイルのロードと再生の進行状況を表示します。
コンストラクタで、ファイルのロード中に発生する可能性のあるエラーをキャッチするために、ファイルが try
このイベントは、再生の進行状況を表示するタイミング制御メカニズムとして使用されます。SOUND_COMPLETE イベントに(サウンドの再生が終了したときに)応答するサウンドチャンネルに追加されます。再生されるサウンドデータの割合(パーセント)は、サウンドチャンネルの position プロパティの値をサウンドデータの長さで除算することで算出される場合があります。ただし、サウンドデータが完全にロードされていない場合、サウンドオブジェクトの length プロパティは、現在ロードされているサウンドデータのみのサイズを表示します。ファイルが小さいか、キャッシュされているか、ローカルディレクトリにある場合、ロードの進行状況が目立たない場合があります。この値は、デフォルトで 1000 ミリ秒であり、リセットできます。
イベントの詳細
データが正常に読み込まれたときに送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。読み込みが完了したネットワークオブジェクトです。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。入出力エラーが発生して読み込み操作が失敗したときに送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
特定のエラーに関連付けられた参照番号です(AIR のみ)
入出力エラーが発生したネットワークオブジェクトです。エラーメッセージとして表示されるテキストです。読み込み操作が開始したときに送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。接続をオープンしたネットワークオブジェクトです。ロード処理の実行中にデータを受信したときに送出されます。このイベントには、次のプロパティがあります。リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。読み込みプロセスが成功した場合に最終的に読み込まれるアイテムまたはバイトの総数です。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。進行状況をレポートする オブジェクトです。次の例は、単純な正弦波を再生します。
例 例の使用法
次の例では、MP3 ファイルを開い再生すると発生するサウンドイベントに関する情報が表示されます。mp3 ファイルを SWF ファイルと同じディレクトリに配置します。
0 言語およびコンポーネントリファレンス
FileReference クラスには、ユーザーのコンピュータとサーバーとの間でファイルをアップロードおよびダウンロードするための手段があります。オペレーティングシステムのダイアログボックスを使用して、アップロードするファイルや、ダウンロード先の場所をユーザーが選択できるようにします。ダウンロード処理の実行中、name プロパティの値は select イベントが送出されたときに設定されます。これ以外のすべてのプロパティの値は、complete イベントが送出されたときに設定されます。browse() メソッドはオペレーティングシステムのダイアログボックスを開いて、ユーザーがアップロード対象のファイルを選択できるようにします。browse() メソッドを使用すると、ユーザーは単一のファイルを選択できます。browse() メソッドを使用すると、複数のファイルを選択できます。download() メソッドは、ファイルの保存先をユーザーに指定させ、リモート URL からのダウンロードを開始します。ダイアログボックスに表示されるデフォルトの場所は、最後に参照されたフォルダ (その場所を決定できる場合) またはデスクトップです。これらのクラスを使って、転送ファイルを読み込んだり、転送ファイルに書き込んだりすることはできません。これらのクラスを使用しても、アップロードまたはダウンロードを開始した SWF ファイルが、アップロードファイルやダウンロードファイル、またはユーザーのディスクのファイルの場所にアクセスすることはできません。認証が必要なサーバーでは、Flash® Player ブラウザプラグインを使用してファイルをダウンロードできますが、すべての Player でのアップロード、およびスタンドアローンまたは外部 Player でのダウンロードは失敗します。FileReference イベントをリッスンして、処理が正常に終了したかどうかを確認して、エラー処理を行います。Flash Player で実行されるコンテンツの場合、またはアプリケーションセキュリティサンドボックス外の、Adobe AIR で実行されるコンテンツの場合、アップロード操作およびダウンロード操作では、それ自身のドメイン内および URL ポリシーファイルが指定するドメイン内のファイルにのみアクセスできます。アップロードまたはダウンロードを開始しているコンテンツが、ファイルサーバーと同じドメインに属していない場合、ファイルサーバーにポリシーファイルを配置します。以前のバージョンの Flash Player については、同時に複数の操作を実行しても、この制限には影響されません。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。[読み取り専用] ローカルディスク上に存在するファイルの作成日です。[読み取り専用] ファイル名拡張子です。[読み取り専用] ローカルディスク上に存在するファイルの最終変更日です。[読み取り専用] ローカルディスク上に存在するファイルの名前です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。[読み取り専用] ローカルディスク上に存在するファイルのサイズ(バイト単位)です。[読み取り専用] ファイル形式です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。アップロードするファイルを選択できるファイル参照ダイアログボックスを表示します。この FileReference オブジェクトで進行中のアップロード処理またはダウンロード処理を取り消します。イベントをイベントフローに送出します。リモートサーバーからファイルをダウンロードするためのダイアログボックスを開きます。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。ユーザーが選択したローカルファイルの読み込みを開始します。指定されたプロパティが存在し、列挙できるかどうかを示します。ローカルファイルシステムにファイルを保存するためのダイアログボックスを開きます。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。ユーザーが選択したファイルをリモートサーバーにアップロードする処理を開始します。ファイルをエンコードせずに URL へのアップロードを開始します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。ユーザーがアップロードまたはダウンロードするファイルをファイル参照ダイアログボックスからキャンセルしたときに送出されます。ダウンロードが完了、またはアップロードで HTTP ステータスコード 200 が生成された場合に送出されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。アップロードに失敗し、HTTP ステータスコードを使用して失敗を記述することができない場合に送出されます。アップロードまたはダウンロードが失敗したときに送出されます。アップロード処理またはダウンロード処理が開始するときに送出されます。ファイルのアップロード処理中またはダウンロード処理中に定期的に送出されます。download() メソッドの呼び出しによって、サーバーにファイルをアップロードするか、呼び出し元のセキュリティサンドボックスの外部にあるサーバーからファイルを取得しようとしたときに送出されます。ユーザーがアップロードするファイルまたはダウンロードするファイルをファイル参照ダイアログボックスから選択したときに、送出されます。アップロードの正常終了後、サーバーからデータを受信したときに送出されます。
プロパティの詳細
ローカルディスク上に存在するファイルの作成日です。オブジェクトに値が設定されていない場合に、このプロパティの値を取得する呼び出しが行われると null が返されます。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。IOError — ファイル情報にアクセスできない場合、I/O エラーを示すメッセージとともにエラーがスローされます。FileReference オブジェクトに値が設定されていない場合に、このプロパティの値を取得する呼び出しが行われると null を返します。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。IOError — ファイルを開くことや読み取ることができない場合、またはファイルへのアクセスで同様のエラーが発生した場合、例外がスローされ、ファイルの I/O エラーを知らせるメッセージが送信されます。ファイル名拡張子です。ファイルの拡張子は、名前内の最後のドット("
")の後の部分です(ドットは含みません)
ファイル名内にドットがない場合、拡張子は null です。注意:ファイルのタイプを確認するには、extension プロパティを使用する必要があります。これらのプロパティは、Mac OS の古いバージョンに適用されます。ローカルディスク上に存在するファイルの最終変更日です。FileReference オブジェクトに値が設定されていない場合に、このプロパティの値を取得する呼び出しが行われると null を返します。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。IOError — ファイル情報にアクセスできない場合、I/O エラーを示すメッセージとともにエラーがスローされます。ローカルディスク上に存在するファイルの名前です。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。ローカルディスク上に存在するファイルのサイズ (バイト単位) です。0 の初期のバージョンでは、size プロパティは、4 GB 程度までのサイズのファイルをサポートする uint オブジェクトとして定義されていました。現在では、それよりも大きいファイルをサポートする Number オブジェクトとして実装されています。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。IOError — ファイルを開くことや読み取ることができない場合、またはファイルへのアクセスで同様のエラーが発生した場合、例外がスローされ、ファイルの I/O エラーを知らせるメッセージが送信されます。ファイル形式です。)の後の部分)でファイル形式を示します。download() メソッドの呼び出しが失敗すると、例外がスローされ、関数の呼び出しシーケンスが正しくないこと、または以前の呼び出しが失敗したことを知らせるメッセージが送信されます。
コンストラクタの詳細
設定されると、FileReference オブジェクトはユーザーのローカルディスク上のファイルを表します。
メソッドの詳細
アップロードするファイルを選択できるファイル参照ダイアログボックスを表示します。このダイアログボックスは、オペレーティングシステムのネイティブのダイアログボックスです。ユーザーは、例えば Windows の UNC パスを使用して、ローカルコンピュータまたは他のコンピュータからファイルを選択できます。このメソッドを呼び出して、ユーザーが正常にファイルを選択すると、この FileReference オブジェクトのプロパティにそのファイルのプロパティが設定されます。これは、一度に 1 つのダイアログボックスしか呼び出せないからです。どのファイルをダイアログボックスに表示するかを決定するために、typeFilter パラメータを使用できます。以前のバージョンの Flash Player については、同時に複数の操作を実行しても、この制限には影響されません。このパラメータを省略すると、すべてのファイルが表示されます。cancel:Event — ユーザーがファイルアップロードの参照ウィンドウをキャンセルすると、送出されます。ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
cfg ファイルの設定により、この操作が禁止されている場合
Error — マウスイベントやキー入力イベントなどのユーザー操作に応じてメソッドが呼び出されない場合
この FileReference オブジェクトで進行中のアップロード処理またはダウンロード処理を取り消します。このメソッドを呼び出しても cancel イベントは送出されません。このイベントは、ユーザーがファイルアップロードまたはダウンロードのダイアログボックスを閉じて処理をキャンセルした場合にのみ送出されます。リモートサーバーからファイルをダウンロードするためのダイアログボックスを開きます。Flash Player ではアップロードまたはダウンロードできるファイルのサイズに制限はありませんが、このプレーヤーが正式にサポートしているアップロードまたはダウンロードのサイズは最大 100 MB です。download() メソッドは、まず、オペレーティングシステムのダイアログボックスを表示して、ユーザーにファイル名を入力してもらった後、ファイルの保存先となるローカルコンピュータ上の場所を選択してもらいます。ユーザーが保存場所を選択し、[保存] などをクリックして、ファイルをローカルに保存することを確認すると、リモートサーバーからのダウンロードが開始します。リスナーは、ダウンロードが進行中なのか、成功したのか、失敗したのかを示すイベントを受け取ります。これらの関数は呼び出された後、ファイル転送が完了する前に返されます。さらに、FileReference オブジェクトがスコープ外に移動した場合、そのオブジェクトに対して完了していないアップロードまたはダウンロードは、スコープから離れた時点でキャンセルされます。アップロードまたはダウンロードの続行を期待できる限りは、FileReference オブジェクトがスコープ内にあることを確認してください。ファイルが正常にダウンロードされると、FileReference オブジェクトのプロパティにローカルファイルのプロパティが設定されます。ダウンロードが成功した場合、complete イベントが送出されます。これは、一度に 1 つのダイアログボックスしか呼び出せないからです。このメソッドは、どのファイルタイプのダウンロードにも対応しており、HTTP と HTTPS のいずれも使用できます。一般的な予約ポートに接続することはできません。0 のプログラミング』)の「ネットワーク API の制限」を参照してください。メモ : サーバーでユーザー認証が必要な場合、ブラウザ内で実行される、つまり、ブラウザプラグインまたは ActiveX コントロールを使用する SWF ファイルでのみ、認証用のユーザー名とパスワードをユーザーが入力できるダイアログボックスを表示できます。ただし、それはダウンロードの場合のみです。プラグインまたは ActiveX コントロールを使用するアップロードの場合や、スタンドアローンまたは外部 Player を使用するアップロードとダウンロードの場合、ファイル転送は失敗します。呼び出し元 SWF ファイルが信頼されないコードとしてローカルのサンドボックスに置かれている場合、ロード操作は実行できません。デフォルトの動作では、サンドボックス間のアクセスは拒否されます。URL ポリシーファイルを追加することによって、Web サイトでリソースにアクセスできるようになります。ただし、Adobe AIR では、アプリケーションセキュリティサンドボックス内のコンテンツ(AIR アプリケーションと共にインストールされたコンテンツ)は、これらのセキュリティ制限による制限を受けません。セキュリティ情報について詳しくは、以下を参照してください。以前のバージョンの Flash Player については、同時に複数の操作を実行しても、この制限には影響されません。このパラメータが null の場合、例外がスローされます。一部のブラウザでは、URL ストリングの長さに制限があるものがあります。長さが 256 文字を超える場合、一部のブラウザまたはサーバーでは失敗する場合があります。を含めないでください。このパラメータを省略すると、リモート URL のファイル名が構文解析されて、デフォルトとして使用されます。select:Event — ダウンロードするファイルをユーザーがダイアログボックスから選択すると、送出されます。
ファイルの読み込み中または転送中に入出力エラーが発生した場合
Flash Player のスタンドアローンバージョンまたは外部バージョンで実行される SWF コンテンツが、認証が必要なサーバーからファイルをダウンロードしようとした場合
ダウンロードする際、スタンドアローンまたは外部 Player には、ユーザーがパスワードを入力する手段がありません。認証が必要なサーバーに対して、これらの Player 内の SWF がファイルをダウンロードしようとすると、ダウンロードは失敗します。
1)他のブラウズセッションが進行中の場合
ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
2)request に渡された値に、無効なパスまたはプロトコルが含まれている場合
3)ダウンロードするファイルの名前に禁止文字が含まれている場合
cfg ファイルの設定により、この操作が禁止されている場合
この問題を回避するには、この SWF ファイルを、ネットワークアクセスを許可されたローカル SWF ファイル、または信頼できる SWF ファイルとして再分類します。この例外がスローされると、ローカルファイルのセキュリティ制限が原因でアクセスできないファイル名および URL を示すメッセージが送信されます。0 のプログラミング』のセキュリティに関する章の「ネットワーク API の制限」を参照してください。
Error — マウスイベントやキー入力イベントなどのユーザー操作に応じてメソッドが呼び出されない場合
次の例で、download イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。ユーザーが選択したローカルファイルの読み込みを開始します。Flash Player ではアップロード、ダウンロード、ロードまたは保存できるファイルのサイズに制限はありませんが、正式にサポートしているサイズは最大 100 MB です。リスナーは、読み込み処理が進行中なのか、成功したのか、失敗したのかを示すイベントを受け取ります。FileReferenceList オブジェクトを使用すると、ロードするファイルを複数選択できるようになりますが、ファイルは 1 つずつロードする必要があります。save() 関数はノンブロッキング処理を行います。これらの関数は呼び出された後、ファイル転送が完了する前に返されます。さらに、FileReference オブジェクトがスコープ外に移動した場合、そのオブジェクトに対して完了していないトランザクションは、スコープから離れた時点でキャンセルされます。アップロード、ダウンロード、読み込みまたは保存の続行を期待できる限りは、FileReference オブジェクトがスコープ内にあることを確認してください。ファイルのロードが正常に完了した場合は、ファイルの内容が FileReference オブジェクトの data プロパティにバイト配列として格納されます。次のセキュリティ上の考慮事項が適用されます。呼び出し元 SWF ファイルが信頼されないコードとしてローカルのサンドボックスに置かれている場合、ロード操作は実行できません。デフォルトの動作では、サンドボックス間のアクセスは拒否されます。クロスドメインポリシーファイルを追加することによって、Web サイトでリソースにアクセスできるようになります。ただし、これらの考慮事項は、アプリケーションサンドボックス内の AIR コンテンツには適用されません。複数の操作を実行すると、アプリケーションでランタイムエラー(コード 2174)が発生します。5 にのみ適用されます。ioError:IOErrorEvent — アプリケーションによるファイルの読み込み中または書き込み中に入出力エラーにより読み込みが失敗した場合に呼び出されます。ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
cfg ファイルの設定により、この操作が禁止されている場合
MemoryError — このエラーは、アプリケーションがファイルにメモリを割り当てることができない場合に発生することがあります。ファイルが大きすぎるか、または使用可能なメモリが少なすぎる可能性があります。ローカルファイルシステムにファイルを保存するためのダイアログボックスを開きます。Flash Player ではアップロード、ダウンロード、読み込みまたは保存できるファイルのサイズに制限はありませんが、正式にサポートしているサイズは最大 100 MB です。save() メソッドは、まず、オペレーティングシステムのダイアログボックスを表示して、ユーザーにファイル名を入力してもらった後、ファイルの保存先となるローカルコンピュータ上の場所を選択してもらいます。ユーザーが保存場所を選択し、「保存」などをクリックして、ファイルをローカルに保存することを確認すると、保存処理が開始されます。リスナーは、保存処理が進行中なのか、成功したのか、失敗したのかを示すイベントを受け取ります。save() 関数はノンブロッキング処理を行います。これらの関数は呼び出された後、ファイル転送が完了する前に返されます。さらに、FileReference オブジェクトがスコープ外に移動した場合、そのオブジェクトに対して完了していないトランザクションは、スコープから離れた時点でキャンセルされます。アップロード、ダウンロード、読み込みまたは保存の続行を期待できる限りは、FileReference オブジェクトがスコープ内にあることを確認してください。ファイルが正常に保存されると、FileReference オブジェクトのプロパティにローカルファイルのプロパティが設定されます。これは、一度に 1 つのダイアログボックスしか呼び出せないからです。Flash Player では、このメソッドの呼び出しは、マウスのクリックやキー入力などのユーザーイベントに応じてイベントハンドラで呼び出した場合にのみ成功します。この制限事項はアプリケーションサンドボックス内の AIR コンテンツには適用されません。データは複数の形式のうちのいずれかになり、以下のように適切に処理されます。この値が XML の場合、XML 形式でテキストファイルに書き込まれます。形式はすべて保持されます。この値が ByteArray オブジェクトの場合、データファイルにそのまま書き込まれます。値が上記のいずれでもない場合、save() メソッドは、オブジェクトの toString() メソッドを呼び出して、データをストリングに変換し、テキストファイルとして保存します。を含めないでください。select:Event — ダウンロードするファイルをユーザーがダイアログボックスから選択すると、送出されます。
1)他のブラウズセッションが進行中の場合
ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
2)ダウンロードするファイルの名前に禁止文字が含まれている場合
cfg ファイルの設定により、この操作が禁止されている場合
Error — マウスイベントやキー入力イベントなどのユーザー操作に応じてメソッドが呼び出されない場合
ファイルが大きすぎるか、または使用可能なメモリが少なすぎる可能性があります。ユーザーが選択したファイルをリモートサーバーにアップロードする処理を開始します。Flash Player ではアップロードまたはダウンロードできるファイルのサイズに制限はありませんが、このプレーヤーが正式にサポートしているアップロードまたはダウンロードのサイズは最大 100 MB です。リスナーは、アップロードが進行中なのか、成功したのか、失敗したのかを示すイベントを受け取ります。FileReferenceList オブジェクトを使用すると、ユーザーが複数のファイルを選択してアップロードすることが可能になりますが、ファイルは 1 つずつアップロードする必要があります。これらの関数は呼び出された後、ファイル転送が完了する前に返されます。さらに、FileReference オブジェクトがスコープ外に移動した場合、そのオブジェクトに対して完了していないアップロードまたはダウンロードは、スコープから離れた時点でキャンセルされます。アップロードまたはダウンロードの続行を期待できる限りは、FileReference オブジェクトがスコープ内にあることを確認してください。ファイルは、url パラメータに渡された URL にアップロードされます。URL は、アップロードを許可するよう設定されたサーバースクリプトである必要があります。アップロードを処理するサーバースクリプトは、次のエレメントを持つ POST リクエストを想定しています。
ファイルのバイナリコンテンツ
一般的な予約ポートに接続することはできません。0 のプログラミング』)の「ネットワーク API の制限」を参照してください。注意:サーバーでユーザー認証が必要な場合、ブラウザ内で実行される、つまり、ブラウザプラグインまたは ActiveX コントロールを使用する SWF ファイルでのみ、認証用のユーザー名とパスワードをユーザーが入力できるダイアログボックスを表示できます。ただし、それはダウンロードの場合のみです。プラグインまたは ActiveX コントロールを使用するアップロードの場合や、スタンドアローンまたは外部 Player を使用するアップロードとダウンロードの場合、ファイル転送は失敗します。呼び出し元 SWF ファイルが信頼されないコードとしてローカルのサンドボックスに置かれている場合、ロード操作は実行できません。デフォルトの動作では、サンドボックス間のアクセスは拒否されます。URL ポリシーファイルを追加することによって、Web サイトでリソースにアクセスできるようになります。ただし、Adobe AIR では、アプリケーションセキュリティサンドボックス内のコンテンツ(AIR アプリケーションと共にインストールされたコンテンツ)は、これらのセキュリティ制限による制限を受けません。詳細については、次のトピックを参照してください。以前のバージョンの Flash Player については、同時に複数の操作を実行しても、この制限には影響されません。一部のブラウザでは、URL ストリングの長さに制限があるものがあります。長さが 256 文字を超える場合、一部のブラウザまたはサーバーでは失敗する場合があります。このパラメータが null の場合、例外がスローされます。次のサンプル POST 要求を参照してください。テストアップロードでは、実際のファイルアップロードが成功するかどうか、必要な場合はサーバー認証が成功するかどうかがチェックされます。テストアップロードは、Windows プレーヤーでのみ使用できます。
ユーザー名とパスワードなど、認証が必要なサーバーにファイルをアップロードしようとしたことが原因でアップロードが失敗した場合
アップロード中、ユーザーがパスワードを入力する方法はありません。
url パラメータに無効なプロトコルが含まれることが原因でアップロードが失敗した場合
この問題を回避するには、この SWF ファイルを、ネットワークアクセスを許可されたローカル SWF ファイル、または信頼できる SWF ファイルとして再分類します。この例外がスローされると、アクセスできないローカルファイルの名前および URL を示すメッセージが送信されます。0 のプログラミング』のセキュリティに関する章の「ネットワーク API の制限」を参照してください。ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
2)URL パラメータが有効なパスまたはプロトコルでない場合
ファイルのアップロードでは HTTP を使用し、ファイルのダウンロードでは FTP または HTTP を使用する必要があります。
cfg ファイルの設定により、この操作が禁止されている場合
ファイルをエンコードせずに URL へのアップロードを開始します。送信するデータが受信サーバーが理解できる形式で既にエンコードされている場合は、uploadUnencoded() メソッドを使用します。一部のブラウザでは、URL ストリングの長さに制限があるものがあります。長さが 256 文字を超える場合、一部のブラウザまたはサーバーでは失敗する場合があります。このパラメータが null の場合、例外がスローされます。
Adobe AIR によるファイルの読み込み中、書き込み中、または転送中に入出力エラーが発生したために、アップロードが失敗した場合
ユーザー名とパスワードなど、認証が必要なサーバーにファイルをアップロードしようとしたことが原因でアップロードが失敗した場合
アップロード中、ユーザーがパスワードを入力する方法はありません。
url パラメータに無効なプロトコルが含まれることが原因でアップロードが失敗した場合
この問題を回避するには、この SWF ファイルを、ネットワークアクセスを許可されたローカル SWF ファイル、または信頼できる SWF ファイルとして再分類します。この例外がスローされると、アクセスできないローカルファイルの名前および URL を示すメッセージが送信されます。ファイルブラウズのセッションは、一度に 1 つのみ実行できます。
2)URL パラメータが有効なパスまたはプロトコルでない場合
ファイルのアップロードには HTTP を使用する必要があります。
イベントの詳細
ユーザーがアップロードまたはダウンロードするファイルをファイル参照ダイアログボックスからキャンセルしたときに送出されます。ユーザーが他の手段 (ブラウザを閉じたり、現在のアプリケーションを停止したりすること) によってアップロードまたはダウンロードをキャンセルした場合、Flash Player はこのイベントを送出しません。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。操作をキャンセルするオブジェクトへの参照です。次の例では、cancel イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。ダウンロードが完了、またはアップロードで HTTP ステータスコード 200 が生成された場合に送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。読み込みが完了したネットワークオブジェクトです。次の例では、complete イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。サーバーから返された HTTP ステータスコードです。HTTP ステータスコードを受け取るネットワークオブジェクトです。アップロードに失敗し、HTTP ステータスコードを使用して失敗を記述することができない場合に送出されます。Flash Player で実行されるコンテンツの場合、このイベントはダウンロードの失敗には適用されません。HTTP エラーのためにダウンロードが失敗した場合は、I/O エラーとして通知されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。サーバーから返された HTTP ステータスコードです。HTTP ステータスコードを受け取るネットワークオブジェクトです。アップロードまたはダウンロードが失敗したときに送出されます。次のいずれかの理由により、ファイル転送に失敗することがあります。
Player でファイルの読み込み中、書き込み中、または転送中に入出力エラーが発生した場合
ユーザー名とパスワードなど、認証が必要なサーバーに SWF ファイルがファイルをアップロードしようとした場合
認証が必要なサーバーに対して SWF ファイルがファイルをアップロードしようとすると、アップロードは失敗します。
スタンドアローンまたは外部 Player 内で、認証が必要なサーバーから SWF ファイルがファイルをダウンロードしようとした場合
ダウンロードする際、スタンドアローンまたは外部 Player には、ユーザーがパスワードを入力する手段がありません。認証が必要なサーバーから、これらの Player 内の SWF ファイルがファイルをダウンロードしようとすると、ダウンロードは失敗します。重要:ブラウザ内で実行される、つまり、ブラウザプラグインまたは ActiveX コントロールを使用するアプリケーションと、Adobe AIR で実行されるコンテンツでのみ、認証用のユーザー名とパスワードを入力できるダイアログボックスを表示できます。ただし、それはダウンロードの場合のみです。Flash Player のプラグインまたは ActiveX コントロールバージョンを使用するアップロードの場合、または、スタンドアローンまたは外部 Player を使用するアップロードまたはダウンロードの場合、ファイル転送は失敗します。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
特定のエラーに関連付けられた参照番号です(AIR のみ)
入出力エラーが発生したネットワークオブジェクトです。エラーメッセージとして表示されるテキストです。アップロード処理またはダウンロード処理が開始するときに送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。接続をオープンしたネットワークオブジェクトです。次の例で、download イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。ファイルのアップロード処理中またはダウンロード処理中に定期的に送出されます。progress イベントは、Flash Player がバイトをサーバーに転送しているときに送出され、最終的に転送が成功しなくても、転送の実行中は定期的に送出されます。ファイルの転送が実際に成功して完了したかどうか、およびそのタイミングを確認するには、complete イベントを受け取ります。例えば、転送対象ファイルが非常に小さい場合や、アップロードやダウンロードが非常に短時間に終わる場合、progress イベントは送出されない場合があります。このイベントには、次のプロパティがあります。リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。読み込みプロセスが成功した場合に最終的に読み込まれるアイテムまたはバイトの総数です。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。進行状況をレポートする オブジェクトです。次の例では、progress イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。download() メソッドの呼び出しによって、サーバーにファイルをアップロードするか、呼び出し元のセキュリティサンドボックスの外部にあるサーバーからファイルを取得しようとすると、送出されます。呼び出し側の SWF ファイルが自分のドメインの外にある SWF ファイルにアクセスしようとして、アクセス権限がないと発生します。URL ポリシーファイルを使用することで、このエラーに対処できます。Adobe AIR では、これらのセキュリティ制限は、アプリケーションセキュリティサンドボックス内のコンテンツには適用されません。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。セキュリティエラーを報告するネットワークオブジェクトです。エラーメッセージとして表示されるテキストです。ユーザーがアップロードするファイルまたはダウンロードするファイルをファイル参照ダイアログボックスから選択したときに、送出されます。ユーザーがファイルを選択し、「OK」などをクリックして操作を確認すると、FileReference オブジェクトのプロパティに値が設定されます。Flash Player または Adobe AIR ランタイムのアプリケーションセキュリティサンドボックス外で実行されるコンテンツの場合、select イベントは、どのメソッドがそのイベントを呼び出したかにより、わずかに異なった動作をします。これは、ユーザーが選択したファイルが、ローカルファイルシステムに存在するためです。これは、select イベントが送出された時点では、ファイルがまだローカルファイルシステムにダウンロードされていないためです。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。アイテムが選択されたオブジェクトです。次の例では、select イベントオブジェクトの使用方法を示します。url プロパティを変更して、架空の http://www ではなく実際のドメインとファイルを参照するようにします。[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合があります。xml ファイルを置いておく必要があります。アップロードの正常終了後、サーバーからデータを受信したときに送出されます。サーバーからデータが返されないと、このイベントは送出されません。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。ファイルアップロードが正常に終了した後、サーバーから返された生データです。
例 例の使用法
次の例では、実行時にロードされるファイルのデータフォーマットとステータス情報を表示します。cfm という名前のファイルを参照している必要があります。設定に基づいて、[ローカルでの再生に関するセキュリティ] を [ネットワークにのみアクセスする] に設定して SWF ファイルをコンパイルする必要がある場合もあります。または Flash Player のセキュリティ設定を更新して、このファイルのネットワークアクセスを許可する必要がある場合もあります。
0 言語およびコンポーネントリファレンス
これらの文字列は、使用される移行モードに応じて、新しいストリームへのトランジションやストリームの再生で用いられる動作を制御します。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。[静的] ストリームを再生リストに追加します。[静的] それまでの再生呼び出しをクリアし、指定されたストリームを直ちに再生します。[静的] 再生リストにあるストリームの再生を停止します。[静的] あるコンテンツのストリームを異なるコンテンツのストリームに置き換え、再生リストの他の部分はそのまま保持します。[静的] あるストリームの再生から別のストリームの再生に切り替えます。通常、同じコンテンツのストリームに対して行われます。
コンストラクタの詳細
ストリームを再生リストに追加します。それまでの再生呼び出しをクリアし、指定されたストリームを直ちに再生します。再生リストにあるストリームの再生を停止します。再生リストを停止し、リセットします。あるコンテンツのストリームを異なるコンテンツのストリームに置き換え、再生リストの他の部分はそのまま保持します。再生リストの他の部分はそのままです。このモードを使用するのは、切り換えるストリームが互いに無関係でコンテンツや長さが異なる場合です。1 つの例としては、ユーザーのトラッキングや過去のコマーシャル視聴率に基づいて、あるコマーシャルを別のコマーシャルに入れ替える場合があります。あるストリームの再生から別のストリームの再生に切り替えます。通常、同じコンテンツのストリームに対して行われます。このモードは、同じコンテンツでビットレートまたは解像度が異なるストリームに切り替えるときに使用します。例えば、アプリケーションがストリームを再生リストに置くか、特定のビットレートで単一のストリームを再生しているときにこのモードを使用すると、利用できる帯域幅または CPU 能力がストリームが必要とするより高いか低いかを判断します。すると、アプリケーションはビットレートの高いまたは低いストリームに更新することができます。あるストリームから、コンテンツの異なる別のストリームに切り換えるには、代わりに RESET モードを使用します。
0 言語およびコンポーネントリファレンス
SharedObject クラスは、ユーザーのコンピュータまたはサーバー上で限定された量のデータを読み込みおよび格納するために使用されます。共有オブジェクトを使用すると、ローカルコンピュータまたはリモートサーバー上に永続化されているクライアント SWF ファイルとオブジェクト間で、リアルタイムでデータを共有することができます。ローカル共有オブジェクトはブラウザのクッキーに似ており、リモート共有オブジェクトはリアルタイムデータ転送デバイスに似ています。共有オブジェクトを使用して次の操作を行います。ローカルの永続性を維持する。getLocal() を呼び出して、アプリケーション内にメモリ付き電卓などの共有オブジェクトを作成することができます。ユーザーが電卓を閉じると、Flash Player により共有オブジェクトの最後の値がユーザーのコンピュータに保存されます。次に電卓を実行すると、電卓に前の値が表示されます。電卓アプリケーションを閉じる前に共有オブジェクトのプロパティを null に設定すると、次にアプリケーションを起動したときに、電卓にいずれの値も表示されません。その他のローカルの永続性の管理例としては、複雑な Web サイトのユーザー環境設定やその他のデータ (ニュースサイト上でユーザーが閲覧した記事のレコードなど) のトラッキングがあります。この情報をトラッキングすると、新規で未読の記事でなく、既に閲覧された記事を表示できます。この情報をユーザーのコンピュータに保存すると、サーバーの負荷を削減できます。サーバー上の共有オブジェクトには、他のクライアントが取得可能なデータを格納できます。このオブジェクトは、サーバー上に永続化されます。あるクライアントが共有オブジェクトを変更すると、現在そのオブジェクトに接続しているクライアントおよび後でそのオブジェクトに接続するクライアントのすべてが、変更されたデータを利用できます。オブジェクトがローカルに永続化され、サーバーに接続されていないときにクライアントがデータを変更すると、次回クライアントがリモート共有オブジェクトに接続するときに、データがそのオブジェクトにコピーされます。リアルタイムでデータを共有する。共有オブジェクトは、複数のクライアント間でリアルタイムにデータを共有できます。例えば、チャットルームに接続しているユーザーのリストを格納するリモート共有オブジェクトを開くことができます。これはオブジェクトに接続しているすべてのクライアントに表示することができます。ユーザーがチャットルームに入退室するときに、オブジェクトが更新され、オブジェクトに接続しているすべてのクライアントに、更新後のチャットルームユーザーの一覧が表示されます。アプリケーションを閉じると、共有オブジェクトが保存されます。つまり、ディスクに書き込まれます。また、flush() メソッドを呼び出して、データを明示的にディスクに書き込むこともできます。
ローカルディスク領域についての考慮事項
ローカル共有オブジェクトには、アプリケーションを設計する際に考慮が必要な、いくつかの制限があります。SWF ファイルでローカル共有オブジェクトの書き込みが許可されない場合があります。ローカル共有オブジェクトに格納されているデータが、わからないうちに削除される場合もあります。Flash Player のユーザーは、個々のドメインまたはすべてのドメインで使用できるディスク領域を管理できます。ユーザーが使用可能なディスク領域の量を減らすと、一部のローカル共有オブジェクトが削除される可能性があります。Flash Player のユーザーには、サードパーティドメイン(現在のブラウザのアドレスバーにあるドメイン以外のドメイン)によるローカル共有オブジェクトの読み取りまたは書き込みを防止できるプライバシーコントロール機能もあります。注意:リモートサーバーではなくローカルコンピュータに格納および実行される SWF ファイルは、常にサードパーティの共有オブジェクトをディスクに書き込むことができます。サードパーティの共有オブジェクトについて詳しくは、Flash Player ヘルプの[グローバルストレージ設定] パネルを参照してください。ディスク領域の量とユーザーのプライバシーコントロールに関する失敗についてチェックすることをお勧めします。getLocal() ユーザーがサードパーティの共有オブジェクトを無効にしていて、SWF ファイルのドメインとブラウザのアドレスバーに表示されるドメインが一致しない場合など、このメソッドの呼び出しに失敗すると、Flash Player は例外をスローします。Flash Player はローカルに保存する情報用の記憶域を増加するようにユーザーに要求します。したがって、netStatus イベントは保存に失敗したか成功したかを示す情報オブジェクトと一緒に送出されます。SWF ファイルでローカル共有オブジェクトを作成または変更しようとする場合、SWF ファイルの幅が最低でも 215 ピクセル、高さが最低でも 138 ピクセルあることを確認してください。このサイズは、ダイアログボックス (ローカル共有オブジェクトの記憶域制限を増やすかどうかをユーザーに確認する) を表示するための最小の大きさです。Flash Media Server では、アプリケーションに接続しているすべてのクライアントがリアルタイムで共有する、リモート共有オブジェクトを作成および使用できます。あるクライアントがリモート共有オブジェクトのプロパティを変更すると、接続しているすべてのクライアントのプロパティが変更されます。リモート共有オブジェクトを使用すると、例えば、マルチプレーヤーゲームのユーザーなどのクライアントを同期できます。各リモート共有オブジェクトに data プロパティがあります。これは、データを格納するプロパティを持つオブジェクトです。サーバーは、プロパティを更新し、sync イベントを送出し、接続しているクライアントにプロパティを返送します。クライアント、サーバー、またはその両方のリモート共有オブジェクトを永続化できます。デフォルトでは、サイズが最大 100K の永続的なリモート共有オブジェクトがローカルに保存されます。大きなオブジェクトを保存しようとすると、[ローカル記憶領域] ダイアログボックスが表示されます。このダイアログボックスでは、ユーザーが共有オブジェクト用のローカル記憶域の使用を許可または拒否できます。ステージのサイズは必ず 215 × 138 ピクセル以上に設定してください。これは、ダイアログボックスを表示するために必要な最小サイズです。ユーザーが「許可」をクリックすると、サーバーに共有オブジェクトが保存され、netStatus イベントが送出されます。ユーザーが「拒否」を選択すると、サーバーに共有オブジェクトは保存されず、netStatus イベントが送出されます。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
コールバックメソッドが呼び出されるオブジェクトを示します。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。[読み取り専用] オブジェクトの data プロパティに割り当てられた属性のコレクションです。これらの属性は共有および保存することができます。[静的] SWF ファイルで作成されたすべてのローカル共有オブジェクトのデフォルトのオブジェクトエンコード(AMF バージョン)です。[書き込み専用] 共有オブジェクトに対するクライアントの変更がサーバーに送信される回数(1 秒あたり)を指定します。この共有オブジェクトのオブジェクトエンコード(AMF バージョン)です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。[読み取り専用] 共有オブジェクトの現在のサイズ(バイト数)です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。ローカル共有オブジェクトの場合、すべてのデータを消去し、共有オブジェクトをディスクから削除します。リモート共有オブジェクトとサーバーとの間の接続を閉じます。指定した NetConnection オブジェクトを介して、サーバー上のリモート共有オブジェクトに接続します。イベントをイベントフローに送出します。ローカルに永続化された共有オブジェクトを直ちにローカルファイルに書き込みます。[静的] 現在のクライアントだけが利用できるローカル永続共有オブジェクトへの参照を返します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。リモート共有オブジェクトに接続しているすべてのクライアント(メッセージを送信したクライアントも含む)に、メッセージをブロードキャストします。共有オブジェクトのプロパティの値が変更されたことをサーバーに通知します。共有オブジェクトのプロパティの値を更新し、プロパティの値が変更されたことをサーバーに通知します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。非同期形式で、つまりネイティブ非同期コードから例外がスローされると送出されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。SharedObject インスタンスが、そのステータスまたはエラーの状況をレポートするときに送出されます。リモート共有オブジェクトがサーバーによって更新されるときに送出されます。
プロパティの詳細
コールバックメソッドが呼び出されるオブジェクトを示します。デフォルトのオブジェクトは this です。client プロパティを別のオブジェクトに設定し、コールバックメソッドをその別のオブジェクトで呼び出すことができます。オブジェクトの data プロパティに割り当てられた属性のコレクションです。これらの属性は共有および保存することができます。次のコードでは、共有オブジェクトの各種属性に値を割り当てています。永続的なオブジェクトの場合は、共有オブジェクトの data プロパティのすべての属性が保存されます。また共有オブジェクトには次の情報が含まれています。このような割り当ては無視されます。共有オブジェクトのプライベート値(オブジェクトの使用中にそのクライアントインスタンスでのみ利用でき、閉じるときにオブジェクトと共に保存されない値)を作成するには、data 以外の名前のプロパティを作成して、その値を保存します。次に例を示します。共有オブジェクトには次のデータが含まれます。サーバーで使用されるリモート共有オブジェクトの場合、共有オブジェクトに接続しているすべてのクライアントが data プロパティのすべての属性を利用可能で、そのオブジェクトが永続化されている場合、すべての属性が保存されます。あるクライアントが属性の値を変更すると、すべてのクライアントに新しい値が表示されます。SWF ファイルで作成されたすべてのローカル共有オブジェクトのデフォルトのオブジェクトエンコード(AMF バージョン)です。ローカル共有オブジェクトとリモート共有オブジェクトのエンコードの違いを含む、オブジェクトエンコードの詳細については、objectEncoding プロパティの説明を参照してください。0 フォーマット AMF3 を使用するように設定されています。
0 SWF ファイルで読み込めるローカル共有オブジェクトの書き込みが必要な場合は、ローカル共有オブジェクトを作成する前に、スクリプトの先頭部分で SharedObject
それ以降に作成されるすべてのローカル共有オブジェクトで、AMF0 エンコーディングが使用され、古いコンテンツとやり取りできるようになります。SWF ファイルで作成したすべての共有オブジェクトに対してではなく、オブジェクトごとにオブジェクトエンコードを設定するには、ローカル共有オブジェクトの objectEncoding プロパティを設定します。共有オブジェクトに対するクライアントの変更がサーバーに送信される回数(1 秒あたり)を指定します。クライアントとサーバー間のトラフィック量を制限する場合に、このメソッドを使用します。
例えば、クライアントとサーバー間の接続が比較的遅い場合は、fps を小さめの値に設定するとよいでしょう
逆に、クライアントが、タイミングが重要なマルチユーザーアプリケーションに接続している場合は、fps をやや大きめの値に設定できます。fps を設定すると、sync イベントがトリガされ、サーバーに対するすべての変更が更新されるようになります。サーバーを手動のみで更新する場合は、fps を 0 に設定します。sync イベントが送出されるまで、サーバーに変更は送信されません。つまり、サーバーからの応答時間が遅い場合、更新がサーバーに送られる頻度は、このプロパティに指定した値よりも少なくなる可能性があります。この共有オブジェクトのオブジェクトエンコード(AMF バージョン)です。オブジェクトエンコードは、共有オブジェクトがローカルかリモートかによって、処理方法が異なります。objectEncoding の値は、このローカル共有オブジェクトの書き込み に使用されるフォーマットに影響します。0 SWF ファイルで作成した共有オブジェクトも引き続き SWF ファイルで読み込むことができます。このプロパティは、関連付けられた NetConnection インスタンスにより値が決定されるため、リモート共有オブジェクトでは読み取り専用になります。共有オブジェクトの現在のサイズ(バイト数)です。すべてのデータプロパティを順に確認することによって、共有オブジェクトのサイズが計算されます。オブジェクトが持つデータプロパティが多いほど、サイズの計算に時間がかかります。オブジェクトのサイズを調べる処理は非常に時間がかかる場合があるので、特に必要がない限り、このメソッドの使用は避けてください。次に size プロパティがトレースされ、示されている値が返されます。
メソッドの詳細
ローカル共有オブジェクトの場合、すべてのデータを消去し、共有オブジェクトをディスクから削除します。共有オブジェクトへの参照はアクティブなままで、そのデータプロパティが削除されます。共有オブジェクトがローカルに永続化されている場合、このメソッドによって共有オブジェクトもディスクから削除されます。共有オブジェクトへの参照はアクティブなままで、そのデータプロパティが削除されます。リモート共有オブジェクトとサーバーとの間の接続を閉じます。リモート共有オブジェクトがローカルに永続化されている場合、ユーザーはこのメソッドの呼び出し後に、オブジェクトのローカルコピーを変更できます。ローカルオブジェクトの変更は、次回にユーザーがリモート共有オブジェクトに接続したときに、サーバーに送られます。指定した NetConnection オブジェクトを介して、サーバー上のリモート共有オブジェクトに接続します。接続に成功すると、sync イベントが送出されます。
リモート共有オブジェクトに対する操作を行う前に、try
finally ステートメントを使用してエラーが発生していないかどうかを確認します。次に、sync イベントを監視して処理した後で、共有オブジェクトを変更します。sync イベントを送出する前にローカルで行った変更は失われる場合があります。次の例は、connect() メソッドを呼び出して、リモート共有オブジェクトに接続します。NetConnection インスタンスが有効であり接続されていること、リモート共有オブジェクトがサーバーに正常に作成されたことを確認してください。ローカルに永続化された共有オブジェクトを直ちにローカルファイルに書き込みます。このメソッドを使用しない場合、共有オブジェクトがファイルに書き込まれるのは、共有オブジェクトセッションの終了時となります。
つまり、SWF ファイルが閉じられるとき、共有オブジェクトが参照されなくなってガベージコレクションされるとき、SharedObject
PENDING を返した場合、このドメインからのオブジェクトを保存するためのディスク領域を増やすようユーザーに求めるダイアログボックスが表示されます。ユーザーに対して共有オブジェクトへのディスク領域の割り当てを求める際には、500 バイトの領域が要求されます。要求されたディスク領域をユーザーが割り当てた場合、それ以降、オブジェクトのサイズが 500 バイトを超えない限り、オブジェクトを保存する際に追加のディスク領域を要求されることはありません。ユーザーがこのダイアログボックスに応答すると、このメソッドがもう一度呼び出されます。PENDING : ユーザーはこのドメインからのオブジェクトに対してローカル情報記憶域を許可していますが、割り当てられた領域がオブジェクトを保存するのに十分でありません。FLUSHED: 共有オブジェクトはローカルディスク上のファイルに正常に書き込まれました。このエラーは、ユーザーがこのドメインからのオブジェクトに対して永続的にローカル情報を保存することを許可されていない場合に発生する可能性があります。注意:サードパーティドメイン(現在のブラウザのアドレスバーにあるドメイン以外のドメイン)の共有オブジェクトのディスクへの書き込みを許可していない場合でも、ローカルコンテンツでは、常にサードパーティドメインの共有オブジェクトをディスクに書き込むことができます。現在のクライアントだけが利用できるローカル永続共有オブジェクトへの参照を返します。共有オブジェクトがまだ存在しない場合は、このメソッドにより作成されます。次のコードでは、返された共有オブジェクトの参照の変数への割り当て方法を示します。注意:ユーザーがこのドメイン用のローカル記憶域を許可していない場合は、localPath の値が指定されていても、オブジェクトはローカルに保存されません。ただし、ローカルコンテンツは例外です。サードパーティドメイン(現在のブラウザのアドレスバーにあるドメイン以外のドメイン)の共有オブジェクトのディスクへの書き込みを許可していない場合でも、ローカルコンテンツでは、常にサードパーティドメインの共有オブジェクトをディスクに書き込むことができます。名前のコンフリクトを避けるために、共有オブジェクトを作成している SWF ファイルの位置が考慮されます。これは、この 2 つの SWF ファイルが異なるディレクトリに置かれているからです。localPath パラメータはオプションですが、慎重に使用する必要があります。特に、他の SWF ファイルが共有オブジェクトにアクセスしなければならない場合には注意してください。共有オブジェクトのデータが、別の場所に移動されない 1 つの SWF ファイルに固有のものである場合は、デフォルト値を使用することをお勧めします。他の SWF ファイルが共有オブジェクトにアクセスする必要がある場合、または共有オブジェクトを作成する SWF ファイルを後で移動する場合には、このパラメータの値により、共有オブジェクトへのアクセスに影響が生じます。例えば、localPath をデフォルト値である SWF ファイルの完全パスに設定して共有オブジェクトを作成すると、他の SWF ファイルはその共有オブジェクトにアクセスできません。元の SWF ファイルを後で別の場所に移動すると、その SWF ファイルからも、共有オブジェクトに格納されているデータにアクセスできなくなります。共有オブジェクトへのアクセスを誤って制限してしまうのを避けるには、localpath パラメータを使用します。ドメインのすべての SWF ファイルが共有オブジェクトを利用できますが、ドメイン内の他の共有オブジェクトとの名前のコンフリクトが起こりやすくなります。より制限の厳しい方法は、localPath に SWF ファイルへの完全パス内のフォルダ名を付加する方法です。アプリケーションに最適な柔軟性を提供できる方法がどれかを判断する必要があります。このメソッドを使用するときは、次のセキュリティモデルを考慮してください。サンドボックスの境界を越えて共有オブジェクトにアクセスすることはできません。[Flash Player の設定] ダイアログボックスまたは設定マネージャを使用して、共有オブジェクトへのアクセスを制限できます。デフォルトでは、アプリケーションでドメインごとに最大 100 KB の共有オブジェクトを作成できます。管理者および一般ユーザーは、ファイルシステムへの書き込み機能に制限を適用することもできます。ローカルファイル(ローカルにインストールされた SWF ファイルまたは EXE ファイル)として再生する SWF ファイルコンテンツをパブリッシュし、複数のローカル SWF ファイルから特定の共有オブジェクトにアクセスする必要があるとします。この状況では、ローカルファイルでは共有オブジェクトの保存に 2 つの異なる場所が使用されることがあるので注意してください。使用されるドメインは、共有オブジェクトを作成したローカルファイルに付与されるセキュリティ許可によって変わります。ローカルファイルには、次の 3 つの異なる許可レベルを設定できます。
ローカルファイルシステムのみに対するアクセス
ネットワークのみに対するアクセス
ネットワークとローカルファイルシステムの両方に対するアクセス
ローカルファイルシステムへのアクセス権を持つローカルファイル(レベル 1 または 3)は、共有オブジェクトを 1 つの場所に格納します。ローカルファイルシステムへのアクセス権を持たないローカルファイル(レベル 2)は、共有オブジェクトを別の場所に格納します。詳しくは、次のトピックを参照してください。名前にはスラッシュ(/)を含めます。共有オブジェクト名にスペース、および以下の文字を含めることはできません。これによって、共有オブジェクトをローカルに保存する場所が決まります。このパラメータを指定しない場合は、完全パスが使用されます。SWF ファイルが HTTPS 接続経由で配信されている場合、このパラメータの値には次の効果があります。このパラメータを true に設定すると、Flash Player は新しいセキュアな共有オブジェクトを作成するか、既存のセキュアな共有オブジェクトの参照を取得します。このセキュアな共有オブジェクトに対する読み取りまたは書き込みは、HTTPS で配信された SWF ファイルによってのみ行えます。このパラメータが false に設定されている場合、Flash Player は共有オブジェクトを新しく作成するか、または HTTPS 以外の接続で配信された SWF ファイルから読み込みまたは書き込みのできる既存の共有オブジェクトに対する参照を取得します。SWF ファイルが HTTPS 以外の接続で配信された場合、このパラメータを true に設定しようとすると、新しい共有オブジェクトの作成(または作成済みのセキュアな共有オブジェクトへのアクセス)は失敗し、null が返されます。このパラメータの値にかかわらず、作成された共有オブジェクトには、当該ドメインで使用可能な合計ディスク容量の枠が適用されます。次の図に、secure パラメータの使用方法を示します。SharedObject — ローカルに永続化され、現在のクライアントでのみ利用できる共有オブジェクトへの参照です。共有オブジェクトを作成できない場合、または共有オブジェクトが見つからない場合(localPath に指定したディレクトリが存在しない場合など)、このメソッドは例外をスローします。サードパーティの Flash コンテンツによる永続共有オブジェクトの作成と保存が禁止されている(ローカルコンテンツに適用されない)場合、このエラーが発生することがあります。html にある設定マネージャのグローバル記憶域設定パネルでサードパーティの永続共有オブジェクトを禁止できます。リモート共有オブジェクトがまだ存在しない場合は、このメソッドにより作成されます。次に示すように、リモート共有オブジェクトを作成するために getRemote() を呼び出し、connect() を呼び出してリモート共有オブジェクトをサーバーに接続します。共有オブジェクトのローカルおよびリモートコピーを同期させるには、sync イベントを監視して処理します。このオブジェクトを共有するすべてのクライアントは、name パラメータと remotePath パラメータに同じ値を渡す必要があります。
現在のクライアントでのみ利用できる共有オブジェクトを作成するには、SharedObject
名前にはスラッシュ(/)を含めることができます。共有オブジェクト名にスペース、および以下の文字を含めることはできません。このパラメータでは、共有オブジェクトをローカルで保存する場合の場所も指定できます。有効な値は次のとおりです。false 値は、共有オブジェクトがクライアントまたはサーバーで永続的ではないことを指定します。true 値は、共有オブジェクトがサーバー上のみで永続的であることを指定します。共有オブジェクトへのローカルの完全パスまたは部分パスは、共有オブジェクトがクライアントとサーバー上で永続的であることを示します。クライアントでは、共有オブジェクトは指定されたパスに保存されます。サーバー上では、アプリケーションディレクトリ内のサブディレクトリに保存されます。注意:ユーザーがこのドメイン用のローカル記憶域を許可していない場合は、永続性のローカルパスが指定されていても、オブジェクトはローカルに保存されません。詳細については、クラスの説明を参照してください。リモート共有オブジェクトに接続しているすべてのクライアント(メッセージを送信したクライアントも含む)に、メッセージをブロードキャストします。メッセージを処理して応答するには、共有オブジェクトに関連付けるコールバック関数を作成します。arguments — 複数の引数 : メッセージを識別するストリング、共有オブジェクトに割り当てる複数のハンドラ関数名、および任意のデータ型のオプションのパラメータです。ハンドラ名の深さは 1 レベルのみで(つまり、親子形式を取ることができません)、共有オブジェクトに相対します。引数は直列化され、接続を介して送信されます。受信側のハンドラは同じ順番でそれらの引数を受け取ります。パラメータが循環オブジェクト(循環するリンクされたリストなど)である場合、シリアライザは参照を正しく処理します。注意:関数名には予約語を使用しないでください。共有オブジェクトのプロパティの値が変更されたことをサーバーに通知します。このメソッドは、変更されたことを示す dirty としてプロパティをマークします。ほとんどの場合、例えばプロパティの値がストリングや数値のようなプリミティブ型のときは、setProperty() を呼び出すことできます。ただし、プロパティの値が独自のプロパティを持つオブジェクトである場合は、setDirty() を呼び出してオブジェクト内の値が変更された日時を示します。共有オブジェクトのプロパティの値を更新し、プロパティの値が変更されたことをサーバーに通知します。ほとんどの場合、例えばプロパティの値がストリングや数値のようなプリミティブ型のときは、setProperty() を使用します。ただし、プロパティの値が独自のプロパティを持つオブジェクトである場合は、setDirty() を使用してオブジェクト内の値が変更された日時を示します。setProperty() は値が変更されたときだけプロパティ値を更新しますが、setDirty() はサブスクライブしているすべてのクライアントを強制的に同期させるからです。プロパティを削除する場合は null を指定します。
イベントの詳細
非同期形式で、つまりネイティブ非同期コードから例外がスローされると送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。イベントを送出するオブジェクトです。イベントをトリガしたエラーです。SharedObject インスタンスが、そのステータスまたはエラーの状況をレポートするときに送出されます。このプロパティは、接続試行が成功したかどうかや共有オブジェクトのローカルディスクへの書き込みが成功したかどうかなど、イベントに関する特定の情報を含む情報オブジェクトです。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。オブジェクトのステータスまたはエラー状態を記述するプロパティを持つオブジェクトです。リモート共有オブジェクトがサーバーによって更新されるときに送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。配列のステータスを記述するプロパティを持つ配列です。
例 例の使用法
0 言語およびコンポーネントリファレンス
TextField クラスは、テキストの表示と入力用の表示オブジェクトを作成するために使用されます。SWF ファイルのダイナミックテキストフィールドおよびテキスト入力フィールドは、すべて TextField クラスのインスタンスです。「プロパティインスペクタ」パネルを使用して、テキストフィールドにインスタンス名を付けることができます。TextField インスタンスの名前は、ムービーエクスプローラに表示されます。また、アクションパネルのターゲットパスの挿入ダイアログボックスにも表示されます。テキストフィールドを動的に作成する場合は、TextField() コンストラクタを使用します。TextField クラスのメソッドを使用すると、オーサリング時または実行時に作成したダイナミックテキストフィールドやテキスト入力フィールドにテキストを設定、選択、および操作できます。ActionScript には、テキストを実行時にフォーマットする方法がいくつか用意されています。CSS を使用すると、ビルトイン HTML タグのスタイル設定、新しいフォーマットタグの定義、またはスタイルの適用を行うことができます。HTML 形式のテキスト(CSS スタイルを使用している場合も可)をテキストフィールドに直接割り当てることができます。この場合テキストは、Web ブラウザ上で HTML ドキュメントの埋め込みメディアの周りをテキストが囲むのと同じように、埋め込みメディアの周りを囲みます。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
この表示オブジェクトの現在のアクセシビリティオプションです。指定されたオブジェクトのアルファ透明度値を示します。true に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容は灰色でハイライト表示されます。このテキストフィールドに使用されるアンチエイリアス処理のタイプです。テキストフィールドの自動的な拡大 / 縮小および整列を制御します。テキストフィールドに背景の塗りがあるかどうかを指定します。テキストフィールドの背景の色です。[書き込み専用] 前景と背景のブレンドに使用するシェーダを設定します。テキストフィールドに境界線があるかどうかを指定します。テキストフィールドの境界線の色です。
[読み取り専用] 指定されたテキストフィールドの現在の表示範囲で最終行を示す整数です(1 から始まるインデックス)
[読み取り専用] カーソル(キャレット)位置のインデックスです。HTML テキストが含まれるテキストフィールド内の余分な空白(スペース、改行など)を削除するかどうかを指定するブール値です。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。このオブジェクトに関連付けられたコンテキストメニューを指定します。テキストフィールドがパスワードテキストフィールドであるかどうかを指定します。埋め込みフォントのアウトラインを使用してレンダリングするかどうかを指定します。表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。このオブジェクトがフォーカス矩形を表示するかどうかを指定します。このテキストフィールドに使用されるグリッドフィッティングのタイプです。
表示オブジェクトの高さを示します(ピクセル単位)
テキストフィールドの内容を HTML で表します。[読み取り専用] テキストフィールド内の文字数です。[読み取り専用] この表示オブジェクトが属するファイルの読み込み情報を含む LoaderInfo オブジェクトを返します。呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。ユーザーが入力するときに、テキストフィールドに入力できる最大の文字数です。このオブジェクトがマウスメッセージを受け取るかどうかを指定します。複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。
[読み取り専用] マウス位置の x 座標を示します(ピクセル単位)
[読み取り専用] マウス位置の y 座標を示します(ピクセル単位)
フィールドが複数行テキストフィールドであるかどうかを示します。[読み取り専用] 複数行テキストフィールド内のテキスト行の数を定義します。表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。ユーザーがテキストフィールドに入力できる文字のセットを指定します。[読み取り専用] 読み込まれた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。現在有効な拡大 / 縮小グリッドです。基準点から適用されるオブジェクトの水平スケール(パーセンテージ)を示します。オブジェクトの基準点から適用されるオブジェクトの垂直スケール(percentage)を示します。オブジェクトの基準点から適用されるオブジェクトの奥行きスケール(パーセンテージ)を示します。現在の水平スクロール位置です。表示オブジェクトのスクロール矩形の境界です。テキストフィールドのテキストの垂直位置です。テキストフィールドが選択可能であるかどうかを示すブール値です。[読み取り専用] 現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。[読み取り専用] 現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。このテキストフィールド内の文字エッジのシャープネスです。[読み取り専用] 表示オブジェクトのステージです。テキストフィールドにスタイルシートを関連付けます。このオブジェクトがタブ順序に含まれるかどうかを指定します。SWF ファイル内のオブジェクトのタブ順序を指定します。テキストフィールド内の現在のテキストであるストリングです。
テキストフィールドのテキストの色です(16 進数形式)
[読み取り専用] テキストの高さです(ピクセル単位)
[読み取り専用] テキストの幅です(ピクセル単位)
このテキストフィールド内の文字エッジの太さです。表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクトです。テキストフィールドのタイプです。テキストと共にテキストのフォーマットをコピー&ペーストするかどうかを指定します。表示オブジェクトが可視かどうかを示します。
表示オブジェクトの幅を示します(ピクセル単位)
テキストフィールドのテキストを折り返すかどうかを示すブール値です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。newText パラメータで指定されたストリングを、テキストフィールドのテキストの最後に付加します。イベントをイベントフローに送出します。文字の境界ボックスである矩形を返します。x および y パラメータで指定されたポイントにある文字の 0 から始まるインデックス値を返します。文字インデックスを指定すると、同じ段落内の最初の文字のインデックスを返します。x および y パラメータで指定されたポイントにある行の 0 から始まるインデックス値を返します。charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します。特定のテキスト行内の文字数を返します。指定されたテキスト行に関するメトリック情報を返します。lineIndex パラメータで指定された行の最初の文字の文字インデックスを返します。文字インデックスを指定すると、指定された文字を含む段落の長さを返します。point オブジェクトをステージ(グローバル)座標から表示オブジェクトの(ローカル)座標に変換します。ステージ(グローバル)座標の 2 次元のポイントを 3 次元の表示オブジェクトの(ローカル)座標に変換します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。表示オブジェクトの境界ボックスを評価して、obj 表示オブジェクトの境界ボックスと重複または交差するかどうかを調べます。表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。3 次元の表示オブジェクトの(ローカル)座標の 3 次元のポイントをステージ(グローバル)座標の 2 次元のポイントに変換します。point オブジェクトを表示オブジェクトの(ローカル)座標からステージ(グローバル)座標に変換します。指定されたプロパティが存在し、列挙できるかどうかを示します。現在の選択内容を value パラメータの内容に置き換えます。ループ処理に対するダイナミックプロパティの可用性を設定します。最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します。format パラメータで指定したテキストフォーマットを、テキストフィールド内の指定されたテキストに適用します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。表示オブジェクトが表示リストに追加されたときに送出されます。表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。値が変更される前に送出される textInput イベントとは異なり、コントロールの値が変更された後に送出されます。ユーザーがコンテキストメニューから「削除」を選択した場合に送信されます。AIR アプリケーションでこのインタラクティブオブジェクトに関連付けられているコンテキストメニューをユーザージェスチャがトリガすると送出されます。ユーザーがコピー操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「コピー」を選択した場合に送信されます。ユーザーがカット操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「カット」を選択した場合に送信されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。[ブロードキャストイベント] 再生ヘッドが新しいフレームに入るときに送出されます。[ブロードキャストイベント] 再生ヘッドが現在のフレームを終了するときに送出されます。表示オブジェクトがフォーカスを取得した後に送出されます。表示オブジェクトがフォーカスを失った後に送出されます。[ブロードキャストイベント] フレーム表示オブジェクトのコンストラクタが実行した後で、かつフレームスクリプトが実行される前に送出されます。ユーザーがキーを押したときに送出されます。ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。ユーザーがキーを離したときに送出されます。
HTML が有効になっているテキストフィールドのハイパーリンクをユーザーがクリックしたときに送出されます(URL は "event:" で始まります)
ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。
ドラッグされたオブジェクトがターゲットにドロップされ、そのドロップ操作が DragManager
ユーザーがペースト操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「ペースト」を選択した場合に送信されます。表示オブジェクトが表示リストから削除されようとしているときに送出されます。表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。[ブロードキャストイベント] 表示リストが更新およびレンダリングされようとしているときに送出されます。ユーザーがスクロールした後に、TextField オブジェクトによって送出されます。ユーザーがすべて選択操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「すべて選択」を選択した場合に送信されます。オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。
プロパティの詳細
true に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容は灰色でハイライト表示されます。false に設定され、テキストフィールドにフォーカスがない場合、テキストフィールド内の選択内容はハイライト表示されません。次のファイルをコンパイルして実行します。
ファイルの実行時に、2 つのテキストフィールドでそれぞれのテキストをドラッグ操作で選択すると、2 つのテキストフィールドでの選択ハイライトの違いがわかります(フォーカスの変更)
このテキストフィールドに使用されるアンチエイリアス処理のタイプです。このプロパティの値を設定するには、次のストリング値を使用します。通常のテキストにアンチエイリアスを適用します。この値は、Flash Player 7 以前のバージョンで使用されているアンチエイリアスのタイプと一致します。文字を読みやすくする高度なアンチエイリアスを適用します。高度なアンチエイリアスでは、小さいサイズのフォントフェイスを高品質でレンダリングすることができます。これは、小さいフォントのテキストが多いアプリケーションでの使用に最も適しています。48 ポイントより大きいフォントに対して高度なアンチエイリアスを使用することはお勧めしません。テキストフィールドの自動的な拡大 / 縮小および整列を制御します。NONE(デフォルト値)に設定されていると、サイズ変更は行われません。LEFT に設定すると、テキストは左揃えテキストとして扱われます。つまり、テキストフィールドの左マージンが固定され、テキストフィールドの単一行の右マージンのみが伸縮します。テキストに改行(「\n」や「\r」など)が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWrap も true に設定した場合、テキストフィールドの下側だけが伸縮し、右側は固定されたままになります。RIGHT に設定すると、テキストは右揃えテキストとして扱われます。つまり、テキストフィールドの右マージンが固定され、テキストフィールドの単一行の左マージンのみが伸縮します。テキストに改行(「\n」や「\r」など)が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWrap も true に設定した場合、テキストフィールドの下側だけが伸縮し、左側は固定されたままになります。CENTER に設定すると、テキストは中央揃えテキストとして扱われます。つまり、テキストフィールドの単一行のサイズ変更を行うと、左右両マージンが均等に伸縮されます。テキストに改行(「\n」や「\r」など)が含まれる場合、テキストの次の行が収まるようにフィールドの下側も拡張されます。wordWrap も true に設定した場合、テキストフィールドの下側だけが伸縮し、左右両側は固定されたままになります。テキストフィールドに背景の塗りがあるかどうかを指定します。true である場合、テキストフィールドに背景の塗りがあります。false である場合、テキストフィールドには背景の塗りがありません。テキストフィールドの背景の色です。このプロパティは、現在背景がない場合でも取得または設定できます。ただし、背景の色が表示されるのはテキストフィールドの background プロパティが true に設定されている場合のみです。テキストフィールドに境界線があるかどうかを指定します。true である場合、テキストフィールドに境界線があります。false である場合、テキストフィールドに境界線がありません。テキストフィールドの境界線の色です。このプロパティは、現在境界線がない場合でも取得または設定できます。ただし、境界線の色が表示されるのはテキストフィールドの border プロパティが true に設定されている場合のみです。
指定されたテキストフィールドの現在の表示範囲で最終行を示す整数です(1 から始まるインデックス)
テキストフィールドは、テキストのブロックにかぶせたウィンドウのようなものです。
scrollV プロパティは、そのウィンドウに表示されている先頭行を示すインデックスです(1 から始まるインデックス)
カーソル(キャレット)位置のインデックスです。カーソルが表示されていない場合、この値は、フォーカスをフィールドに戻した場合にカーソルが表示される位置を示します。通常は、カーソルの最後の位置を示します。フィールドにフォーカスがなかった場合は 0 になります。選択範囲のインデックスは 0 から始まります。つまり、最初の位置は 0、2 番目の位置は 1 で、以下同様に続きます。次に、テキストを選択せずにテキストフィールドをクリックします。HTML テキストが含まれるテキストフィールド内の余分な空白(スペース、改行など)を削除するかどうかを指定するブール値です。次に例を示します。null のプロパティはありません。注意:このプロパティはテキストフィールドにスタイルシートが適用されていると設定できません。Error — このメソッドは、スタイルシートを使用するテキストフィールドに対しては使用できません。テキストフィールドがパスワードテキストフィールドであるかどうかを指定します。このプロパティの値が true である場合、テキストフィールドはパスワードテキストフィールドとして扱われ、入力された文字は実際の文字の代わりにアスタリスクで隠されます。false である場合、テキストフィールドはパスワードテキストフィールドとして扱われません。パスワードモードを有効にすると、「カット」コマンドと「コピー」コマンド、およびそれに対応するキーボードショートカットが機能しなくなります。このセキュリティ機能により、ユーザーの不在時にキーボードショートカットを使用して悪質なユーザーがパスワードを盗むことを防止できます。埋め込みフォントのアウトラインを使用してレンダリングするかどうかを指定します。false である場合は、デバイスフォントを使用してテキストフィールドをレンダリングします。指定したフォントが SWF ファイルに埋め込まれていない場合、テキストは表示されません。このテキストフィールドに使用されるグリッドフィッティングのタイプです。
このプロパティは、テキストフィールドの flash
使用されるグリッドフィッティングのタイプによって、太い水平線と垂直線がピクセルグリッドまたはサブピクセルグリッドに合わされるか、まったく合わされないかが決定されます。グリッドフィッティングなしを指定します。文字の水平方向と垂直方向の線は、ピクセルグリッドに合わされません。これは、アニメーションや大きなフォントサイズにお勧めする設定です。太い水平線と垂直線がピクセルグリッドに合わされるように指定します。この設定は左揃えのテキストフィールドに対してのみ機能します。
この設定を使用するには、テキストフィールドの flash
左揃えのテキストは通常、この設定を使用すると、最も読みやすくなります。太い水平線と垂直線が、LCD モニタのサブピクセルグリッドに合わされるよう指定します。
この設定を使用するには、テキストフィールドの flash
SUBPIXEL 設定は、右揃えまたは中央揃えのダイナミックテキストに適した設定で、アニメーション品質とテキスト品質のバランスを取るのに便利です。この例を使用する場合は、最初の 2 行の読みやすさに違いがあることに注意してください。SUBPIXEL の最適な使用方法についても注意してください。テキストフィールドの内容を HTML で表します。<a> タグはハイパーリンクを作成するもので、次の属性を指定できます。target:ページを読み込み先のターゲットウィンドウの名前を指定します。_self オプションは現在のウィンドウ内の現在のフレームを指定します。_top は現在のウィンドウ内のトップレベルのフレームを指定します。ユーザーがイベントスキームを含むハイパーテキストリンクをクリックすると、テキストフィールドが link TextEvent を送出します。<b> タグは、テキストをボールドで表示します。ボールド体を利用できるフォントで使用する必要があります。<br> タグは、テキストフィールドに改行を作成します。このタグを使用するには、テキストフィールドを複数行テキストフィールドに設定します。<font> タグは、テキストを表示するフォントまたはフォントリストを指定します。フォントタグには、次の属性を指定できます。face:使用するフォントの名前を指定します。次の例が示すように、カンマで区切られたフォント名の一覧を指定することもできます。指定したフォントがローカルのコンピュータシステムにインストールされていないか、または SWF ファイルに組み込まれていない場合、Flash Player は代替フォントを選択します。size:フォントのサイズを指定します。テキストは、テキストフィールドに埋め込んだイメージの周囲に自動的に配置されます。このタグを使用するには、テキストがイメージの周囲で折り返されるように、テキストフィールドを複数行に設定する必要があります。src:イメージファイルまたは SWF ファイルへの URL、またはライブラリ内のムービークリップシンボルへのリンケージ識別子を指定します。この属性は必須です。他の属性はすべて省略可能です。width:挿入されるイメージ、SWF ファイル、またはムービークリップのピクセル単位の幅です。height:挿入されるイメージ、SWF ファイル、またはムービークリップのピクセル単位の高さです。align:テキストフィールド内の埋め込みイメージの水平整列を指定します。hspace:イメージの周りの水平方向の空白の量(テキストが表示されない領域)を指定します。デフォルト値は 8 です。vspace:イメージの周りの垂直方向の空白の量(テキストが表示されない領域)を指定します。デフォルト値は 8 です。id:埋め込みイメージファイル、SWF ファイル、またはムービークリップを含むムービークリップインスタンスの名前(Flash Player が作成したもの)を指定します。この方法は、ActionScript を使用して埋め込みコンテンツを制御する場合に使用されます。ポリシーファイルが存在する場合、ファイルに記載されているドメイン内の SWF ファイルは、読み込まれたイメージのデータにアクセスできます。draw() メソッドの呼び出しを、このイメージを source パラメータにして実行することよってアクセスできます。Flash はテキストフィールドに埋め込まれたメディアをフルサイズで表示します。一般に、テキストフィールドに埋め込まれたイメージは、<img> タグの次の行に表示されます。ただし、<img> タグがテキストフィールドの最初の文字であった場合、イメージはテキストフィールドの最初の行に表示されます。これはフィッシング攻撃を防ぐためです。<i> タグは、指定されたテキストをイタリックで表示します。イタリック体を利用できるフォントで使用する必要があります。<li> タグは、このタグに囲まれたテキストの行頭に箇条書き記号を表示します。どのリストにも番号は付かず、すべてのリストアイテムに箇条書き記号が使用されます。<p> タグは新しい段落を作成します。このタグを使用するには、テキストフィールドを複数行テキストフィールドに設定する必要があります。<p> タグには、次の属性を指定できます。align:段落内のテキストの整列を指定します。次の属性をサポートします。indent:左マージンから段落の先頭文字までのインデントを指定します。正の数と負の数の両方を使用できます。tabstops:カスタムタブストップを負以外の整数の配列として指定します。<u> タグを付けたテキストには下線が引かれます。text プロパティの値がトレースされると、HTML タグなしのフォーマットされていないストリングが表示されます。テキストフィールド内の文字数です。タブ(\t)などの文字も 1 文字としてカウントされます。ユーザーが入力するときに、テキストフィールドに入力できる最大の文字数です。スクリプトは maxChars の許容数を超えるテキストを挿入できます。maxChars プロパティで指定されるのは、ユーザーが入力できるテキストの量だけです。このプロパティの値が 0 である場合、ユーザーが入力できるテキストの量には制限がありません。複数行にわたるテキストフィールドで、ユーザーがテキストフィールドをクリックしてホイールを回転させると、自動的にスクロールするかどうかを示すブール値です。このプロパティは、マウスホイールでテキストフィールドをスクロールしない場合や、テキストフィールドのスクロールを独自に実装する場合に便利です。フィールドが複数行テキストフィールドであるかどうかを示します。値が true である場合は複数行テキストフィールド、値が false である場合は単一行テキストフィールドです。複数行テキストフィールド内のテキスト行の数を定義します。ユーザーがテキストフィールドに入力できる文字のセットを指定します。restrict プロパティの値が空のストリングである場合は、いずれの文字も入力できません。restrict プロパティの値が文字のストリングである場合は、そのストリング内の文字のみをテキストフィールドに入力できます。ストリングは左から右へスキャンされます。ハイフン(-)文字を使用して、範囲を指定できます。制限されるのはユーザー入力のみです。スクリプトは任意のテキストをテキストフィールドに入力できます。このプロパティは、プロパティインスペクタの埋め込みフォントのオプションと同期しません。ストリングがキャレット(^)文字で始まる場合、そのストリングに含まれる文字を除いて、すべての文字を入力できます。ストリングがキャレット(^)文字以外で始まる場合は、そのストリングに含まれる文字のみを入力できます。次の例では、大文字、スペース、および数値のみをテキストフィールドに入力できます。次の例では、小文字を除くすべての文字を入力できます。円記号を使用して ^ または - のリテラルを入力できます。円記号をストリングの 1 文字として実際に使用するには、ActionScript で指定するときに円記号を 2 つ続けて指定する必要があります。例えば、次のコードで表されているのはダッシュ(-)とキャレット(^)のみです。ストリング内では任意の場所で ^ を使用し、入力できる文字と除外する文字を切り替えることができます。次のコードでは、大文字のみを入力できます。ただし、大文字の Q を除きます。現在の水平スクロール位置です。scrollH プロパティが 0 である場合、テキストは水平にスクロールされません。このプロパティの値は、水平位置をピクセル単位で表す整数です。垂直スクロールの単位は行数ですが、水平スクロールの単位はピクセル数です。水平スクロールをピクセル単位で指定するのは、一般的に使用されるフォントのほとんどがプロポーショナルフォントであり、文字の幅が一定でないためです。垂直スクロールの場合は、通常、1 行のテキストの一部だけ表示されるよりも行全体が表示されることが好まれるため、行単位でスクロールします。1 行の中に複数のフォントが存在する場合でも、使用されている最大のフォントに合わせて行の高さが調整されます。テキストフィールドのテキストの垂直位置です。scrollV プロパティは、長い文節内の特定の段落にユーザーを誘導したり、スクロールテキストフィールドを作成する場合に便利です。水平スクロールの単位はピクセル数ですが、垂直スクロールの単位は行数です。表示される最初の行がテキストフィールド内の最初の行の場合、scrollV は 1 に設定されます。0 ではありません。水平スクロールをピクセル単位で指定するのは、フォントのほとんどがプロポーショナルフォントであり、文字の幅が一定でないためです。垂直スクロールの場合は、通常、1 行のテキストの一部だけ表示されるよりも行全体が表示されることが好まれるため、行単位でスクロールします。1 行の中に複数のフォントが存在する場合でも、使用されている最大のフォントに合わせて行の高さが調整されます。テキストフィールドが選択可能であるかどうかを示すブール値です。値 true は、テキストが選択可能であることを示します。selectable プロパティを使用することで、テキストフィールドが選択可能かどうかを指定できますが、編集可能かどうかは指定できません。ダイナミックテキストフィールドは、編集可能でない場合でも選択可能にすることができます。ダイナミックテキストフィールドが選択可能でない場合、ユーザーはフィールド内のテキストを選択できません。selectable を false に設定すると、テキストフィールド内のテキストはマウスやキーボードからの選択コマンドに応答しなくなり、「コピー」コマンドを使用してテキストをコピーすることができなくなります。selectable を true に設定すると、テキストフィールド内のテキストはマウスやキーボードを使用して選択できるようになり、「コピー」コマンドを使用してテキストをコピーできるようになります。テキスト入力フィールドではなくダイナミックテキストフィールドの場合でも、この方法でテキストを選択できます。次の例では、2 つのダイナミックテキストフィールドを作成します。この例を使用する場合は、これらのフィールド内のテキストをマウスまたはキーボードを使用して選択してください。現在の選択範囲の最初の文字を示す、0 から始まるインデックス値です。
例えば、最初の文字が 0、次の文字が 1 と続きます(以下同様)
次に、テキストを選択せずにテキストフィールドをクリックします。現在の選択範囲における最後の文字を示す、0 から始まるインデックス値です。
例えば、最初の文字が 0、次の文字が 1 と続きます(以下同様)
次に、テキストを選択せずにテキストフィールドをクリックします。このテキストフィールド内の文字エッジのシャープネスです。
このプロパティは、テキストフィールドの flash
テキストフィールドにスタイルシートを関連付けます。0 のプログラミング』を参照してください。テキストフィールドに関連付けられているスタイルシートは、いつでも変更することができます。使用されているスタイルシートを変更すると、テキストフィールドは新しいスタイルシートを使用して再描画されます。使用されているスタイルシートを削除すると、テキストフィールドはスタイルシートを使用せずに再描画されます。htmlText の内容は両方とも、以前にスタイルシートで適用したフォーマットを適用するように変更されます。htmlText の内容をフォーマットなしで保存するには、スタイルシートを削除する前に変数にその値を保存します。テキストフィールド内の現在のテキストであるストリングです。このプロパティは、HTML タグが付いていない、テキストフィールド内のフォーマットなしのテキストを示します。text プロパティの値がトレースされると、HTML タグなしのフォーマットされていないストリングが表示されます。
テキストフィールドのテキストの色です(16 進数形式)
16 進数カラーシステムでは、6 桁の数値を使用して色の値を示します。
テキストの高さです(ピクセル単位)
テキストの幅です(ピクセル単位)
このテキストフィールド内の文字エッジの太さです。テキストフィールドのタイプです。DYNAMIC はダイナミックテキストフィールドを指定します。このフィールドをユーザーが編集することはできません。INPUT はテキスト入力フィールドを指定します。このフィールドはユーザーが編集できます。両方のテキストフィールドにテキストが入力されます。テキストと共にテキストのフォーマットをコピー&ペーストするかどうかを指定します。true に設定されている場合、テキストフィールド間でコピー&ペーストを行うと、Flash Player によってフォーマット(行揃え、ボールド、イタリックなど)もコピー&ペーストされます。tf2 テキストフィールドからテキストをコピーし、tf1 テキストフィールドに貼り付けた場合、貼り付けられたテキストにはフォーマットが含まれません。テキストフィールドのテキストを折り返すかどうかを示すブール値です。幅に対して大きすぎるコンテンツが含まれる 2 つの TextField インスタンスが作成されます。
コンストラクタの詳細
メソッドの詳細
newText パラメータで指定されたストリングを、テキストフィールドのテキストの最後に付加します。特定の位置までの文字数とテキストフィールドの行数もカウントされます。outputText テキストフィールドが、autoSize プロパティにより、テキストに合わせて自動的に設定され、サイズが左揃えテキストに合わせて変更されます。text プロパティで開始する必要はありません。text プロパティをもう一度設定すると、元のテキストが上書きされます。+= 演算子を使用して、text プロパティでコンテンツを追加します。if ステートメントは、日付が木曜日(6)か日曜日(0)かをチェックします。テキストフィールドの length プロパティは、関数が呼び出される直前の文字数を読み取るために使用され、numLines プロパティは、テキストフィールドの行数をカウントするために使用されます。空白行が行数にカウントされ、コンテンツの長さを特定するために空白文字と改行(\n)がカウントされます。文字の境界ボックスである矩形を返します。つまり、最初の位置は 0、2 番目の位置は 1 で、以下同様に続きます。クラスは、選択された各文字の周囲に矩形を描画するために使用する spotlight Shape オブジェクトを定義します。テキストフィールドがテキストより大きい場合があるので、返される整数(index)がチェックされ、ユーザーが文字をクリックしたかどうかが確認されます。文字の幅と高さの境界のサイズを持つ新しい矩形が、返された frame 矩形の x および y 座標を使用して、文字の位置((10, 10) 座標からのオフセット)に生成されます。スペースも文字と見なされます。x および y パラメータで指定されたポイントにある文字の 0 から始まるインデックス値を返します。
例えば、最初の位置は 0、次の位置は 1 と続きます(以下同様)
指定されたポイントがどの文字の上にもない場合は -1 を返します。次の例では、ユーザーが文字をクリックすると、文字がテキストの上の別のテキストフィールドにエコーされます。最初のテキストフィールドは、ユーザーが選択するテキストを保持します。テキストフィールドがテキストより大きい場合があるので、返される整数(index)がチェックされ、ユーザーが文字をクリックしたかどうかが確認されます。エコーされた文字が表示される新しいテキストフィールドの座標を設定するために、マウスの座標が使用されます。2 番目のテキストフィールドの文字の色は赤に設定されます。最後に、2 番目のフィールドのテキストが、charAt() メソッドを使用して取得された、選択した文字に設定されます。文字インデックスを指定すると、同じ段落内の最初の文字のインデックスを返します。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。int — 同じ段落内の最初の文字を示す、0 から始まるインデックス値です。次の例では、テキストフィールドのコンテンツに段落フォーマットが適用されます。ユーザーが段落をクリックすると、段落のテキストが右揃えになり、もう一度段落をクリックすると、元の(デフォルト)フォーマット(左揃え)に戻ります。コンストラクタで、myTextField テキストフィールドがテキストを折り返すように設定されます。getTextFormat メソッドが、テキストフィールドにあるコンテンツの最初の文字の元のフォーマットを返します。最初の if ステートメントは、ユーザーが文字をクリックしたかどうかを確認します。2 番目の if ステートメントは、段落の最初の文字のフォーマットをチェックします。整列値が元のフォーマット(左揃え)と同じ場合、段落のすべての文字に新しいフォーマットが適用されます。それ以外の場合は、段落のフォーマットの設定が元のフォーマットに戻ります。整列とは、インデント、中黒、タブストップ、左右マージンなどのフォーマットと共に、段落に使用するフォーマットです。<img> タグを使用して HTML フォーマットのテキストフィールドに追加されたイメージまたは SWF ファイルに関するものです。外部ソースから読み込まれたメディアの場合、このオブジェクトは Loader オブジェクトであり、いったん読み込まれると、メディアオブジェクトはその Loader オブジェクトの子になります。SWF ファイルに埋め込まれたメディアの場合、これは読み込まれたオブジェクトです。次の例では、テキストフィールドをクリックすると、フィールド内のイメージの透明度が 25% に設定され、元の回転角度から 90 度回転します。クリックが続けられるたびに、イメージは回転し続けます。ここでは、イメージファイルが SWF ファイルと同じディレクトリにあると仮定します。id 属性を img タグに対して定義する必要があります。htmlText プロパティが HTML フォーマットのストリングコンテンツを組み込むために使用されます。表示オブジェクトのマトリックス、カラー変換、ピクセル境界にアクセスするために、transform プロパティも使用できます。x および y パラメータで指定されたポイントにある行の 0 から始まるインデックス値を返します。
例えば、最初の行は 0、次の行は 1 と続きます(以下同様)
指定されたポイントがどの行の上にもない場合は -1 を返します。次の例では、ユーザーがシェイクスピアのソネットからある行を選択すると、その行が新しいテキストフィールドにコピー(追加)されます。
コンストラクタで、poem テキストフィールドが折り返されないように設定されます(このテキストが詩であるため)
また、autoSize プロパティを使用して、テキストが収まるように自動的に設定され、左揃えテキストとしてサイズが変更されます。次に、行のインデックスを使用して、getLineText() メソッドで、ストリングとして行のコンテンツを取得します。このストリングは、poemCopy テキストフィールドのコンテンツに追加されます。コピーは連続して実行できますが、あるポイントを過ぎると、テキストが表示できる poemCopy テキストフィールドの範囲を超えます。charIndex パラメータで指定された文字を含む行の 0 から始まるインデックス値を返します。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。myTextField テキストフィールドが、折り返しを行い、左揃えテキストとしてサイズが変更されるように定義されます。その後、この情報が段落の後に追加されます。行のインデックスは 0 から始まるので、行のインデックス(index)は 1 ずつ増加して、行番号を取得します。また、表示サイズが変更され、行番号が変更された場合でも、メソッドは一度しか呼び出されないので、ここでの情報は同じ状態が維持されます。特定のテキスト行内の文字数を返します。次の例では、ユーザーが行を選択すると、その行の長さ(文字数)が別のテキストフィールドに表示されます。この場合、ユーザーは、実際に行を変更したり、行の間または末尾に行を追加したりできます。最終行の末尾に、改行(\n)を使用して作成された空白行があります。このテキストは選択できません。if ステートメントは、ユーザーが文字をクリックしたかどうかを確認します。ユーザーが文字をクリックした場合は、getLineLength() メソッドが、行のインデックスを使用して行の文字数を返します。行間の空白行には 2 番目の改行(\n)が含まれます。この行は、1 文字としてカウントされ、最終行の後の行は 0 文字としてカウントされます。スペースも 1 文字としてカウントされます。ユーザーは、新しい行を書き込むか行を変更し、その行をクリックして、行の文字数を取得できます。テキストの折り返しを使用し、画面のサイズを変更すると、行のインデックスが変更される場合があります。指定されたテキスト行に関するメトリック情報を返します。次の例では、フォーマットの異なる 2 つのテキスト行のいくつかの行のメトリック値を表示します。1 行目はデフォルトのフォーマットを保持します。行のインデックスは 0 で始まります。取得された数値はストリングに変換されますが、四捨五入されません。この値は行に対する値であり、特定の文字に対する値ではありません。ある行の文字の範囲を反映しています。例えば、ある行に異なる高さのフォーマットを持つ異なる文字がある場合、値は最大の高さを持つ文字によって決まります。このことは、ある文字のフォーマットが変更された場合、メトリック値の一部が変更される場合があることも意味します。lineIndex パラメータで指定された行の最初の文字の文字インデックスを返します。
例えば、最初の行は 0、次の行は 1 と続きます(以下同様)
int — 行の最初の文字を示す、0 から始まるインデックス値です。次の例では、4 行目の最初の文字をチェックします。この文字は、画面(およびテキストフィールド)のサイズが変更された場合に変更されます。myTextField テキストフィールドがテキストを折り返すように設定されます。1 行目のインデックスは 0 です。charAt() メソッドを使用して、4 行目の最初の文字のインデックスを使用する文字を取得します。text プロパティを使用すると、クリックするたびに countField テキストフィールドのコンテンツが上書きされます。ユーザーが表示サイズを変更すると、コンテンツが折り返され、4 行目の最初の文字が変わる可能性があります。
例えば、最初の行は 0、次の行は 1 と続きます(以下同様)
String — 指定された行に含まれるテキストストリングです。次の例では、シェイクスピアのソネットで使用される単語 "love" のすべてのインスタンスの行番号が検索され、表示されます。poem テキストフィールドが、テキストに合わせて自動的に設定され、サイズが左揃えテキストに合わせて変更されます。ただし、通常 autoSize プロパティを使用する場合、折り返しは問題にはなりません。for ループが、テキストフィールドの numLines プロパティを使用してソネットの行の繰り返し処理を実行します。正規表現パターン(/love/i)を使用すると、if ステートメントがこの単語の大文字または小文字のサブストリングを検索します。
パターンが見つかると、search メソッドが最初に一致したサブストリングのインデックスを返し、それ以外の場合は -1 を返します(一致するものがない場合)
ストリング(「 」)である他の引数がある場合にのみ、ストリングメソッドによって、数値の引数((i + 1))がストリングに変換されます。文字インデックスを指定すると、指定された文字を含む段落の長さを返します。この長さは、渡された文字インデックスからではなく、段落内の最初の文字からの相対的な長さです。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。次の例では、ユーザーが段落を選択すると、段落の長さと段落内の文字 "s" の数が別のテキストフィールドに表示されます。最初の if ステートメントは、ユーザーが文字をクリックしたかどうかを確認します。getParagraphLength() メソッドによって返された段落の長さが段落内の最初の文字のインデックスで使用され、段落の末尾のインデックスが算出されます。for ループが段落の繰り返し処理を実行して、文字 "s" の数を探します。指定されたテキスト全体に共通するプロパティのみが、結果の TextFormat オブジェクトに設定されます。混在型のプロパティ(テキストの位置によって異なる値が指定されている場合)は、その値が null に設定されます。これらのパラメータに値を指定しない場合、このメソッドはテキストフィールド内のすべてのテキストに適用されます。次の表に、使用できる 3 つのシンタックスを示します。テキストフィールド内すべてのテキストに関するフォーマット情報を含む TextFormat オブジェクトを返します。テキストフィールド内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定されます。混在型のプロパティ(テキストの位置によって異なる値が指定されている場合)は、その値が null に設定されます。指定された範囲内のすべてのテキストに共通するプロパティのみが結果の TextFormat オブジェクトに設定されます。混在型のプロパティ(範囲内の位置によって異なる値が指定されている場合)は、その値が null に設定されます。テキストフィールド内のテキスト範囲の開始位置を指定する整数です。通常の埋め込みフォントは、TextField オブジェクトでのみ使用されます。現在の選択内容を value パラメータの内容に置き換えます。テキストは、現在のデフォルトの文字フォーマットとデフォルトの段落フォーマットを使用して、現在の選択内容の位置に挿入されます。テキストは HTML として扱われません。replaceSelectedText() メソッドを使用すると、他の部分のテキストの文字フォーマットおよび段落フォーマットを損なわずにテキストを挿入および削除できます。注意:このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。Error — このメソッドは、スタイルシートを使用するテキストフィールドに対しては使用できません。次の例では、ユーザーが最初のテキストフィールドから一部のテキストを選択し、消去して、選択したテキストを 2 番目のテキストフィールドで "NEW TEXT" ストリングに置き換えます。ユーザーがマウスを離すとマウスアップイベントが発生します。通常、このイベントはテキストを選択した後に発生します。選択するテキストの設定は、テキストフィールドのデフォルト設定です。この操作は、すべてのテキストが消去されるまで続行できます。この操作は、2 番目のテキストフィールドのすべての元のテキストが "NEW TEXT" ストリングに置き換えられるまで続行できます。注意:このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。Error — このメソッドは、スタイルシートを使用するテキストフィールドに対しては使用できません。次の例では、replaceText() メソッドを使用して、テキストの一部を削除し、置換えて、テキストフィールドに挿入します。outputText テキストフィールドが、テキストに合わせて自動的に設定され、サイズが左揃えテキストに合わせて変更されます。appendText() の呼び出しごとに、現在のテキストの開始インデックスと終了インデックスが変更されます。ここでは、最後のテキスト(変更が行われた後)だけが表示されます。最初の文字と最後の文字のインデックス値によって指定されたテキストを選択済みに設定します。2 つのパラメータ値が同じ場合、このメソッドは、caretIndex プロパティを設定した場合と同様に挿入ポイントを設定します。つまり、最初の文字が 0、2 番目の文字が 1 で、以下同様に続きます。
次の例では、ユーザーがテキストフィールドの任意の場所をクリックすると、あらかじめ定義されたテキストの範囲が選択されます(語句 "TEXT IN ALL CAPS" がハイライト表示されます)
myTextField テキストフィールドの 2 つのイベントリスナーが、ユーザーのマウスクリックまたはマウスアップイベントに応答します。ユーザーがマウスを離すとマウスアップイベントが発生します。通常、このイベントはテキストを選択した後に発生します。選択するテキストの設定は、テキストフィールドのデフォルト設定です。format パラメータで指定したテキストフォーマットを、テキストフィールド内の指定されたテキストに適用します。注意:このメソッドは、テキストフィールドにスタイルシートが適用されていると機能しません。setTextFormat() メソッドは、テキストフィールドの文字の範囲またはテキスト全体に適用するテキストフォーマットを変更します。フォーマットのプロパティをテキストフィールド内のすべてのテキストに適用するには、beginIndex および endIndex に値を指定しないでください。length プロパティを使用して、インデックス値を指定できます。TextFormat オブジェクトのフォーマット情報には、文字レベルフォーマットと段落レベルフォーマットの 2 種類があります。テキストフィールド内の各文字にも、フォント名やフォントサイズ、ボールド、イタリックなどの文字固有のフォーマットを設定できます。段落の場合は、段落の最初の文字を調べて段落全体のフォーマット設定を判別します。段落のフォーマット設定には、左マージン、右マージン、インデントなどがあります。ユーザーによって手作業で挿入されたテキスト、または replaceSelectedText() メソッドを使用して置き換えられたテキストは、テキストの挿入か所に指定されているフォーマットではなく、新しいテキスト用のテキストフィールドのデフォルトフォーマットが適用されます。textFormat のプロパティをテキストフィールドのすべてのテキストに適用します。ユーザーによって手作業で挿入されたテキスト、または replaceSelectedText() メソッドを使用して置き換えられたテキストは、テキストの挿入か所に指定されているフォーマットではなく、新しいテキスト用のテキストフィールドのデフォルトフォーマットが適用されます。新しいテキスト用のテキストフィールドのデフォルトフォーマットを設定するには、defaultTextFormat プロパティを使用します。Error — このメソッドは、スタイルシートを使用するテキストフィールドに対しては使用できません。次の例では、テキストをクリックすると、定義済みのテキスト範囲 "TEXT IN ALL CAPS" のフォーマットがデフォルトのテキストフォーマットと新しいフォーマットの間で切り替わります。if ステートメントが currentTextFormat テキストフォーマットをチェックして、範囲内の文字に新しいフォーマット(フォントポイントが 18 に設定されます)が適用されているかどうかを確認します。適用されていない場合、新しいフォーマットによって、サイズが 18 ポイント、色が赤に変更されます。範囲内の文字に新しいフォーマットが適用されている場合、範囲のフォーマットの設定がテキストフィールドのデフォルト(元の)フォーマットに戻ります。
イベントの詳細
値が変更される前に送出される textInput イベントとは異なり、コントロールの値が変更された後に送出されます。0 バージョンはコントロールが変更されたときに送出されます。例えば、ユーザーがテキストフィールドにテキストを入力すると、キーストロークのたびに change イベントが送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。値が変更されたオブジェクトです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。次の例では、ユーザーが入力したテキスト(ユーザー入力)が、異なるテキストフォーマットで、他のテキストフィールドに即座にコピー(エコー)されます。CHANGE イベントで呼び出されたのではない場合、ユーザーが入力したコンテンツは、ユーザーが別の入力を行った後でのみコピーされます。
HTML が有効になっているテキストフィールドのハイパーリンクをユーザーがクリックしたときに送出されます(URL は "event:" で始まります)
注意:デフォルトの動作であるテキストフィールドへのテキストの追加は、Flash Player がイベントを生成するときにのみ発生します。この場合は、ユーザーがテキストを入力しようとするときです。textInput イベントに送信することによってテキストフィールドにテキストを入力することはできません。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。クリックされたハイパーリンクを含むテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。playMP3() 関数は、ユーザーがどちらかのリンクをクリックしたときに呼び出されます。ユーザーがスクロールした後に、TextField オブジェクトによって送出されます。このイベントには、次のプロパティがあります。false は、キャンセルするデフォルトの動作がないことを示します。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。target プロパティは、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。標準キーボード、IME(入力メソッドエディタ)、音声認識システム、書式やスタイルの情報を持たないプレーンテキストのペースト操作など、様々なテキスト入力メソッドによって、このイベントが生成されます。このイベントには、次のプロパティがあります。イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。文字が入力されるテキストフィールドです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。ユーザーが入力した文字または文字の連続です。テキストブロックを入力フィールドに貼り付けると、イベントハンドラによってブロック全体がもう一方のフィールドにコピーされます。
例 例の使用法
これを行うには、以下の手順を使用します。テキストフィールドを左揃えにします。背景の塗りを有効にします。境界線を有効にします。次に、パラメータを次のように設定します。表示リストには、初期状態でステージ上にテキストがないテキストフィールドが表示されます。" に設定します。
0 言語およびコンポーネントリファレンス
TextFormat クラスを使用して、テキストフィールドに特定のテキストフォーマットを作成します。静止テキストフィールドおよびダイナミックテキストフィールドの両方にテキストフォーマットを適用できます。TextFormat クラスのプロパティは、デバイスフォントおよび埋めこみフォントに適用されます。ただし、埋め込みフォントの場合、ボールドとイタリックのテキストには、実際に特定のフォントが必要です。埋め込みフォントでボールドまたはイタリックのテキストを表示する場合は、そのフォントのボールド体およびイタリック体を埋め込む必要があります。setTextFormat() メソッドを使用してテキストフィールドに適用する場合、それらに定義されたプロパティのみが適用されます。各プロパティのデフォルトのフォーマットについては、各プロパティの説明でも説明します。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
段落の整列の設定を示します。ブロックのインデントをピクセル単位で示します。テキストをボールドにするかどうかを指定します。テキストが箇条書きリストの一部かどうかを示します。テキストの色を示します。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。このテキストフォーマットでのテキストフォント名を示すストリングです。左マージンから段落の先頭文字までのインデントを示します。このテキストフォーマットのテキストをイタリックにするかどうかを示します。行間の垂直の行送りを示す整数です。段落の左マージンをピクセル単位で示します。すべての文字の間に均等に配分されるスペースの量を表す数値です。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。段落の右マージンをピクセル単位で示します。このテキスト形式のテキストサイズ(ピクセル単位)です。カスタムタブストップを負以外の整数の配列として指定します。ハイパーリンクを表示するターゲットウィンドウを示します。このテキストフォーマットを使用するテキストにアンダーラインを表示する(true)か、表示しない(false)かを示します。このテキストフォーマットのテキストの対象 URL を示します。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。
プロパティの詳細
段落の整列の設定を示します。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。ブロックのインデントをピクセル単位で示します。ブロックのインデントは、テキストのブロック全体、つまりテキストのすべての行に適用されます。ブロックのインデントは 0 です。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。テキストをボールドにするかどうかを指定します。この場合、ボールド体は使用されません。値が true の場合は、テキストがボールド体になります。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。テキストが箇条書きリストの一部かどうかを示します。箇条書きリストでは、テキストの各段落がインデントされます。各段落の先頭行の左に箇条書きシンボルが表示されます。この場合、箇条書きリストは使用されません。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。テキストの色を示します。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。このテキストフォーマットでのテキストフォント名を示すストリングです。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。左マージンから段落の先頭文字までのインデントを示します。デフォルト値は null で、インデントは使用されないことを示します。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。このテキストフォーマットのテキストをイタリックにするかどうかを示します。この場合、イタリックは使用されません。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。カーニングでは、読みやすくするために、特定の文字ペア間でピクセルを調整します。大きなフォントの見出しを使用する場合など、必要な場合にのみ使用する必要があります。カーニングは、埋め込みフォントに対してのみサポートされています。デフォルト値 null はカーニングを無効にします。行間の垂直の行送りを示す整数です。デフォルト値は null で、使用される行送りは 0 であることを示します。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。段落の左マージンをピクセル単位で示します。この場合、左マージンは 0 ピクセルです。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。すべての文字の間に均等に配分されるスペースの量を表す数値です。この値は、各文字の後の送りに追加されるピクセル数を示します。この場合、0 ピクセルの文字間隔が使用されます。75 などの小数点を含む数値を使用することができます。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。段落の右マージンをピクセル単位で示します。この場合、右マージンは 0 ピクセルです。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。このテキスト形式のテキストサイズ(ピクセル単位)です。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。カスタムタブストップを負以外の整数の配列として指定します。各タブストップはピクセル単位で指定します。カスタムタブストップを指定しないと(null)、タブストップはデフォルトの 4(平均文字幅)になります。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。ハイパーリンクを表示するターゲットウィンドウを示します。ターゲットウィンドウが空のストリングである場合、テキストはデフォルトのターゲットウィンドウ _self に表示されます。カスタム名を選択することも、次の 4 つの名前のいずれかを選択することもできます。_self は現在のウィンドウ内の現在のフレームを指定します。_top は現在のウィンドウ内のトップレベルのフレームを指定します。url プロパティが空のストリングまたは null の場合は、このプロパティを取得および設定することはできますが、プロパティは何の影響も及ぼしません。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。このテキストフォーマットを使用するテキストにアンダーラインを表示する(true)か、表示しない(false)かを示します。これは、<U> タグによって設定されるアンダーラインと似ていますが、このタグの場合はデセンダが正しくスキップされないので、本物のアンダーラインではありません。この場合、アンダーラインは使用されません。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。このテキストフォーマットのテキストの対象 URL を示します。url プロパティが空のストリングである場合、テキストにはハイパーリンクがありません。この場合、テキストにはハイパーリンクがありません。注意:ハイパーリンクを機能させるには、テキストフォーマットが割り当てられたテキストを htmlText プロパティで設定する必要があります。このプロパティの使用方法の詳細については、TextFormat() コンストラクタの例を参照してください。
コンストラクタの詳細
この TextFormat オブジェクトのプロパティを変更して、テキストフィールドのフォーマットを変更できます。null 値を設定したパラメータは未設定になります。すべてのパラメータはオプションです。省略したパラメータは null として扱われます。url が空のストリングである場合、テキストにはハイパーリンクがありません。ターゲットウィンドウが空のストリングである場合、テキストはデフォルトのターゲットウィンドウ _self に表示されます。url パラメータに空のストリングまたは null 値を指定した場合は、このプロパティを取得または設定することはできますが、プロパティには何の影響もありません。次の例では、ユーザーは、別のテキストフィールドのコンテンツに適用されるリストから、様々なテキストフォーマットオプションを選択できます。ユーザーがテキストフィールドのコンテンツをクリックすると、フォーマットがデフォルト(元の)フォーマットに戻ります。(タブ設定は、行のタブごとに別個のタブストップを定義する配列です。この場合、ユーザーが url 行を選択すると、コンテンツが現在のウィンドウに表示されます。これにより、ユーザーが行ったすべてのフォーマット変更がクリアされます。
例 例の使用法
ここでは以下の手順を実行します。次に、そのパラメータを次のように設定します。テキストフィールドを左揃えにします。背景の塗りを有効にします。境界線を有効にします。最初は、ステージに表示されるテキストフィールドにテキストが表示されません。白い背景の小さなボックスが表示されるだけです。
0 言語およびコンポーネントリファレンス
TextLine クラスは、テキストを表示リストに表示するために使用されます。TextLine は、その内容をレンダリングするのに必要な最低限の情報をカプセル化します。行のアトムのプロパティについて説明する、いくつかのメソッドを介した操作に役立つ追加情報を取得できます。アトムとは、グラフィックエレメントと文字(結合された文字のグループを含む)の両方、テキスト行を構成する分割できないエンティティについて言及する用語です。これらのメソッドが呼び出されるまで、これらのメソッドが必要とするデータを作成したり、格納したりすることはできません。メモリのオーバーヘッドを避けるため、不必要にアトムデータを作成しないでください。アトムデータが必要なくなった場合、flushAtomData() メソッドを呼び出して、ガベージコレクションで処理されるようにすることができます。以下のメソッドおよびプロパティは、アトムデータがまだ存在しない場合にそれらを生成します。テキスト行に対する通常のイベント送出処理が終了した後で、テキスト行が有効な場合は、テキスト行に指定されるコンテンツエレメントオブジェクトの eventMirror プロパティで指定されるイベントディスパッチャにイベントがミラーされます。イベント通知が失敗または停止した場合や、テキスト行が有効ではない場合は、イベントがミラーされません。マウスイベントのミラーは特殊なケースです。ローマン体のベースラインにラテン語のテキストがある行の垂直位置(y プロパティ)を設定しない場合は、Sprite の最上部の下にテキストのデセンダだけが表示されるので、そこにテキスト行を追加します。次の図を参照してください。以下に示す継承プロパティは TextLine オブジェクトに適用できません。これらのプロパティは読み取ることはできますが、常にデフォルト値が設定されています。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
この表示オブジェクトの現在のアクセシビリティオプションです。指定されたオブジェクトのアルファ透明度値を示します。[読み取り専用] 行のベースラインから最も高さのある文字の最上部までのピクセル数を指定します。[読み取り専用] 行内のアトムの数、つまりスペースおよびグラフィックエレメントを含む、分割できないエレメントの数です。[書き込み専用] 前景と背景のブレンドに使用するシェーダを設定します。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。このオブジェクトに関連付けられたコンテキストメニューを指定します。[読み取り専用] 行のベースラインから最も下に突き出している文字の最下部までのピクセル数を指定します。表示オブジェクトに現在関連付けられている各フィルタオブジェクトが格納されているインデックス付きの配列です。このオブジェクトがフォーカス矩形を表示するかどうかを指定します。[読み取り専用] テキスト行がグラフィックエレメントを含んでいるかどうかを示します。
表示オブジェクトの高さを示します(ピクセル単位)
[読み取り専用] この表示オブジェクトが属するファイルの読み込み情報を含む LoaderInfo オブジェクトを返します。呼び出し元の表示オブジェクトは、指定された mask オブジェクトによってマスクされます。オブジェクトの子に対してマウスが有効かどうかを調べます。このオブジェクトがマウスメッセージを受け取るかどうかを指定します。
[読み取り専用] マウス位置の x 座標を示します(ピクセル単位)
[読み取り専用] マウス位置の y 座標を示します(ピクセル単位)
[読み取り専用] このオブジェクトの子の数を返します。表示オブジェクトが特定の背景色で不透明であるかどうかを指定します。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。[読み取り専用] グラフィックエレメントを表す U+FDEF 文字および行の一部だが表示されない行末の空白を含む、行になったテキストブロック内の生のテキストの長さです。[読み取り専用] 読み込まれた SWF ファイル内の表示オブジェクトの場合、root プロパティはその SWF ファイルが表す表示リストのツリー構造部分の一番上にある表示オブジェクトとなります。現在有効な拡大 / 縮小グリッドです。基準点から適用されるオブジェクトの水平スケール(パーセンテージ)を示します。オブジェクトの基準点から適用されるオブジェクトの垂直スケール(percentage)を示します。オブジェクトの基準点から適用されるオブジェクトの奥行きスケール(パーセンテージ)を示します。表示オブジェクトのスクロール矩形の境界です。[読み取り専用] 表示オブジェクトのステージです。オブジェクトの子に対してタブが有効かどうかを調べます。このオブジェクトがタブ順序に含まれるかどうかを指定します。SWF ファイル内のオブジェクトのタブ順序を指定します。[読み取り専用] テキストブロックの生のテキストで、行の最初にあたる文字のインデックスです。[読み取り専用] テキスト行の論理的な幅です。テキストエンジンが行をレイアウトするのに使用します。表示オブジェクトのマトリックス、カラー変換、ピクセル境界に関係するプロパティを持つオブジェクトです。[読み取り専用] 位置揃えをしていない場合の行の幅です。作成者が任意のデータをテキスト行に関連付けるための方法を提供します。テキスト行の現在の有効性を指定します。表示オブジェクトが可視かどうかを示します。
表示オブジェクトの幅を示します(ピクセル単位)
継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントをイベントフローに送出します。ガベージコレクションのために行のアトムデータを解放します。指定されたインデックス位置にあるアトムの双方向レベルを取得します。テキスト行を基準として、指定されたインデックス位置にあるアトムの境界を取得します。指定されたインデックス位置にあるベースラインに従って測定したアトムの中心を取得します。
指定されたインデックス位置にあるアトムのグラフィックを取得します(アトムが文字の場合は null)
charIndex パラメータで指定された文字を含むアトムのインデックスを返します。行内の各アトムにその文字が指定されていない場合は -1 を返します。x パラメータおよび y パラメータで指定されたポイントにあるアトムのインデックスを返します。そのポイントにアトムがない場合は -1 を返します。指定されたインデックス位置にあるアトムのテキストブロック開始インデックスを取得します。指定されたインデックス位置にあるアトムのテキストブロック終了インデックスを取得します。指定されたインデックス位置にあるアトムの回転を取得します。指定されたインデックス位置にあるアトムの左側に単語境界があるかどうかを示します。指定のインデックス位置にある子表示オブジェクトインスタンスを返します。指定された名前に一致する子表示オブジェクトを返します。point オブジェクトをステージ(グローバル)座標から表示オブジェクトの(ローカル)座標に変換します。ステージ(グローバル)座標の 2 次元のポイントを 3 次元の表示オブジェクトの(ローカル)座標に変換します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。表示オブジェクトの境界ボックスを評価して、obj 表示オブジェクトの境界ボックスと重複または交差するかどうかを調べます。表示オブジェクトを評価して、x および y パラメータで指定されたポイントと重複または交差するかどうかを調べます。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。3 次元の表示オブジェクトの(ローカル)座標の 3 次元のポイントをステージ(グローバル)座標の 2 次元のポイントに変換します。point オブジェクトを表示オブジェクトの(ローカル)座標からステージ(グローバル)座標に変換します。指定されたプロパティが存在し、列挙できるかどうかを示します。表示オブジェクトコンテナの既存の子の位置を変更します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定された 2 つの子オブジェクトの z 順序(重ね順)を入れ替えます。子リスト内の指定されたインデックス位置に該当する 2 つの子オブジェクトの z 順序(重ね順)を入れ替えます。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。表示オブジェクトが表示リストに追加されたときに送出されます。表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの追加により、ステージ上の表示リストに追加されたときに送出されます。ユーザーがコンテキストメニューから「削除」を選択した場合に送信されます。AIR アプリケーションでこのインタラクティブオブジェクトに関連付けられているコンテキストメニューをユーザージェスチャがトリガすると送出されます。ユーザーがコピー操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「コピー」を選択した場合に送信されます。ユーザーがカット操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「カット」を選択した場合に送信されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。[ブロードキャストイベント] 再生ヘッドが新しいフレームに入るときに送出されます。[ブロードキャストイベント] 再生ヘッドが現在のフレームを終了するときに送出されます。表示オブジェクトがフォーカスを取得した後に送出されます。表示オブジェクトがフォーカスを失った後に送出されます。[ブロードキャストイベント] フレーム表示オブジェクトのコンストラクタが実行した後で、かつフレームスクリプトが実行される前に送出されます。ユーザーがキーを押したときに送出されます。ユーザーがキーボード操作によってフォーカスを変更しようとすると送出されます。ユーザーがキーを離したときに送出されます。ユーザーがポインティングデバイスでフォーカスを変更しようとすると送出されます。
ドラッグされたオブジェクトがターゲットにドロップされ、そのドロップ操作が DragManager
ユーザーがペースト操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「ペースト」を選択した場合に送信されます。表示オブジェクトが表示リストから削除されようとしているときに送出されます。表示オブジェクトが、直接、または表示オブジェクトを含むサブツリーの削除により、表示リストから削除されようとしているときに送出されます。[ブロードキャストイベント] 表示リストが更新およびレンダリングされようとしているときに送出されます。ユーザーがすべて選択操作のためにプラットフォーム固有のアクセラレータキーの組み合わせをアクティブ化したとき、またはコンテキストメニューから「すべて選択」を選択した場合に送信されます。オブジェクトの tabIndex プロパティの値が変更されたときに送出されます。[静的] テキスト行の最大要求幅(ピクセル単位)です。
プロパティの詳細
行のベースラインから最も高さのある文字の最上部までのピクセル数を指定します。行内のアトムの数、つまりスペースおよびグラフィックエレメントを含む、分割できないエレメントの数です。このプロパティにアクセスすると、まだアトムデータが存在しない場合は、アトムデータが作成されます。行のベースラインから最も下に突き出している文字の最下部までのピクセル数を指定します。テキスト行がグラフィックエレメントを含んでいるかどうかを示します。グラフィックエレメントを表す U+FDEF 文字および行の一部だが表示されない行末の空白を含む、行になったテキストブロック内の生のテキストの長さです。この値は、変更によって行の改行処理が再度必要になるのかどうかを判断するときに便利です。テキストブロックの生のテキストで、行の最初にあたる文字のインデックスです。インキが使用される高さを取得するには、継承された height プロパティにアクセスします。baselineZero が文字であるかどうかにより、行を結合する文字の最上部と最下部、またはアセントとディセントのいずれかのベースライン間の差に基づいて計算されます。グラフィックエレメントは、これらのベースラインの計算では考慮されません。テキスト行の論理的な幅です。テキストエンジンが行をレイアウトするのに使用します。継承された width プロパティにアクセスし、描画されたすべてのピクセルによる境界ボックスの実際の幅を取得します。この例では、以前の標準の傾きおよび以前のイタリックの行が表示されています。トレース出力は次のとおりです。位置揃えをしていない場合の行の幅です。位置揃えされているテキストの場合、この値は位置揃えされていなかった場合の長さであり、textWidth の値が実際の行の幅を表します。作成者が任意のデータをテキスト行に関連付けるための方法を提供します。テキスト行の現在の有効性を指定します。このプロパティの設定規則は、次のようになります。以前は最初に影響を受けた行にあったコンテンツ部分が、変更によってその前の行に取り込まれるようになる場合、前の行は無効とマークされる必要があります。ユーザーコードは、いずれの行も STATIC とマークできます。またこれにより、行のアトムデータがクリアされ、再作成されないようになります。STATIC のテキスト行内のグラフィックエレメントが STATIC のテキスト行の派生元であるテキストブロックから改行された新しいテキスト行の部分である場合、それらはすべて削除され、親が再設定されます。
メソッドの詳細
これは自動化されたテストで役立ちます。これにはテキスト、書式およびレンダリング情報が含まれます。注意:このメソッドからのコンテンツおよび出力のフォーマットは、今後変更される可能性があります。アドビ システムズ社は、このメソッドの後方互換性は保証していません。ガベージコレクションのために行のアトムデータを解放します。「アトム」とは、テキスト行を構成する分割できないエンティティについて言及する用語です。テキストエンジンは、atomCount プロパティにアクセスするか、アトムに関する情報を取り出すメソッドのどれかを呼び出したときにアトムデータを生成します。指定されたインデックス位置にあるアトムの双方向レベルを取得します。
例えば、テキストブロックがヘブライ語のテキストで始まる場合、TextBlock
アトムがどの行で終わるかは関係ありません。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。テキスト行を基準として、指定されたインデックス位置にあるアトムの境界を取得します。指定されたアトムの境界は、行の水平座標(x)、行の垂直座標(y)、幅(w)および高さ(h)で構成されます。すべての値はピクセル単位です。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。指定されたインデックス位置にあるベースラインに従って測定したアトムの中心を取得します。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。
指定されたインデックス位置にあるアトムのグラフィックを取得します(アトムが文字の場合は null)
このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。charIndex パラメータで指定された文字を含むアトムのインデックスを返します。行内の各アトムにその文字が指定されていない場合は -1 を返します。charIndex は、行を含むテキストブロックのコンテンツ全体に対する相対的な値です。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初の文字は 0、2 番目の文字は 1 で、以下同様に続きます。行内の各アトムにその文字が指定されていない場合は -1 を返します。x パラメータおよび y パラメータで指定されたポイントにあるアトムのインデックスを返します。そのポイントにアトムがない場合は -1 を返します。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。stageY プロパティと一緒に使うことが簡単にできます。int — このポイントにあるアトムのインデックスです。指定されたポイントがどのアトムの上にもない場合は -1 を返します。指定されたインデックス位置にあるアトムのテキストブロック開始インデックスを取得します。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。指定されたインデックス位置にあるアトムのテキストブロック終了インデックスを取得します。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。指定されたインデックス位置にあるアトムの回転を取得します。アトムの回転は、エレメントおよび行の累積された回転です。主に、TextLine を操作するときにキャレット(カーソル)の方向を設定するために使用されます。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。指定されたインデックス位置にあるアトムの左側に単語境界があるかどうかを示します。単語境界は、行に指定される文字の Unicode プロパティに基づいて決定されます。このメソッドを呼び出すと、まだアトムデータが存在しない場合は、アトムデータが作成されます。つまり、最初のアトムは 0、2 番目のアトムは 1 で、以下同様に続きます。テキスト行の最大要求幅(ピクセル単位)です。
例 例の使用法
次の例では、様々なテキスト行およびテキストブロックでアトムを介して、getAtomBounds() を使用して、各テキスト行にフレームを作成する手順を表示します。as という名前で保存します。
0 言語およびコンポーネントリファレンス
テキスト行に対する通常のイベント送出処理が終了した後で、テキスト行が有効で、イベント通知が停止していない場合は、テキスト行のミラー領域にイベントが送出されます。マウスイベントのミラーは特殊なケースです。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
[読み取り専用] テキストラインを基準にするミラー領域の境界です。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
現在の領域が、セット内の最後のミラー領域である場合は null
現在の領域が、セット内の最初のミラー領域である場合は null
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
オブジェクトに指定されたプロパティが定義されているかどうかを示します。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。
プロパティの詳細
テキストラインを基準にするミラー領域の境界です。このオブジェクトは、ミラー領域で特に発生するマウスイベントと、テキスト行がターゲットになる他のすべてのイベントを含みます。
これが、セット内の最後のミラー領域である場合は null
同じ行または別のテキスト行にあります。
現在の領域が、セット内の最初のミラー領域である場合は null
同じ行または別のテキスト行にあります。
例 例の使用法
この例は、ミラー領域のあるテキストのブロックを示しています。この領域をクリックすると赤色に表示されます。
0 言語およびコンポーネントリファレンス
ContextMenu クラスのメソッドとプロパティを使用すると、カスタムメニューアイテムを追加し、ビルトインコンテキストメニューアイテムの表示(「拡大」、「プリント」など)を制御し、新しいメニューを作成することができます。AIR には、ビルトインのアイテムや標準のコンテキストメニューはありません。ContextMenu オブジェクトは、特定のボタンやムービークリップ、テキストフィールドオブジェクト、またはムービー全体に関連付けることができます。これらは、Flash Player を右クリックしたときに表示される標準メニュー、選択可能テキストフィールドまたは編集可能テキストフィールドを右クリックしたときに表示される編集メニュー、Flash Player への SWF ファイルのロードが失敗したときに表示されるエラーメニューです。AIR では編集メニューだけが表示されます。カスタムメニューアイテムは、常に Flash Player コンテキストメニューの一番上に、つまり、表示されるどのビルトインメニューアイテムよりも上に表示されます。ビルトインメニューアイテムとカスタムメニューアイテムの間にはセパレータが表示されます。コンテキストメニューから [設定] メニューアイテムを削除することはできません。[設定] メニューアイテムは、ユーザーがプライバシーやコンピュータの記憶領域に関連する設定を変更できるように用意されているもので、Flash に必須のメニューアイテムです。AIR では、コンテキストメニューのアイテム数に対する明示的な制限はありません。継承されるパブリックプロパティを隠す。
継承されるパブリックプロパティを表示
クリップボードメニューを使用するかどうかを指定します。指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
[オーバーライド] このメニューのカスタムアイテムの配列
[オーバーライド] [読み取り専用] このメニューのアイテム数
[読み取り専用] 親メニューです。[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。継承されるパブリックメソッドを隠す。
継承されるパブリックメソッドを表示
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。メニューの下部に、メニューアイテムを追加します。新しいメニューアイテムを挿入して、メニューにサブメニューを追加します。指定された位置に新しいメニューアイテムを挿入して、メニューにサブメニューを追加します。メニューおよびすべてのアイテムのコピーを作成します。このメニューが、指定されたメニューアイテムを含むかどうかを報告します。イベントをイベントフローに送出します。このメニューを、指定された位置にポップアップ表示します。指定されたインデックス位置にあるメニューアイテムを取得します。指定された名前を持つメニューアイテムを取得します。指定されたアイテムの位置を取得します。EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。オブジェクトに指定されたプロパティが定義されているかどうかを示します。[設定] を除き、指定された ContextMenu オブジェクト内のすべてのビルトインメニューアイテムを非表示にします。Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。指定されたプロパティが存在し、列挙できるかどうかを示します。すべてのアイテムをメニューから削除します。指定されたメニューアイテムを削除します。指定されたインデックス位置にあるメニューアイテムを削除して返します。指定された位置に、メニューアイテムを移動します。ループ処理に対するダイナミックプロパティの可用性を設定します。指定されたオブジェクトのストリング表現を返します。指定されたオブジェクトのプリミティブな値を返します。指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。継承されるイベントを隠す。
継承されるイベントを表示
「ブロードキャスト イベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。「ブロードキャストイベント」- Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。ユーザーが最初にコンテキストメニューを生成したときに、コンテキストメニューの内容が表示される前に送出されます。いずれかのメニューアイテム、またはその子孫のサブメニューのいずれかのアイテムが選択された場合に、この NativeMenu オブジェクトから送出されます。
プロパティの詳細
これらのプロパティは列挙することができ、デフォルトでは true に設定されています。注意: AIR では、コンテキストメニューにビルトインアイテムはありません。これらのプロパティのうちいずれかを false に設定すると、クリップボードメニューの対応するアイテムが無効になります。MENU_SELECT イベント(通常は右クリック)のイベントハンドラを追加し、そのメニューを表示オブジェクトに割り当てます。クリップボードメニューを使用するかどうかを指定します。配列内の各オブジェクトは、定義したカスタムコンテキストメニューアイテムを表します。このプロパティを使用して、これらのカスタムメニューアイテムを追加、削除、変更することができます。
このメニューのカスタムアイテムの配列
配列は、表示順にソートされています。このプロパティが null の場合、通常のコンテキストメニューが表示されます。このプロパティが null 以外の場合、リンクのコンテキストメニューが表示され、指定された url で動作します。
このメニューのアイテム数
コンストラクタの詳細
メソッドの詳細
メニューの下部に、メニューアイテムを追加します。ただし、メニュー内のすべてのアイテムが同じプロパティを持つようにするため、コンテキストメニューでは 1 つの型のオブジェクトのみを使用することをお勧めします。メニューおよびすべてのアイテムのコピーを作成します。このメニューが、指定されたメニューアイテムを含むかどうかを報告します。このメニューを、指定された位置にポップアップ表示します。指定されたインデックス位置にあるメニューアイテムを取得します。指定されたアイテムの位置を取得します。int — 指定されたアイテムの 0 から始まるこのメニューでの位置、または null(アイテムがこのメニューに存在しない場合)です。[設定] を除き、指定された ContextMenu オブジェクト内のすべてのビルトインメニューアイテムを非表示にします。デバッガ版の Flash Player が実行されている場合、デバッグのメニューアイテムは表示されますが、リモートデバッグが有効化されていない SWF ファイルについては、デバッグのメニューアイテムはグレー表示されます。このメソッドは、標準コンテキストメニューに表示されるメニューアイテムだけを非表示にします。編集メニューおよびエラーメニューに表示されるメニューアイテムには影響しません。注意: AIR では、コンテキストメニューにビルトインアイテムはありません。このメソッドを呼び出しても影響はありません。すべてのアイテムをメニューから削除します。指定されたインデックス位置にあるメニューアイテムを削除して返します。
イベントの詳細
ユーザーが最初にコンテキストメニューを生成したときに、コンテキストメニューの内容が表示される前に送出されます。これにより、コンテキストメニューを表示する前に、プログラムによってコンテキストメニューアイテムのセットを変更できます。ユーザーは、ポインティングデバイスを右クリックすることにより、コンテキストメニューを生成します。このイベントには、次のプロパティがあります。