ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.dct.transfer 

DataDictionary  - AS3 Data Dictionary
Packagecom.adobe.dct.transfer
Classpublic class DataDictionary
InheritanceDataDictionary Inheritance Object
Implements IManaged

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

Transfer object representing a DataDictionary.


Public Properties
 PropertyDefined By
  checksum : String
The checksum of the data dictionary.
DataDictionary
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  crxVersion : String
The crx version of the data dictionary.
DataDictionary
  DDElements : IList
The list of data dictionary elements within the data dictionary.
DataDictionary
  description : String
The description of the data dictionary.
DataDictionary
  dictionaryType : String
The dictionary type for the data dictionary.
DataDictionary
  displayName : String
The display name of the data dictionary.
DataDictionary
  extendedProperties : Object
The extended properties of the data dictionary.
DataDictionary
  id : String
The unique id for the data dictionary.
DataDictionary
  lastChangeBy : String
The user who last updated the data dictionary.
DataDictionary
  lastPublishDate : Date
The last published date/time the data dictionary.
DataDictionary
  lastUpdateDate : Date
The last updated date/time the data dictionary.
DataDictionary
  name : String
The name of the data dictionary.
DataDictionary
  remotingServiceInfo : RemotingServiceInfo
The LCDS Remoting Service info for the data dictionary
DataDictionary
  state : int
The state of the data dictionary.
DataDictionary
  version : String
The version of the data dictionary.
DataDictionary
Public Methods
 MethodDefined By
  
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.
DataDictionary
  
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
DataDictionary
  
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DataDictionary
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DataDictionary
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
  
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.
DataDictionary
Public Constants
 ConstantDefined By
  MODIFIED : uint = 3
[static] The DataDictionary.MODIFIED constant defines the value of the state property of the data dictionary object for modified state.
DataDictionary
  PUBLISHED : uint = 5
[static] The DataDictionary.PUBLISHED constant defines the value of the state property of the data dictionary object for published state.
DataDictionary
  READYFORPUBLISH : uint = 4
[static] The DataDictionary.READYFORPUBLISH constant defines the value of the state property of the data dictionary object for readyforpublish state.
DataDictionary
Property Detail

checksum

property
checksum:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The checksum of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get checksum():String
    public function set checksum(value:String):void

crxVersion

property 
crxVersion:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The crx version of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get crxVersion():String
    public function set crxVersion(value:String):void

DDElements

property 
DDElements:IList

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The list of data dictionary elements within the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get DDElements():IList
    public function set DDElements(value:IList):void

Related API Elements

DataDictionaryElement

description

property 
description:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The description of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get description():String
    public function set description(value:String):void

dictionaryType

property 
dictionaryType:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The dictionary type for the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get dictionaryType():String
    public function set dictionaryType(value:String):void

displayName

property 
displayName:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The display name of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get displayName():String
    public function set displayName(value:String):void

extendedProperties

property 
extendedProperties:Object

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The extended properties of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get extendedProperties():Object
    public function set extendedProperties(value:Object):void

id

property 
id:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The unique id for the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get id():String
    public function set id(value:String):void

lastChangeBy

property 
lastChangeBy:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The user who last updated the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get lastChangeBy():String
    public function set lastChangeBy(value:String):void

lastPublishDate

property 
lastPublishDate:Date

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The last published date/time the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get lastPublishDate():Date
    public function set lastPublishDate(value:Date):void

lastUpdateDate

property 
lastUpdateDate:Date

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The last updated date/time the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get lastUpdateDate():Date
    public function set lastUpdateDate(value:Date):void

name

property 
name:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The name of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get name():String
    public function set name(value:String):void

remotingServiceInfo

property 
remotingServiceInfo:RemotingServiceInfo

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The LCDS Remoting Service info for the data dictionary

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get remotingServiceInfo():RemotingServiceInfo
    public function set remotingServiceInfo(value:RemotingServiceInfo):void

state

property 
state:int

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The state of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get state():int
    public function set state(value:int):void

version

property 
version:String

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 10.2

The version of the data dictionary.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get version():String
    public function set version(value:String):void
Method Detail

addEventListener

()method
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).

Parameters

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

()method 
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.

Parameters

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

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

hasEventListener

()method 
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.

Parameters

type:String — The type of event.

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

removeEventListener

()method 
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.

Parameters

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

()method 
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.

Parameters

type:String — The type of event.

Returns
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
Constant Detail

MODIFIED

Constant
public static const MODIFIED:uint = 3

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The DataDictionary.MODIFIED constant defines the value of the state property of the data dictionary object for modified state.

PUBLISHED

Constant 
public static const PUBLISHED:uint = 5

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The DataDictionary.PUBLISHED constant defines the value of the state property of the data dictionary object for published state.

READYFORPUBLISH

Constant 
public static const READYFORPUBLISH:uint = 4

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The DataDictionary.READYFORPUBLISH constant defines the value of the state property of the data dictionary object for readyforpublish state.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy