| Package | lc.foundation.domain |
| Class | public dynamic class Properties |
| Inheritance | Properties  Proxy |
| Implements | IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Properties class is used to dynamically save and retrieve properties.
Related API Elements
flash.events.IEventDispatcher
| Method | Defined By | ||
|---|---|---|---|
Properties(coreProperties:Object)
Constructor. | Properties | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | Properties | ||
Dispatches an event into the event flow. | Properties | ||
Checks whether the EventDispatcher object has any listeners registered for a
specific type of event. | Properties | ||
Removes a listener from the EventDispatcher object. | Properties | ||
Determines whether an event listener is registered with this EventDispatcher
object or any of its ancestors for the specified event type. | Properties | ||
| Method | Defined By | ||
|---|---|---|---|
[override]
Overrides the request to delete a property. | Properties | ||
[override]
Overrides any request for a property's value. | Properties | ||
[override]
Overrides a request to check whether an object has a particular property by name. | Properties | ||
[override]
Allows enumeration of the proxied object's properties by index number to retrieve property names. | Properties | ||
[override]
Allows enumeration of the object's properties by index number. | Properties | ||
[override]
Allows enumeration of the proxied object's properties by index number to retrieve property values. | Properties | ||
[override]
Overrides a call to change a property's value. | Properties | ||
Properties | () | Constructor |
public function Properties(coreProperties:Object)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
ParameterscoreProperties:Object — Specifies the properties to save and retrieve.
|
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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.
Parameters
type:String — Specifies he type of event.
| |
listener:Function — Specifies listener function that processes the event. This function must accept an event object as its only
parameter and must return nothing.
| |
useCapture:Boolean (default = false)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) | |
useWeakReference:Boolean (default = false)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.
|
Related API Elements
deleteProperty | () | method |
override flash_proxy function deleteProperty(name:*):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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.
|
Boolean — Whether the property was deleted. A value of true indicates that the property was deleted.
|
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatches an event into the event flow.
The event target is the EventDispatcher object upon which dispatchEvent() method
is called.
Parameters
event:Event — Specifies the event object dispatched into the event flow.
|
Boolean — Whether the event is dispatched. A value true is always returned unless
the preventDefault() method is called on the event.
|
Related API Elements
getProperty | () | method |
override flash_proxy function getProperty(nameIn:*):*| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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
nameIn:* — the name of the property to retrieve.
|
* — The specified property or a value of undefined if the property was not found.
|
Related API Elements
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 the IEventDispatcher.willTrigger() method.
The difference between hasEventListener() and willTrigger() methods is
that hasEventListener() method examines only the object to which it belongs, whereas
willTrigger() method examines the entire event flow for the event specified
by the type parameter.
Parameters
type:String — Specifies the type of event.
|
Boolean — Whether the event is registered. A value of true specifies that the event is registered.
|
Related API Elements
hasProperty | () | method |
override flash_proxy function hasProperty(nameIn:*):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Overrides a request to check whether an object has a particular property by name.
Parameters
nameIn:* — The name of the property to check for.
|
Boolean — Whether the property exists. A value of true indicates that the property exists.
|
Related API Elements
nextName | () | method |
override flash_proxy function nextName(index:int):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Allows enumeration of the proxied object's properties by index number to retrieve property names.
Parameters
index:int — Specifies the object's property using a zero-bsed index value.
|
String — The name of the property.
|
Related API Elements
nextNameIndex | () | method |
override flash_proxy function nextNameIndex(index:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Allows enumeration of the object's properties by index number.
Parameters
index:int — Specifies the object's property using a zero-bsed index value.
|
int — The index value of the property.
|
Related API Elements
nextValue | () | method |
override flash_proxy function nextValue(index:int):*| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Allows enumeration of the proxied object's properties by index number to retrieve property values.
Parameters
index:int — Specifies the object's property using a zero-bsed index value.
|
* — The value of the specified property.
|
Related API Elements
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 — Specifies the type of event to remove.
| |
listener:Function — Specifies the listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() method
are required to remove both. The first call is made with this parameter set to true,
and the second call is made to this method with useCapture set to false.
|
Related API Elements
setProperty | () | method |
override flash_proxy function setProperty(nameIn:*, newValue:*):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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
nameIn:* — The name of the property to modify.
| |
newValue:* — The value to set the property to.
|
willTrigger | () | method |
public function willTrigger(type:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Determines 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 — Specifies the type of event.
|
Boolean — Whether the specified event type is triggered. A value of true specifies that he specified
event type was triggered.
|
Mon Nov 18 2013, 11:47 AM -08:00