パッケージmx.core
クラスpublic class DragSource
継承DragSource Inheritance Object

DragSource クラスには、ドラッグされるデータが格納されます。ドラッグを開始したコントロールのタイプに応じて、データを複数の形式にすることができます。

データの各形式は、ストリングで識別されます。hasFormat() メソッドを使用して、オブジェクトにその形式のデータがあるかどうかを調べます。dataForFormat() メソッドを使用して、指定した形式のデータを取得します。

データを直接追加するには addData() メソッドを、間接的に追加するには addHandler() メソッドを使用します。addHandler() メソッドは、データが要求された場合に呼び出されるコールバックを登録します。これは、大規模な計算や変換が必要な、ネイティブでない形式のデータを追加する場合に有効です。例えば、未処理のサウンドデータがある場合には、MP3 形式ハンドラを追加できます。MP3 変換は、MP3 データが要求された場合にのみ実行されます。


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  formats : Array
[読み取り専用] ドラッグデータの形式が、ストリングの配列として含まれます。
DragSource
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
パブリックメソッド
 メソッド定義元
  
DragSource()
コンストラクタです。
DragSource
  
addData(data:Object, format:String):void
データ、および対応する形式のストリングをドラッグソースに追加します。
DragSource
  
addHandler(handler:Function, format:String):void
指定した形式のデータが要求されたときに呼び出されるハンドラを追加します。
DragSource
  
dataForFormat(format:String):Object
指定された形式のデータを取得します。
DragSource
  
hasFormat(format:String):Boolean
要求された形式がデータソースに含まれる場合は true を返し、それ以外の場合は false を返します。
DragSource
 Inherited
hasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
toString():String
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
valueOf():Object
指定されたオブジェクトのプリミティブな値を返します。
Object
プロパティの詳細
formatsプロパティ
formats:Array  [読み取り専用]

ドラッグデータの形式が、ストリングの配列として含まれます。このプロパティは、addData() または addHandler() メソッドを使用して設定します。デフォルト値は DragSource オブジェクトに追加されるデータに依存します。



実装
    public function get formats():Array
コンストラクタの詳細
DragSource()コンストラクタ
public function 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 — 返すデータの形式を記述するラベルを指定するストリングです。addData() メソッドでカスタムドロップターゲットを作成する場合は、このストリングをカスタム値にすることができます。

リストベースコントロールには、format パラメータの定義済みの値があります。ドラッグ操作を開始したコントロールがツリーの場合、形式は "treeItems" であり、アイテムは ITreeDataProvider インターフェイスを実装します。ビルトインドラッグ & ドロップがサポートされている他のすべてのリストベースコントロールでは、形式は "items" であり、アイテムは IDataProvider インターフェイスを実装します。

戻り値
Object — 要求された形式のデータを含むオブジェクトです。複数のアイテムをドラッグすると、戻り値は配列になります。リストベースコントロールの場合は、含まれるのが 1 つのアイテムのみであっても、戻り値は常に配列になります。
hasFormat()メソッド 
public function hasFormat(format:String):Boolean

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

パラメータ

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

戻り値
Boolean — 要求された形式がデータソースに含まれる場合は true を返します。



© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 08:51 PM -07:00
 

 

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

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/core/DragSource.html