asdoc/mx/formatters/PhoneFormatter.js.json

{ "type": "class",
  "qname": "mx.formatters.PhoneFormatter",
  "baseClassname": "mx.formatters.Formatter"
  ,
    "description": "The PhoneFormatter class formats a valid number into a phone number format, including international configurations.  <p>A shortcut is provided for the United States seven-digit format. If the <code>areaCode</code> property contains a value and you use the seven-digit format string, (###-####), a seven-digit value to format automatically adds the area code to the returned String. The default format for the area code is (###). You can change this using the <code>areaCodeFormat</code> property. You can format the area code any way you want as long as it contains three number placeholders.</p>  <p>If an error occurs, an empty String is returned and a String that describes the error is saved to the <code>error</code> property. The <code>error</code> property can have one of the following values:</p>  <ul> <li><code>&quot;Invalid value&quot;</code> means an invalid numeric value is passed to the <code>format()</code> method. The value should be a valid number in the form of a Number or a String, or the value contains a different number of digits than what is specified in the format String.</li> <li> <code>&quot;Invalid format&quot;</code> means any of the characters in the <code>formatString</code> property do not match the allowed characters specified in the <code>validPatternChars</code> property, or the <code>areaCodeFormat</code> property is specified but does not contain exactly three numeric placeholders.</li> </ul>   <p>The <code>&lt;mx:PhoneFormatter&gt;</code> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:</p>  <pre>\\n &lt;mx:PhoneFormatter\\n areaCode=&quot;-1&quot;\\n areaCodeFormat=&quot;(###)&quot;\\n formatString=&quot;(###) ###-####&quot;\\n validPatternChars=&quot;+()#-. &quot;\\n />\\n </pre>",
  "tags": [
  {  "tagName": "includeExample",
         "values": ["examples/PhoneFormatterExample.mxml"]},
      {  "tagName": "see",
         "values": ["mx.formatters.SwitchSymbolFormatter"]},
      {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "mxml",
         "values": []},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "mx.formatters.PhoneFormatter",
        "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": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "formatString",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "String that contains mask characters that represent a specified phone number format.",
        "tags": [
        {  "tagName": "default",
               "values": [""(###) ###-####""]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }