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

VariableAssignment  - AS3 Asset Composer

com.adobe.icc.vo
public class VariableAssignment
继承VariableAssignment Inheritance Object
实现 IManaged

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

A value object for an assignment of a variable in a letter template.



公共属性
 属性由以下参数定义
  caption : String
Specifies the caption text for the assignment.
VariableAssignment
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  dataModule : DataModule
VariableAssignment
  description : String
Specifies the description text for the assignment.
VariableAssignment
  editable : Boolean
Specifies whether the assignment can be edited when correspondence is being generated.
VariableAssignment
  id : String
Specifies the unique identifier for the assignment.
VariableAssignment
  optional : Boolean
Specifies whether the assignment is optional when correspondence is being generated.
VariableAssignment
  source : String
One of SOURCE const value.
VariableAssignment
  sourceContainerLayoutAssignment : String
If the source is field in a container layout, reference of corresponding container layout assignment object will be kept here.
VariableAssignment
  sourceReference : String
Identification of the referenced value.
VariableAssignment
  toolTip : String
Specifies the tooltip text for this assignment.
VariableAssignment
  variable : Variable
Specifies the variable associated with this assignment.
VariableAssignment
公共方法
 方法由以下参数定义
  
Constructor
VariableAssignment
  
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.
VariableAssignment
  
Dispatches an event into the event flow.
VariableAssignment
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
VariableAssignment
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
VariableAssignment
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
  
Specifies the string representation of this object.
VariableAssignment
 Inherited
返回指定对象的原始值。
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
VariableAssignment
公共常量
 常量由以下参数定义
  SOURCE_CALCULATION : String = "CALCULATION"
[静态] Not used.
VariableAssignment
  SOURCE_CONST : String = "CONST"
[静态] Specifies the source type when the source is a string value specified by the user.
VariableAssignment
  SOURCE_DATAMODULE : String = "DATAMODULE"
[静态] Specifies the source type when the source is a module.
VariableAssignment
  SOURCE_DDE : String = "DDE"
[静态] Specifies the source type when the source is a data dictionary element.
VariableAssignment
  SOURCE_FIELD : String = "FIELD"
[静态] Specifies the source type when the source is a field.
VariableAssignment
  SOURCE_SYSTEM : String = "SYSTEM"
[静态] Not used.
VariableAssignment
  SOURCE_USER : String = "USER"
[静态] Specifies the source type when the source is a string value specified by the user.
VariableAssignment
  SOURCE_VARIABLE : String = "VARIABLE"
[静态] Specifies the source type when the source is a variable.
VariableAssignment
属性详细信息

caption

属性
caption:String

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

Specifies the caption text for the assignment.

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



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

dataModule

属性 
dataModule:DataModule



实现
    public function get dataModule():DataModule
    public function set dataModule(value:DataModule):void

description

属性 
description:String

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

Specifies the description text for the assignment.

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



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

editable

属性 
editable:Boolean

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

Specifies whether the assignment can be edited when correspondence is being generated.

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



实现
    public function get editable():Boolean
    public function set editable(value:Boolean):void

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 the assignment.

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



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

optional

属性 
optional:Boolean

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

Specifies whether the assignment is optional when correspondence is being generated.

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



实现
    public function get optional():Boolean
    public function set optional(value:Boolean):void

source

属性 
source:String

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

One of SOURCE const value.

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



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

sourceContainerLayoutAssignment

属性 
sourceContainerLayoutAssignment:String

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

If the source is field in a container layout, reference of corresponding container layout assignment object will be kept here.

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



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

sourceReference

属性 
sourceReference:String

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

Identification of the referenced value. What is stored here depends on the source:

  • USER: A string value specified by the user which can be overridden during letter filling. This value is used literally.
  • CONST: A string value specified by the user. This value is used literally.
  • DDE: The DDE reference syntax, e.g. movie.title for a DD that has 'movie' as its root which contains a 'title' element. The letter, which stores this assignment holds the DD Instance reference to use in order to resolve the DDE reference specified here.
  • DATAMODULE: The GUID of the referenced module whose content is to be used as the value of the assigned variable.
  • VARIABLE: The name of the referenced variable. The assigned variable's value, at letter filling time, will reflect the referenced variable's value.
  • FIELD: The GUID of the referenced field. The assigned variable's value, at letter filling time, will reflect the referenced field's value.
  • SYSTEM: Not used at this time.
  • CALCULATION: Not used at this time.

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



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

toolTip

属性 
toolTip:String

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

Specifies the tooltip text for this assignment.

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



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

variable

属性 
variable:Variable

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

Specifies the variable associated with this assignment.

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



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

VariableAssignment

()构造函数
public function VariableAssignment()

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

Constructor

方法详细信息

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

Specifies the string representation of this object.

返回
String — The 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.
常量详细信息

SOURCE_CALCULATION

常量
public static const SOURCE_CALCULATION:String = "CALCULATION"

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

Not used.

SOURCE_CONST

常量 
public static const SOURCE_CONST:String = "CONST"

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

Specifies the source type when the source is a string value specified by the user.

SOURCE_DATAMODULE

常量 
public static const SOURCE_DATAMODULE:String = "DATAMODULE"

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

Specifies the source type when the source is a module. The content of the module is used as the value of the assigned variable.

SOURCE_DDE

常量 
public static const SOURCE_DDE:String = "DDE"

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

Specifies the source type when the source is a data dictionary element.

SOURCE_FIELD

常量 
public static const SOURCE_FIELD:String = "FIELD"

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

Specifies the source type when the source is a field.

SOURCE_SYSTEM

常量 
public static const SOURCE_SYSTEM:String = "SYSTEM"

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

Not used.

SOURCE_USER

常量 
public static const SOURCE_USER:String = "USER"

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

Specifies the source type when the source is a string value specified by the user. This value can be overridden when a letter is being filled.

SOURCE_VARIABLE

常量 
public static const SOURCE_VARIABLE:String = "VARIABLE"

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

Specifies the source type when the source is a variable.





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

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