asdoc/mx/rpc/xml/IXMLDecoder.js.json

{ "type": "interface",
  "qname": "mx.rpc.xml.IXMLDecoder",
    "description": "Decodes an XML document to an ActionScript object graph based on XML Schema definitions.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "makeObjectsBindable",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "When makeObjectsBindable is set to <code>true</code>, anonymous Objects and Arrays are wrapped to make them bindable. Objects are wrapped with <code>mx.utils.ObjectProxy</code> and Arrays are wrapped with <code>mx.collections.ArrayCollection</code>.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "recordXSIType",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "When recordXSIType is set to <code>true</code>, if an encoded complexType has an <code>xsi:type</code> attribute the type information will be recorded on the decoded instance if it is strongly typed and implements <code>mx.rpc.xml.IXMLSchemaInstance</code> or is an anonymous <code>mx.utils.ObjectProxy</code>. 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.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "mx.rpc.xml.SchemaTypeRegistry",
    "qname": "typeRegistry",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Maps XML Schema types by QName to ActionScript Classes in order to create strongly typed objects when decoding content.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "decode",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Decodes an XML document to an ActionScript object.  This may be an XML instance, an XMLList of length 1 or a String that is valid XML.  describes how to decode the value, or the name to be used for the decoded value when a type parameter is also specified.  <code>complexType</code> definition that describes how to decode the value.  schema to describe how to decode this value, a custom element definition can be provided.",
    "tags": [
    {  "tagName": "param",
           "values": ["xml The XML instance to decode to an ActionScript object.", "name The QName of an XML Schema <code>element</code> that", "type The QName of an XML Schema <code>simpleType</code> or", "definition If neither a top-level element nor type exists in the"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["Returns an ActionScript object decoded from the given XML document."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "*",
      "params": [{ "name": "xml", "type": "*"},
    { "name": "name", "type": "QName"},
    { "name": "type", "type": "QName"},
    { "name": "definition", "type": "XML"}]}
  ,
  { "type": "method",
    "qname": "reset",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "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.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ]
  }