| パッケージ | mx.core |
| public class DragSource | |
| 継承 | DragSource  Object |
データの各形式は、ストリングで識別されます。hasFormat() メソッドを使用して、オブジェクトにその形式のデータがあるかどうかを調べます。dataForFormat() メソッドを使用して、指定した形式のデータを取得します。
データを直接追加するには addData() メソッドを、間接的に追加するには addHandler() メソッドを使用します。addHandler() メソッドは、データが要求された場合に呼び出されるコールバックを登録します。これは、大規模な計算や変換が必要な、ネイティブでない形式のデータを追加する場合に有効です。たとえば、未処理のサウンドデータがある場合には、MP3 形式ハンドラを追加できます。MP3 変換は、MP3 データが要求された場合にのみ実行されます。
| プロパティ | 定義 | ||
|---|---|---|---|
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
| Object | |
| formats : Array
[read-only]
ドラッグデータの形式が、ストリングの配列として含まれます。
| DragSource | ||
| prototype : Object
[static]
クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
| Object | |
| メソッド | 定義 | ||
|---|---|---|---|
|
コンストラクタです。
| DragSource | ||
|
データ、および対応する形式のストリングをドラッグソースに追加します。
| DragSource | ||
|
指定した形式のデータが要求されたときに呼び出されるハンドラを追加します。
| DragSource | ||
|
指定された形式のデータを取得します。
| DragSource | ||
|
要求された形式がデータソースに含まれる場合は
true を返し、それ以外の場合は false を返します。 | DragSource | ||
|
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
| Object | |
|
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
| Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。
| Object | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。
| Object | |
|
指定されたオブジェクトのストリング表現を返します。
| Object | |
|
指定されたオブジェクトのプリミティブな値を返します。
| Object | |
| formats | プロパティ |
継承されるパブリックプロパティの非表示
継承されるパブリックプロパティの表示formats:Array [read-only]
ドラッグデータの形式が、ストリングの配列として含まれます。このプロパティは、addData() または addHandler() メソッドを使用して設定します。デフォルト値は DragSource オブジェクトに追加されるデータに依存します。
public function get formats():Array
| DragSource | () | コンストラクタ |
public 関数 DragSource()コンストラクタです。
| addData | () | メソッド |
public function addData(data:Object, format:String):voidデータ、および対応する形式のストリングをドラッグソースに追加します。このメソッドは値を返しません。
パラメータdata:Object — ドラッグデータを指定するオブジェクトです。String、DataProvider など、任意のオブジェクトを使用できます。
|
|
format:String — このデータの形式を記述するラベルを指定するストリングです。
|
| addHandler | () | メソッド |
public function addHandler(handler:Function, format:String):void指定した形式のデータが要求されたときに呼び出されるハンドラを追加します。これは、大量のデータがドラッグされる場合に有効です。このハンドラは、データが要求された場合にのみ呼び出されます。このメソッドは値を返しません。
パラメータhandler:Function — データを要求するために呼び出されるハンドラを指定する関数です。この関数では、指定された形式のデータが返される必要があります。
|
|
format:String — このデータの形式を指定するストリングです。
|
| dataForFormat | () | メソッド |
public function dataForFormat(format:String):Object
指定された形式のデータを取得します。データが addData() メソッドによって追加された場合は、データが直接返されます。データが addHandler() メソッドによって追加された場合は、データを返すためにハンドラ関数が呼び出されます。
format:String — 返すデータの形式を記述するラベルを指定するストリングです。
|
Object —
要求された形式のデータを含むオブジェクトです。複数のアイテムをドラッグすると、戻り値は配列になります。リストコントロールの場合は、含まれるのが 1 つのアイテムのみであっても、戻り値は常に配列になります。
|
| hasFormat | () | メソッド |
public function hasFormat(format:String):Boolean
要求された形式がデータソースに含まれる場合は true を返し、それ以外の場合は false を返します。
format:String — データの形式を記述するラベルを指定するストリングです。
|
Boolean —
要求された形式がデータソースに含まれる場合は true を返します。
|