mx.messaging.config

# ConfigMap - AS3 BlazeDS LCDS

Package | mx.messaging.config
Class | public dynamic class ConfigMap
Inheritance | ConfigMap Proxy

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

The ConfigMap class provides a mechanism to store the properties returned by the server with the ordering of the properties maintained.

Protected Properties

| Property | Defined By
--- | --- | ---
|  | propertyList : Array Contains a list of all of the property names for the proxied object. | ConfigMap

Public Methods

| Method | Defined By
--- | --- | ---
|  | ConfigMap(item:Object = null) Constructor. | ConfigMap

Protected Methods

| Method | Defined By
--- | --- | ---
|  | callProperty(name:*, ... rest):* [override] Returns the value of the proxied object's method with the specified name. | ConfigMap
|  | deleteProperty(name:*):Boolean [override] Deletes the specified property on the proxied object and sends notification of the delete to the handler. | ConfigMap
|  | getProperty(name:*):* [override] Returns the specified property value of the proxied object. | ConfigMap
|  | hasProperty(name:*):Boolean [override] This is an internal function that must be implemented by a subclass of flash.utils.Proxy. | ConfigMap
|  | nextName(index:int):String [override] This is an internal function that must be implemented by a subclass of flash.utils.Proxy. | ConfigMap
|  | nextNameIndex(index:int):int [override] This is an internal function that must be implemented by a subclass of flash.utils.Proxy. | ConfigMap
|  | nextValue(index:int):* [override] This is an internal function that must be implemented by a subclass of flash.utils.Proxy. | ConfigMap
|  | setProperty(name:*, value:*):void [override] Updates the specified property on the proxied object and sends notification of the update to the handler. | ConfigMap

Property Detail

### propertyList

property

`object_proxy var propertyList:Array`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Contains a list of all of the property names for the proxied object.

Constructor Detail

### ConfigMap

()
Constructor

`public function ConfigMap(item:Object = null)`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `item:Object` (default = `null`)`` — An Object containing name/value pairs.

Method Detail

### callProperty

()
method

`override flash_proxy function callProperty(name:*, ... rest):*`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the value of the proxied object's method with the specified name.

Parameters

| `name:*` — The name of the method being invoked.
| `... rest` — 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 Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Deletes the specified property on the proxied object and sends notification of the delete to the handler.

Parameters

| `name:*` — Typically a string containing the name of the property, or possibly a QName where the property name is found by inspecting the `localName` property.

Returns

| `Boolean` — A Boolean indicating if the property was deleted.

### getProperty

()
method

`override flash_proxy function getProperty(name:*):*`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the specified property value of the proxied object.

Parameters

| `name:*` — Typically a string containing the name of the property, or possibly a QName where the property name is found by inspecting the `localName` property.

Returns

| `*` — The value of the property.

### hasProperty

()
method

`override flash_proxy function hasProperty(name:*):Boolean`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

This is an internal function that must be implemented by a subclass of flash.utils.Proxy.

Parameters

| `name:*` — The property name that should be tested for existence.

Returns

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

Related API Elements

flash.utils.Proxy.hasProperty()

### nextName

()
method

`override flash_proxy function nextName(index:int):String`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

This is an internal function that must be implemented by a subclass of flash.utils.Proxy.

Parameters

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

Returns

| `String` — The property's name.

Related API Elements

flash.utils.Proxy.nextName()

### nextNameIndex

()
method

`override flash_proxy function nextNameIndex(index:int):int`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

This is an internal function that must be implemented by a subclass of flash.utils.Proxy.

Parameters

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

Returns

| `int` — The zero-based index of the next proprety.

Related API Elements

flash.utils.Proxy.nextNameIndex()

### nextValue

()
method

`override flash_proxy function nextValue(index:int):*`

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

This is an internal function that must be implemented by a subclass of flash.utils.Proxy.

Parameters

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

Returns

| `*` — The property's value.

Related API Elements

flash.utils.Proxy.nextValue()

### setProperty

()
method

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

Language Version: | ActionScript 3.0

Product Versions: | BlazeDS 4, Adobe Digital Enterprise Platform Data Services for Java EE 3

Runtime Versions: | Flash Player 9, AIR 1.1

Updates the specified property on the proxied object and sends notification of the update to the handler.

Parameters

| `name:*` — Object containing the name of the property that should be updated on the proxied object.
| `value:*` — Value that should be set on the proxied object.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00