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

ContextData  - AS3 Asset Composer

com.adobe.icc.vo.render
public class ContextData
继承ContextData Inheritance Object
实现 IEventDispatcher

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

A value object that encapsulates runtime and instance data for correspondence. For example, a data dictionary instance, local variables, or session or user data. This data is used when processing content or modules.



公共属性
 属性由以下参数定义
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
  dataDictionaryInstance : DataDictionaryInstance
Instance of a Data Dictionary.
ContextData
  includeEmptyConditions : Boolean
True if nested empty conditions (nested conditional modules that produce no output) should be included in the resolved content list.
ContextData
  includeEmptyLists : Boolean
True if nested empty lists (nested list modules that produce no output) should be included in the resolved content list.
ContextData
  localVariables : Object
Map of variable name (String) to variable value (String).
ContextData
  textContentOverride : String
Content to use for module resolution instead of module's persisted content.
ContextData
  textContentOverrideMimeType : String
MIME type for the text content override.
ContextData
  useXhtmlTextContent : Boolean
True if XHTML content should be used when resolving text modules; false if Flex Rich Text should be used.
ContextData
  variableOverrides : ArrayCollection
Collection of Variable objects to use for module resolution instead of the module's persisted set of variables.
ContextData
  variableSubstitutionRules : Object
Maps a variable name to a &-delimited string of variable substution options and associated values that provide instructions specific to the substitution of the variable within the content.
ContextData
公共方法
 方法由以下参数定义
  
Constructor
ContextData
  
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.
ContextData
  
applySubtitutionRule(varName:String, rule:String, value:String = "1"):void
Convenience method to apply the specified rule to the specified variable in the variableSubstitutionRules property.
ContextData
  
Dispatches an event into the event flow.
ContextData
  
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ContextData
 Inherited
表示对象是否已经定义了指定的属性。
Object
 Inherited
表示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
 Inherited
表示指定的属性是否存在、是否可枚举。
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
ContextData
 Inherited
设置循环操作动态属性的可用性。
Object
 Inherited
返回此对象的字符串表示形式,其格式设置遵守区域设置特定的约定。
Object
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
返回指定对象的原始值。
Object
  
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ContextData
公共常量
 常量由以下参数定义
  RULE_FORCE_PLACEHOLDER : String = "forcePlaceholder"
[静态] Substitution rule for forcing a variable's type to placeholder.
ContextData
  RULE_KEEP_TOKEN : String = "keepToken"
[静态] Substitution rule for retaining the token of a variable with an empty value.
ContextData
属性详细信息

dataDictionaryInstance

属性
dataDictionaryInstance:DataDictionaryInstance

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

Instance of a Data Dictionary.

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



实现
    public function get dataDictionaryInstance():DataDictionaryInstance
    public function set dataDictionaryInstance(value:DataDictionaryInstance):void

includeEmptyConditions

属性 
includeEmptyConditions:Boolean

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

True if nested empty conditions (nested conditional modules that produce no output) should be included in the resolved content list. This is essential when the client is trying to determine the full extent of the content that resulted when a condition was evaluated -- if the condition was nested and had no output, there would be no output for the outer condition but the client still needs to know that the nested condition was actually output from the outer condition.

Note: When this flag is true and an empty nested condition is encountered while resolving a list/condition, a ResolvedContent object with its empty property set to true will be included in the resolved content list. This ResolvedContent object's lineage will have the the empty nested condition as its youngest parent (meaning that the ResolvedContent object represents an "empty module content placeholder" within the empty nested condition).

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



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

相关 API 元素

includeEmptyLists

属性 
includeEmptyLists:Boolean

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

True if nested empty lists (nested list modules that produce no output) should be included in the resolved content list. This is essential when the caller is trying to determine the full extend of the content that resulted when a list was resolved. If a list contained an empty list and this flag is false, the nested empty list produces no resolved content. Otherwise (this flag is true) the nested empty list will produce a piece of empty content in the content set returned from the module resolver. Empty lists may also result from conditions. If this flag is true, empty nested lists will be included in condition results, if applicable.

Note: When this flag is true and an empty nested list is encountered while resolving a list/condition, a ResolvedContent object with its empty property set to true will be included in the resolved content list. This ResolvedContent object's lineage will have the the empty nested list as its youngest parent (meaning that the ResolvedContent object represents an "empty module content placeholder" within the empty nested list).

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



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

相关 API 元素

localVariables

属性 
localVariables:Object

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

Map of variable name (String) to variable value (String).

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



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

textContentOverride

属性 
textContentOverride:String

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

Content to use for module resolution instead of module's persisted content. This is typically set when the module's content has been edited on the client yet contains variable tokens that need to be resolved. The content specified is expected to be compatible with the textContentOverrideMimeType property. If this property is null, the module's original content is used. If empty, it is assumed that the module's content was edited and is now empty (which means the response will be empty content).

Note: This applies to any module type whose content can be edited as text by the user during letter filling.

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



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

textContentOverrideMimeType

属性 
textContentOverrideMimeType:String

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

MIME type for the text content override. One of MimeType.TYPE constant values.

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



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

useXhtmlTextContent

属性 
useXhtmlTextContent:Boolean

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

True if XHTML content should be used when resolving text modules; false if Flex Rich Text should be used. Defaults to true.

Note: If textContentOverride is specified, the textContentOverrideMimeType type will override this property.

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



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

variableOverrides

属性 
variableOverrides:ArrayCollection

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

Collection of Variable objects to use for module resolution instead of the module's persisted set of variables. This is typically set when the module's content has been edited on the client and variables have been added/removed. If this property is null, the module's original persisted set of variables is used. If empty, it is assumed that the module's content was edited and no longer contains any variables to resolve.

Note: This applies to any module type whose content can be edited as text by the user during letter filling.

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



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

variableSubstitutionRules

属性 
variableSubstitutionRules:Object

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

Maps a variable name to a &-delimited string of variable substution options and associated values that provide instructions specific to the substitution of the variable within the content. Supported options and values are as follows:

  • keepToken: 0 (default; replace token whether the variable's value is empty or not), 1 (leave token if variable's value is empty).
  • forcePlaceholder: 0 (default; DDE variables are treated normally and the data dictionary instance is used to retrieve their values), 1 (DDE variables are treated as normal placeholders: a value will be sought in the localVariables property instead of using the data dictionary).

The absense from this map of the name of a variable found in the localVariables property indicates that defaults should be used.

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



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

ContextData

()构造函数
public function ContextData()

语言版本: 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.

applySubtitutionRule

()方法 
public function applySubtitutionRule(varName:String, rule:String, value:String = "1"):void

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

Convenience method to apply the specified rule to the specified variable in the variableSubstitutionRules property. If the rule always exists, its value is updated.

参数

varName:String — Name of the variable to which the rule applies.
 
rule:String — Name of the rule (one of RULE constants) to apply.
 
value:String (default = "1") — Value to give to the rule. Defaults to 1 to activate the rule.


引发
Error — Invalid rule.

相关 API 元素

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.

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.
常量详细信息

RULE_FORCE_PLACEHOLDER

常量
public static const RULE_FORCE_PLACEHOLDER:String = "forcePlaceholder"

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

Substitution rule for forcing a variable's type to placeholder. Values: 0 (default), 1.

RULE_KEEP_TOKEN

常量 
public static const RULE_KEEP_TOKEN:String = "keepToken"

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

Substitution rule for retaining the token of a variable with an empty value. Values: 0 (default), 1.





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

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