asdoc/org/apache/royale/jewel/beads/layouts/HorizontalLayout.js.json

{ "type": "class",
  "qname": "org.apache.royale.jewel.beads.layouts.HorizontalLayout",
  "baseClassname": "org.apache.royale.jewel.beads.layouts.SimpleHorizontalLayout"
  ,
    "description": "The HorizontalLayout class is a horizontal layout bead similar to SimpleHorizontalLayout, but add support for gap values.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.4"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.jewel.beads.layouts.HorizontalLayout",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "LAYOUT_TYPE_NAMES",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royalesuppresspublicvarwarning",
               "values": []}  ]},
      { "type": "method",
        "qname": "beadsAddedHandler",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Add class selectors when the component is addedToParent Otherwise component will not get the class selectors when perform "removeElement" and then "addElement"",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "event", "type": "org.apache.royale.events.Event"}]}
      ,
      { "type": "method",
        "qname": "applyStyleToLayout",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Get the component layout style and apply to if exists",
        "tags": [
        {  "tagName": "see",
               "values": ["org.apache.royale.core.layout.ILayoutStyleProperties#applyStyleToLayout(component:IUIBase, cssProperty:String):void"]},
            {  "tagName": "param",
               "values": ["component the IUIBase component that host this layout", "cssProperty the style property in css set for the component to retrieve"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "component", "type": "org.apache.royale.core.IUIBase"},
        { "name": "cssProperty", "type": "String"}]}
      ,
      { "type": "field",
        "qname": "_gap",
        "return": "Number",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "gap",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Assigns variable gap in steps of GAP_STEP. You have available GAPS*GAP_STEP gap styles Activate "gap-{X}x{GAP_STEP}px" effect selector to set a numeric gap between elements. i.e: gap-2x3px will result in a gap of 6px",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "variableRowHeight",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Specifies whether layout elements are allocated their preferred height. Setting this property to false specifies fixed height rows.  If false, the actual height of each layout element is the value of rowHeight. The default value is true.  Note: From Flex but we should see what to do in Royale -> Setting this property to false causes the layout to ignore the layout elements' percentHeight property."},
      { "type": "method",
        "qname": "layout",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Layout children horizontally",
        "tags": [
        {  "tagName": "copy",
               "values": ["org.apache.royale.core.IBeadLayout#layout"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.core.ILayoutHost", "org.apache.royale.core.WrappedHTMLElement", "org.apache.royale.core.IBorderPaddingMarginValuesImpl"]}  ],
          "return": "Boolean",
          "params": []}
      ]
  }