asdoc/mx/formatters/Formatter.swf.json

{ "type": "class",
  "qname": "mx.formatters.Formatter",
  "baseClassname": ""
  ,
    "description": "The Formatter class is the base class for all data formatters. Any subclass of Formatter must override the <code>format()</code> method.   <p>The Formatter class defines the following tag attributes, which all of its subclasses inherit:</p>  <pre>\\n &lt;mx:<i>tagname</i>\\n <b>Properties</b>\\n error=&quot;&quot;\\n /&gt;\\n </pre>",
  "tags": [
  {  "tagName": "includeExample",
         "values": ["examples/SimpleFormatterExample.mxml"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "mxml",
         "values": []},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "defaultInvalidFormatError",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Error message for an invalid format string specified to the formatter. The localeChain property of the ResourceManager is used to resolve the default error message. If it is unable to find a value, it will return <code>null</code>. This can happen if none of the locales specified in the localeChain are compiled into the application.",
        "tags": [
        {  "tagName": "default",
               "values": [""Invalid format""]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "defaultInvalidValueError",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Error messages for an invalid value specified to the formatter. The localeChain property of the ResourceManager is used to resolve the default error message. If it is unable to find a value, it will return <code>null</code>. This can happen if none of the locales specified in the localeChain are compiled into the application.",
        "tags": [
        {  "tagName": "default",
               "values": [""Invalid value""]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "mx.formatters.Formatter",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "error",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Description saved by the formatter when an error occurs. For the possible values of this property, see the description of each formatter. <p>Subclasses must set this value in the <code>format()</code> method.</p>",
        "tags": [
        {  "tagName": "royalesuppresspublicvarwarning",
               "values": []},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "format",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Formats a value and returns a String containing the new, formatted, value. All subclasses must override this method to implement the formatter.",
        "tags": [
        {  "tagName": "param",
               "values": ["value Value to be formatted."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["The formatted string."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "String",
          "params": [{ "name": "value", "type": "Object"}]}
      ]
  }