ASDoc

mx.core
DragSource クラス

DragSource クラス

DragSource クラスはドラッグデータを格納し、そのデータ形式を指定します。

メソッド
	`addData( data:Object, format:String) : Void`データ、および対応する形式のストリングをドラッグソースに追加します。
	`addHandler( obj:Object, handler:Function, format:String) : Void`指定した形式のデータが要求されたときに呼び出されるハンドラを追加します。
	`dataForFormat( format:String) : Object`指定した形式のデータを取得します。
	`hasFormat( format:String) : Boolean`要求された形式がデータソースに含まれる場合は true を返し、それ以外の場合は false を返します。

プロパティ
	`formats:var [読み取り専用]`ドラッグデータの形式が含まれます。

メソッドの詳細

addData

addData( data:Object, format:String)
										
													 :  Void

データ、および対応する形式のストリングをドラッグソースに追加します。このメソッドは値を返しません。

パラメータ
data:Object - ドラッグデータを指定するオブジェクトです。String、DataProvider など、任意のオブジェクトを使用できます。このパラメータは必須です。
format:String - このデータの形式を記述するラベルを指定するストリングです。このパラメータは必須です。

addHandler

addHandler( obj:Object, handler:Function, format:String)
										
													 :  Void

指定した形式のデータが要求されたときに呼び出されるハンドラを追加します。これは、大量のデータをドラッグするときに便利です。ハンドラは、データが要求された場合にのみ呼び出されます。このメソッドは値を返しません。

パラメータ
    obj:Object - ハンドラを含むオブジェクトです。このパラメータは必須です。
    handler:Function - データを要求するために呼び出されるハンドラを指定する関数です。この関数は、指定された形式でデータを返します。このパラメータは必須です。
    format:String - このデータの形式を指定するストリングです。

dataForFormat

dataForFormat( format:String)
										
													 :  Object

指定した形式のデータを取得します。データが addData メソッドによって追加された場合は、データが直接返されます。データが addHandler メソッドによって追加された場合は、データを返すためにハンドラ関数が呼び出されます。このメソッドは、データを含むオブジェクトの配列を、要求された形式で返します。単一のアイテムをドラッグした場合は、この配列は 1 アイテムの長さになります。

パラメータ
format:String - 返すデータの形式を記述するラベルを指定するストリングです。このパラメータは必須です。

hasFormat

hasFormat( format:String)
										
													 :  Boolean

要求された形式がデータソースに含まれる場合は true を返し、それ以外の場合は false を返します。

パラメータ
format:String - このデータの形式を記述するラベルを指定するストリングです。

プロパティの詳細

formats