asdoc/spark/components/supportClasses/RegExPatterns.js.json

{ "type": "class",
  "qname": "spark.components.supportClasses.RegExPatterns",
  "baseClassname": ""
  ,
    "description": "This provides a means to standardize certain common regex patterns and functionality.  <p>Use the constants in ActionsScript, as the following example shows: </p> <pre>\\n createRegExp(&quot;my search value&quot;, RegExPatterns.CONTAINS):RegExp\\n </pre>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 11.1", "AIR 3.4"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.10"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "spark.components.supportClasses.RegExPatterns",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "CONTAINS",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern matching the end with a given value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "ENDS_WITH",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern matching the end with a given value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "EXACT",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern matching exacly to a given value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "NOT",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern match that does not contain a given value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "NOT_EMPTY",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern match that specifies must have at least 1 character matching.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "STARTS_WITH",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies the use of a regex pattern matching the beginging with a given value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "createRegExp",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates a new RegEx pattern based on a given value and a selected pattern Type.",
        "tags": [
        {  "tagName": "param",
               "values": ["patternValue Is the value that will be assembled into the RegEx type.", "patternType Is the type of regen pattern matching to be performed."]},
            {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "return",
               "values": ["Returns a <code>RegExp</code> with a formatted RegEx pattern."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "RegExp",
          "params": [{ "name": "patternValue", "type": "String"},
        { "name": "patternType", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "createPatternString",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Creates a new string based RegEx pattern based on a given value and a selected pattern Type.",
        "tags": [
        {  "tagName": "param",
               "values": ["patternValue Is the value that will be assembled into the RegEx type.", "patternType Is the type of regen pattern matching to be performed."]},
            {  "tagName": "playerversion",
               "values": ["Flash 11.1", "AIR 3.4"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.10"]},
            {  "tagName": "return",
               "values": ["Returns a string with a formatted RegEx pattern."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "String",
          "params": [{ "name": "patternValue", "type": "String"},
        { "name": "patternType", "type": "String"}]}
      ]
  }