ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.rpc.xml 

IXMLDecoder  - AS3 Flex
Packagemx.rpc.xml
Interfacepublic interface IXMLDecoder

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Decodes an XML document to an ActionScript object graph based on XML Schema definitions.


Public Properties
 PropertyDefined By
  makeObjectsBindable : Boolean
When makeObjectsBindable is set to true, anonymous Objects and Arrays are wrapped to make them bindable.
IXMLDecoder
  recordXSIType : Boolean
When recordXSIType is set to true, if an encoded complexType has an xsi:type attribute the type information will be recorded on the decoded instance if it is strongly typed and implements mx.rpc.xml.IXMLSchemaInstance or is an anonymous mx.utils.ObjectProxy.
IXMLDecoder
  typeRegistry : mx.rpc.xml:SchemaTypeRegistry
Maps XML Schema types by QName to ActionScript Classes in order to create strongly typed objects when decoding content.
IXMLDecoder
Public Methods
 MethodDefined By
  
decode(xml:*, name:QName = null, type:QName = null, definition:XML = null):*
Decodes an XML document to an ActionScript object.
IXMLDecoder
  
reset():void
Resets the decoder to its initial state, including resetting any Schema scope to the top level and releases the current XML document by setting it to null.
IXMLDecoder
Property Detail

makeObjectsBindable

property
makeObjectsBindable:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

When makeObjectsBindable is set to true, anonymous Objects and Arrays are wrapped to make them bindable. Objects are wrapped with mx.utils.ObjectProxy and Arrays are wrapped with mx.collections.ArrayCollection.



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

recordXSIType

property 
recordXSIType:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

When recordXSIType is set to true, if an encoded complexType has an xsi:type attribute the type information will be recorded on the decoded instance if it is strongly typed and implements mx.rpc.xml.IXMLSchemaInstance or is an anonymous mx.utils.ObjectProxy. This type information can be used to post process the decoded objects and identify which concrete implementation of a potentially abstract type was used. The default is false.



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

typeRegistry

property 
typeRegistry:mx.rpc.xml:SchemaTypeRegistry

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Maps XML Schema types by QName to ActionScript Classes in order to create strongly typed objects when decoding content.



Implementation
    public function get typeRegistry():mx.rpc.xml:SchemaTypeRegistry
    public function set typeRegistry(value:mx.rpc.xml:SchemaTypeRegistry):void
Method Detail

decode

()method
public function decode(xml:*, name:QName = null, type:QName = null, definition:XML = null):*

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Decodes an XML document to an ActionScript object.

Parameters

xml:* — The XML instance to decode to an ActionScript object. This may be an XML instance, an XMLList of length 1 or a String that is valid XML.
 
name:QName (default = null) — The QName of an XML Schema element that describes how to decode the value, or the name to be used for the decoded value when a type parameter is also specified.
 
type:QName (default = null) — The QName of an XML Schema simpleType or complexType definition that describes how to decode the value.
 
definition:XML (default = null) — If neither a top-level element nor type exists in the schema to describe how to decode this value, a custom element definition can be provided.

Returns
* — Returns an ActionScript object decoded from the given XML document.

reset

()method 
public function reset():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Resets the decoder to its initial state, including resetting any Schema scope to the top level and releases the current XML document by setting it to null.




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

 

Legal Notices | Online Privacy Policy