用于 Adobe® Flash® Platform 的 ActionScript® 3.0 参考
主页  |  隐藏包列表和类列表 |   |   |  新增内容  |  索引  |  附录  |  为什么显示为英语?
过滤条件: 正在从服务器检索数据...
正在从服务器检索数据...
com.adobe.icc.vo 

DataModule  - AS3 Asset Composer

com.adobe.icc.vo
public class DataModule
继承DataModule Inheritance Object
实现 IManaged
子类 ConditionalDataModule, ImageModule, ListDataModule, TBX

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Value object for a data module. It specifies the common attributes such as the identifier, name, description, associated data dictionary references, and list of variables. The specific module types include Text, Image, List, and Condition.



公共属性
 属性由以下参数定义
  activeEndDate : Date
DataModule
  activeStartDate : Date
DataModule
  comment : String
Specifies a comment associated with the last change or update to the data module.
DataModule
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  crxVersion : String
Version of the data module in repository
DataModule
  dataDictionaryRef : String
Data Dictionary Reference
DataModule
  dataDictionaryRefs : ArrayCollection
DataModule
  desc : String
Gets the description for this data module.
DataModule
  dmType : int
[只读] Fetch the type of data module 0 : Text 2 : Image 3 : Condition 4 : List
DataModule
  extendedProperties : Object
extendedProperties Map for AssetManager Backend use case
DataModule
  hasVariables : Boolean
[只读] True if the module has variables in its content.
DataModule
  id : String
Specifies the unique identifier for this data module.
DataModule
  lastChangeBy : String
Specifies the last user who completed a change.
DataModule
  lastPublishDate : Date
Specifies the last publish date of the data module
DataModule
  lastUpdateDate : Date
DataModule
  lcat : Category
Specifies the subcategory for the data module.
DataModule
  lcatName : String
[只读] Speifies the sub category associated with this data Module.
DataModule
  name : String
Specifies the name of the data module.
DataModule
  state : int
Specifies the state of the data module
DataModule
  ucat : Category
Specifies the main category for the data module.
DataModule
  ucatName : String
[只读] Speifies the main category associated with this data Module.
DataModule
  updatedBy : String
Specifies the constant string indicating the data module was updated by UPDATED_BY_NONE The asset has not been updated after publishing. UPDATED_BY_USER The asset has been updated by only user. UPDATED_BY_SYSTEM The asset has been updated by only system. UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.
DataModule
  variableList : ArrayCollection
List of Variable objects for each variable used by this module.
DataModule
  version : int
DataModule
公共方法
 方法由以下参数定义
  
Constructor Do not create an instance of DataModule directly, use derived classes like ImageModule.
DataModule
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
DataModule
  
Dispatches an event into the event flow.
DataModule
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DataModule
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DataModule
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
  
Fetch String representation of this object.
DataModule
 Inherited
返回指定对象的原始值。
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
DataModule
公共常量
 常量由以下参数定义
  BINDEVENT_DESC_CHANGE : String = "bindDescChange"
[静态] Binding event dispatched when the desc property changes.
DataModule
  BINDEVENT_ID_CHANGE : String = "bindIdChange"
[静态] Binding event dispatched when the id property changes.
DataModule
  BINDEVENT_NAME_CHANGE : String = "bindNameChange"
[静态] Binding event dispatched when the name property changes.
DataModule
属性详细信息

activeEndDate

属性
activeEndDate:Date



实现
    public function get activeEndDate():Date
    public function set activeEndDate(value:Date):void

activeStartDate

属性 
activeStartDate:Date



实现
    public function get activeStartDate():Date
    public function set activeStartDate(value:Date):void

comment

属性 
comment:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies a comment associated with the last change or update to the data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get comment():String
    public function set comment(value:String):void

crxVersion

属性 
crxVersion:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 10
运行时版本: AIR (unsupported), Flash Player 10.2

Version of the data module in repository

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get crxVersion():String
    public function set crxVersion(value:String):void

dataDictionaryRef

属性 
dataDictionaryRef:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Data Dictionary Reference

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get dataDictionaryRef():String
    public function set dataDictionaryRef(value:String):void

dataDictionaryRefs

属性 
dataDictionaryRefs:ArrayCollection



实现
    public function get dataDictionaryRefs():ArrayCollection
    public function set dataDictionaryRefs(value:ArrayCollection):void

desc

属性 
desc:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Gets the description for this data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get desc():String
    public function set desc(value:String):void

dmType

属性 
dmType:int  [只读]

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Fetch the type of data module

  • 0 : Text
  • 2 : Image
  • 3 : Condition
  • 4 : List



实现
    public function get dmType():int

extendedProperties

属性 
extendedProperties:Object

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

extendedProperties Map for AssetManager Backend use case

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get extendedProperties():Object
    public function set extendedProperties(value:Object):void

hasVariables

属性 
hasVariables:Boolean  [只读]

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

True if the module has variables in its content.



实现
    public function get hasVariables():Boolean

id

属性 
id:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the unique identifier for this data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get id():String
    public function set id(value:String):void

lastChangeBy

属性 
lastChangeBy:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the last user who completed a change.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get lastChangeBy():String
    public function set lastChangeBy(value:String):void

lastPublishDate

属性 
lastPublishDate:Date

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 10
运行时版本: AIR (unsupported), Flash Player 10.2

Specifies the last publish date of the data module

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get lastPublishDate():Date
    public function set lastPublishDate(value:Date):void

lastUpdateDate

属性 
lastUpdateDate:Date



实现
    public function get lastUpdateDate():Date
    public function set lastUpdateDate(value:Date):void

lcat

属性 
lcat:Category

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the subcategory for the data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get lcat():Category
    public function set lcat(value:Category):void

lcatName

属性 
lcatName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Speifies the sub category associated with this data Module.



实现
    public function get lcatName():String

name

属性 
name:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the name of the data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get name():String
    public function set name(value:String):void

state

属性 
state:int

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the state of the data module

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get state():int
    public function set state(value:int):void

ucat

属性 
ucat:Category

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Specifies the main category for the data module.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get ucat():Category
    public function set ucat(value:Category):void

ucatName

属性 
ucatName:String  [只读]

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Speifies the main category associated with this data Module.



实现
    public function get ucatName():String

updatedBy

属性 
updatedBy:String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 10
运行时版本: AIR (unsupported), Flash Player 10.2

Specifies the constant string indicating the data module was updated by

  • UPDATED_BY_NONE The asset has not been updated after publishing.
  • UPDATED_BY_USER The asset has been updated by only user.
  • UPDATED_BY_SYSTEM The asset has been updated by only system.
  • UPDATED_BY_USER_AND_SYSTEM The asset has been updated by both user and system.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get updatedBy():String
    public function set updatedBy(value:String):void

variableList

属性 
variableList:ArrayCollection

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

List of Variable objects for each variable used by this module. May be null or empty if the module does not use variables.

此属性可用作数据绑定的源。修改此属性后,将调度 propertyChange 事件。



实现
    public function get variableList():ArrayCollection
    public function set variableList(value:ArrayCollection):void

version

属性 
version:int



实现
    public function get version():int
    public function set version(value:int):void
构造函数详细信息

DataModule

()构造函数
public function DataModule()

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor Do not create an instance of DataModule directly, use derived classes like ImageModule.

方法详细信息

addEventListener

()方法
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

参数

type:String — The type of event.
 
listener:Function — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows:

function(evt:Event):void

The function can have any name.
 
useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target and bubbling phases. If useCapture is set to true, the listener processes the event only during the capture phase and not in the target or bubbling phase. If useCapture is false, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call addEventListener() twice, once with useCapture set to true, then again with useCapture set to false.
 
priority:int (default = 0) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.
 
weakRef:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not.

Class-level member functions are not subject to garbage collection, so you can set useWeakReference to true for class-level member functions without subjecting them to garbage collection. If you set useWeakReference to true for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()方法 
public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

参数

event:Event — The event object dispatched into the event flow.

返回
Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

hasEventListener

()方法 
public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

参数

type:String — The type of event.

返回
Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeEventListener

()方法 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

参数

type:String — The type of event.
 
listener:Function — The listener object to remove.
 
useCapture:Boolean (default = false) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.

toString

()方法 
public function toString():String

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Fetch String representation of this object.

返回
String — String representation of this object.

willTrigger

()方法 
public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

参数

type:String — The type of event.

返回
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
常量详细信息

BINDEVENT_DESC_CHANGE

常量
public static const BINDEVENT_DESC_CHANGE:String = "bindDescChange"

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Binding event dispatched when the desc property changes.

BINDEVENT_ID_CHANGE

常量 
public static const BINDEVENT_ID_CHANGE:String = "bindIdChange"

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Binding event dispatched when the id property changes.

BINDEVENT_NAME_CHANGE

常量 
public static const BINDEVENT_NAME_CHANGE:String = "bindNameChange"

语言版本: ActionScript 3.0
产品版本: Asset Composer Building Block 9.5
运行时版本: AIR (unsupported), Flash Player 9, Flash Player 10

Binding event dispatched when the name property changes.





[ X ]为什么显示为英语?
《ActionScript 3.0 参考》中的内容以英语显示

《ActionScript 3.0 参考》中的部分内容未翻译成所有语言。当某个语言元素未翻译时,将显示为英语。例如,ga.controls.HelpBox 类未翻译成任何语言。因此在简体中文版的参考中,ga.controls.HelpBox 类显示为英语。