DragSource

包	mx.core
类	public class DragSource
继承	DragSource Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

DragSource 类中包含正被拖动的数据。数据可以采用多种格式，具体取决于启动拖动的控件的类型。

每种数据格式都使用一个字符串进行标识。hasFormat() 方法用于确定对象是否包含使用相应格式的数据。dataForFormat() 方法用于检索指定格式的数据。

可以使用 addData() 方法直接添加数据，也可以使用 addHandler() 方法间接添加数据。addHandler() 方法会注册一个回调，请求该数据时将调用此回调。添加非本机格式的数据可能需要进行大量计算或转换，此时该方法就非常有用。例如，如果您具有原始声音数据，则可以添加 MP3 格式处理程序。仅当请求 MP3 数据时才执行 MP3 转换。

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		formats : Array [只读] 包含拖动数据的格式，以字符串 Array 的形式表示。	DragSource

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		DragSource() 构造函数。	DragSource
		addData(data:Object, format:String):void 向拖动源添加数据和相应的格式 String。	DragSource
		addHandler(handler:Function, format:String):void 添加一个处理函数，当请求指定格式的数据时将调用此处理函数。	DragSource
		dataForFormat(format:String):Object 检索指定格式的数据。	DragSource
		hasFormat(format:String):Boolean 如果数据源中包含请求的格式，则返回 true；否则，返回 false。	DragSource
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

formats

属性

formats:Array [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

包含拖动数据的格式，以字符串 Array 的形式表示。使用 addData() 或 addHandler() 方法设置此属性。默认值取决于添加到 DragSource 对象的数据。

实现
public function get formats():Array

构造函数详细信息

()

构造函数

public function DragSource()

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

构造函数。

方法详细信息

addData

()

方法

public function addData(data:Object, format:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

向拖动源添加数据和相应的格式 String。此方法不返回值。

参数

	`data:Object` — 用于指定拖动数据的对象。这可以是任何对象，如，String、DataProvider，等等。

	`format:String` — 字符串，用于指定一个标签来描述此数据格式。

addHandler

()

方法

public function addHandler(handler:Function, format:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

添加一个处理函数，当请求指定格式的数据时将调用此处理函数。当拖动大量数据时，此函数非常有用。仅当请求数据时才调用该处理函数。此方法不返回值。

参数

	`handler:Function` — 一个函数，用于指定请求数据时需要调用的处理函数。此函数必须返回指定格式的数据。

	`format:String` — 用于指定此数据的格式的字符串。

dataForFormat

()

方法

public function dataForFormat(format:String):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

检索指定格式的数据。如果此数据是使用 addData() 方法添加的，则可以直接返回此数据。如果此数据是使用 addHandler() 方法添加的，则需调用处理程序函数来返回此数据。

参数

format:String — 字符串，用于指定一个标签来描述要返回的数据的格式。如果要用 addData() 方法创建自定义放置目标，则此字符串可以是自定义值。

基于 List 的控件对于 format 参数有预定义的值。如果启动拖动操作的控件是 Tree，则格式为 "treeItems"，且项目实现 ITreeDataProvider 接口。对于本身即支持拖放的所有其他基于 List 的控件，格式为 "items"，且项目实现 IDataProvider 接口。

Object — 包含所请求格式的数据的 Object。如果拖动多个项目，则返回值是一个 Array。对于基于 List 的控件，返回值始终为 Array，即使其中只包含一个项目也是如此。

hasFormat

()

方法

public function hasFormat(format:String):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果数据源中包含所请求的格式，则返回 true；否则，返回 false。

参数

format:String — 字符串，用于指定一个标签来描述此数据的格式。

Boolean — 如果数据源中包含所请求的格式，则返回 true。

法律声明 | 在线隐私策略

DragSource - AS3 Flex

类 x

formats

DragSource

addData

addHandler

dataForFormat

hasFormat