asdoc/mx/formatters/StringFormatter.js.json

{ "type": "class",
  "qname": "mx.formatters.StringFormatter",
  "baseClassname": ""
  ,
    "description": "The StringFormatter class provides a mechanism for displaying and saving data in the specified format. The constructor accepts the format and an Array of tokens, and uses these values to create the data structures to support the formatting during data retrieval and saving.  <p>This class is used internally by other formatters, and is typically not used directly.</p>",
  "tags": [
  {  "tagName": "private",
         "values": []},
      {  "tagName": "see",
         "values": ["mx.formatters.DateFormatter"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.formatters.StringFormatter",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.   within the specified format String that is replaced during data formatting operations.  accessor method to call when formatting for display. The method signature is value: anything, tokenInfo: {token: id, begin: start, end: finish}. This method must return a String representation of value for the specified <code>tokenInfo</code>.",
        "tags": [
        {  "tagName": "param",
               "values": ["format String that contains the desired format.", "tokens String that contains the character tokens", "extractTokenFunc The token"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "format", "type": "String"},
        { "name": "tokens", "type": "String"},
        { "name": "extractTokenFunc", "type": "Function"}]}
      ,
      { "type": "method",
        "qname": "formatValue",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Returns the formatted String using the format, tokens, and extraction function passed to the constructor.",
        "tags": [
        {  "tagName": "param",
               "values": ["value String to be formatted."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "return",
               "values": ["Formatted String."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "String",
          "params": [{ "name": "value", "type": "Object"}]}
      ]
  }