DynamicManagedItem

Package	mx.data
Class	public dynamic class DynamicManagedItem
Inheritance	DynamicManagedItem Proxy
Implements	IManaged

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Typed managed item that is dynamic should extend this class so that events are executed when dynamic properties are changed.

Public Methods

	Method		Defined By
		DynamicManagedItem() Constructor.	DynamicManagedItem
		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.	DynamicManagedItem
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	DynamicManagedItem
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	DynamicManagedItem
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	DynamicManagedItem
		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.	DynamicManagedItem

Protected Methods

	Method		Defined By
		callProperty(name:, ... parameters): [override] Overrides the behavior of an object property that can be called as a function.	DynamicManagedItem
		deleteProperty(name:*):Boolean [override] Overrides the request to delete a property.	DynamicManagedItem
		getProperty(name:): [override] Overrides any request for a property's value.	DynamicManagedItem
		hasProperty(name:*):Boolean [override] Overrides a request to check whether an object has a particular property by name.	DynamicManagedItem
		nextName(index:int):String [override] Allows enumeration of the proxied object's properties by index number to retrieve property names.	DynamicManagedItem
		nextNameIndex(index:int):int [override] Allows enumeration of the proxied object's properties by index number.	DynamicManagedItem
		nextValue(index:int):* [override] Allows enumeration of the proxied object's properties by index number to retrieve property values.	DynamicManagedItem
		setProperty(name:, value:):void [override] Overrides a call to change a property's value.	DynamicManagedItem

Constructor Detail

()

Constructor

public function DynamicManagedItem()

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

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.

callProperty

()

method

override flash_proxy function callProperty(name:*, ... parameters):*

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Overrides the behavior of an object property that can be called as a function. When a method of the object is invoked, this method is called. While some objects can be called as functions, some object properties can also be called as functions.

Parameters

	`name:*` — The name of the method being invoked.

	`... parameters` — An array specifying the arguments to the called method.

Returns

* — The return value of the called method.

deleteProperty

()

method

override flash_proxy function deleteProperty(name:*):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Overrides the request to delete a property. When a property is deleted with the delete operator, this method is called to perform the deletion.

Parameters

name:* — The name of the property to delete.

Returns

Boolean — If the property was deleted, true; otherwise false.

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.

getProperty

()

method

override flash_proxy function getProperty(name:*):*

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Overrides any request for a property's value. If the property can't be found, the method returns undefined. For more information on this behavior, see the ECMA-262 Language Specification, 3rd Edition, section 8.6.2.1.

Parameters

name:* — The name of the property to retrieve.

Returns

* — The specified property or undefined if the property is not found.

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.

hasProperty

()

method

override flash_proxy function hasProperty(name:*):Boolean

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Overrides a request to check whether an object has a particular property by name.

Parameters

name:* — The name of the property to check for.

Returns

Boolean — If the property exists, true; otherwise false.

nextName

()

method

override flash_proxy function nextName(index:int):String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Allows enumeration of the proxied object's properties by index number to retrieve property names. However, you cannot enumerate the properties of the Proxy class themselves. This function supports implementing for...in and for each..in loops on the object to retrieve the desired names.

Parameters

index:int — The zero-based index value of the object's property.

Returns

String — The property's name.

nextNameIndex

()

method

override flash_proxy function nextNameIndex(index:int):int

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Allows enumeration of the proxied object's properties by index number. However, you cannot enumerate the properties of the Proxy class themselves. This function supports implementing for...in and for each..in loops on the object to retrieve property index values.

Parameters

index:int — The zero-based index value where the enumeration begins.

Returns

int — The property's index value.

nextValue

()

method

override flash_proxy function nextValue(index:int):*

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Allows enumeration of the proxied object's properties by index number to retrieve property values. However, you cannot enumerate the properties of the Proxy class themselves. This function supports implementing for...in and for each..in loops on the object to retrieve the desired values.

Parameters

index:int — The zero-based index value of the object's property.

Returns

* — The property's value.

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

setProperty

()

method

override flash_proxy function setProperty(name:*, value:*):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Data Services for Java EE 3.1

Runtime Versions:

Flash Player 9, AIR 1.1

Overrides a call to change a property's value. If the property can't be found, this method creates a property with the specified name and value.

Parameters

	`name:*` — The name of the property to modify.

	`value:*` — The value to set the property to.

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.

DynamicManagedItem - AS3 ADEP Data Services

Classes x