asdoc/spark/components/FormItem.swf.json

{ "type": "class",
  "qname": "spark.components.FormItem",
  "baseClassname": "spark.components.SkinnableContainer"
  ,
    "description": "The FormItem container defines the following in a Spark From:  <ul> <li>A single label.</li> <li>A sequence label.</li> <li>One or more child controls or containers.</li> <li>Help content that provides a description of the form item or instructions for filling it in.</li> <li>Required indicator to indicate if a form item has to be filled</li> </ul>  Children can be controls or other containers. A single Form container can hold multiple FormItem containers. By default, all the FormItem elements are arranged in a horizontal layout with the label placed on the left and the Help content on the right.   <p>The <code>&lt;s:FormItem&gt;</code> tag inherits all the tag attributes of its superclass and adds no new tag attributes:</p>  <pre>\\n &lt;s:FormItem\\n <strong>Properties</strong>\\n helpContent=&quot;null&quot;\\n label=&quot;&quot;\\n required=&quot;false&quot;\\n sequenceLabel=&quot;&quot;\\n \\n <strong>Common Styles</strong>\\n errorIndicatorSource=&quot;assets/ErrorIndicator.png&quot;\\n requiredIndicatorSource=&quot;assets/RequiredIndicator.png&quot;\\n \\n <strong>Mobile Styles</strong>\\n leading=&quot;2&quot;\\n letterSpacing=&quot;0&quot;\\n /&gt;\\n </pre>",
  "tags": [
  {  "tagName": "includeExample",
         "values": ["examples/FormItemExample.mxml"]},
      {  "tagName": "see",
         "values": ["spark.components.Form", "spark.components.FormHeading", "spark.layouts.FormLayout", "spark.skins.spark.FormItemSkin"]},
      {  "tagName": "mxml",
         "values": []},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 2.5"]},
      {  "tagName": "productversion",
         "values": ["Flex 4.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []}  ],
  "members": [
  { "type": "method",
        "qname": "spark.components.FormItem",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "labelDisplay",
        "return": "spark.core.IDisplayText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the visual element that displays this FormItem's label."},
      { "type": "field",
        "qname": "sequenceLabelDisplay",
        "return": "spark.core.IDisplayText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the visual element that displays the FormItem's sequenceLabel."},
      { "type": "field",
        "qname": "helpContentGroup",
        "return": "spark.components.Group",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the Group that contains the FormItem's helpContentGroup."},
      { "type": "field",
        "qname": "errorTextDisplay",
        "return": "spark.core.IDisplayText",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "A reference to the visual element that display the FormItem's error strings."},
      { "type": "field",
        "qname": "_elementErrorStrings",
        "return": "Vector.<String>",
        "namespace": "mx_internal",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-only",
        "return": "Vector.<String>",
        "qname": "elementErrorStrings",
        "namespace": "public",
        "bindable": ["elementErrorStringsChanged"],
        "details": [],
        "deprecated": {},
          "description": "Each Vector item contains the error string from a content element. If none of the content elements are invalid, then the vector is empty.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "helpContent",
        "namespace": "public",
        "bindable": ["helpContentChanged"],
        "details": [],
        "deprecated": {},
          "description": "The set of components to include in the help content area of the FormItem.",
        "tags": [
        {  "tagName": "default",
               "values": ["null"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "label",
        "namespace": "public",
        "bindable": ["labelChanged"],
        "details": [],
        "deprecated": {},
          "description": "Text label for the FormItem. For example, a FormItem used to input an address might have the label of &quot;Address&quot;.",
        "tags": [
        {  "tagName": "default",
               "values": [""""]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "required",
        "namespace": "public",
        "bindable": ["requiredChanged"],
        "details": [],
        "deprecated": {},
          "description": "If <code>true</code>, puts the FormItem skin into the <code>required</code> state. By default, this state displays an indicator that the FormItem children require user input. If <code>false</code>, the indicator is not displayed.  <p>This property controls skin's state only. You must assign a validator to the child if you require input validation.</p>",
        "tags": [
        {  "tagName": "default",
               "values": ["false"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "sequenceLabel",
        "namespace": "public",
        "bindable": ["sequenceLabelChanged"],
        "details": [],
        "deprecated": {},
          "description": "The number of the form item in the form.",
        "tags": [
        {  "tagName": "default",
               "values": [""""]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Number",
        "qname": "baselinePosition",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "private",
               "values": []}  ]},
      { "type": "method",
        "qname": "updateErrorTextDisplay",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Converts <code>elementErrorStrings</code> into a String, and assigns that String to the <code>errorTextDisplay</code> skin part for display.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 2.5"]},
            {  "tagName": "productversion",
               "values": ["Flex 4.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": []}
      ]
  }