DataDictionaryElement

Package	com.adobe.dct.transfer
Class	public class DataDictionaryElement
Inheritance	DataDictionaryElement Object
Implements	IEventDispatcher

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 DataDictionaryElement within a DataDictionary.

Public Properties

	Property		Defined By
		binding : BindingElement	DataDictionaryElement
		childElements : IList The list of DataDictionaryElements within a DataDictionaryElement - for CompositeType only.	DataDictionaryElement
		collectionElement : DataDictionaryElement The collectionElement within a DataDictionaryElement - for CollectionType only.	DataDictionaryElement
		compositeType : String The name of "composite type" for a COMPOSITE data dictionary element.	DataDictionaryElement
		computed : Boolean true if the data dictionary element is a computed element.	DataDictionaryElement
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		description : String The description of the DataDictionaryElement.	DataDictionaryElement
		displayName : String The UI Specific DisplayName of the DataDictionaryElement.	DataDictionaryElement
		elementSubType : String The SubType of DataDictionaryElement: Enum.	DataDictionaryElement
		elementType : String The type of DataDictionaryElement, such as: STRING, NUMBER, COMPOSITE, COLLECTION or DATE	DataDictionaryElement
		expression : String The expression for the DataDictionaryElement.	DataDictionaryElement
		extendedProperties : Object The extendedProperties of a DataDictionaryElement.	DataDictionaryElement
		id : String The unique id of the DataDictionaryElement.	DataDictionaryElement
		keyElement : Boolean true if the data dictionary element is a key element.	DataDictionaryElement
		lcdsDestination : String The lcdsDestination associated with a DDE (Entity in FML).	DataDictionaryElement
		name : String The name of the DataDictionaryElement.	DataDictionaryElement
		path : String The absolute path of a DDElement in dotted notation.	DataDictionaryElement
		referenceName : String Specifies the unique name of the data dictionary element that is used to refer it.	DataDictionaryElement
		required : Boolean If the required DDEs are not filled inside a DDI , the DDI is invalid	DataDictionaryElement
		valueSet : IList The Allowed values for a DataDictionaryElement.	DataDictionaryElement
		XMLBinding : BindingElement The Binding for a DataDictionaryElement.	DataDictionaryElement

Public Methods

	Method		Defined 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.	DataDictionaryElement
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	DataDictionaryElement
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	DataDictionaryElement
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		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.	DataDictionaryElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		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.	DataDictionaryElement

Property Detail

binding

property

binding:BindingElement

Implementation
public function get binding():BindingElement
public function set binding(value:BindingElement):void

childElements

property

childElements: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 DataDictionaryElements within a DataDictionaryElement - for CompositeType only.

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

collectionElement

property

collectionElement:DataDictionaryElement

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The collectionElement within a DataDictionaryElement - for CollectionType only.

Implementation
public function get collectionElement():DataDictionaryElement
public function set collectionElement(value:DataDictionaryElement):void

compositeType

property

compositeType: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 "composite type" for a COMPOSITE data dictionary element.

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

computed

property

computed:Boolean

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

true if the data dictionary element is a computed element.

Implementation
public function get computed():Boolean
public function set computed(value:Boolean):void

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 DataDictionaryElement.

Implementation
public function get description():String
public function set description(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 UI Specific DisplayName of the DataDictionaryElement.

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

elementSubType

property

elementSubType:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The SubType of DataDictionaryElement: Enum.

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

elementType

property

elementType:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The type of DataDictionaryElement, such as: STRING, NUMBER, COMPOSITE, COLLECTION or DATE

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

expression

property

expression:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The expression for the DataDictionaryElement.

Implementation
public function get expression():String
public function set expression(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 extendedProperties of a DataDictionaryElement.

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 of the DataDictionaryElement.

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

keyElement

property

keyElement:Boolean

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

true if the data dictionary element is a key element.

Implementation
public function get keyElement():Boolean
public function set keyElement(value:Boolean):void

lcdsDestination

property

lcdsDestination:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The lcdsDestination associated with a DDE (Entity in FML).

Implementation
public function get lcdsDestination():String
public function set lcdsDestination(value:String):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 DataDictionaryElement.

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

path

property

path:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The absolute path of a DDElement in dotted notation.

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

referenceName

property

referenceName:String

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Specifies the unique name of the data dictionary element that is used to refer it.

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

required

property

required:Boolean

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

If the required DDEs are not filled inside a DDI , the DDI is invalid

Implementation
public function get required():Boolean
public function set required(value:Boolean):void

valueSet

property

valueSet:IList

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The Allowed values for a DataDictionaryElement.

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

XMLBinding

property

XMLBinding:BindingElement

Language Version:

ActionScript 3.0

Product Version:

Data Dictionary Building Block 9.5

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The Binding for a DataDictionaryElement.

Implementation
public function get XMLBinding():BindingElement
public function set XMLBinding(value:BindingElement):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.

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.

Legal Notices | Online Privacy Policy

DataDictionaryElement - AS3 Data Dictionary

Classes x

binding

childElements

collectionElement

compositeType

computed

description

displayName

elementSubType

elementType

expression

extendedProperties

id

keyElement

lcdsDestination

name

path

referenceName

required

valueSet

XMLBinding

addEventListener

dispatchEvent

hasEventListener

removeEventListener

willTrigger