asdoc/org/apache/royale/jewel/beads/controls/image/ClipImage.js.json

{ "type": "class",
  "qname": "org.apache.royale.jewel.beads.controls.image.ClipImage",
  "baseClassname": ""
  ,
    "description": "The HorizontalListScroll bead is a specialty bead that can be used with Jewel List control and gives horizontal scroll to the list  examples of use:  CIRCLE_SHAPE <j:ClipImage shape=&quot;{ClipImage.CIRCLE_SHAPE}&quot; radius=&quot;46&quot; x=&quot;50&quot; y=&quot;50&quot; units=&quot;%&quot;/>  - using a border: <j:ClipImage shape=&quot;{ClipImage.CIRCLE_SHAPE}&quot; radius=&quot;46&quot; x=&quot;50&quot; y=&quot;50&quot; units=&quot;%&quot; border=&quot;1&quot; borderColor=&quot;#666666&quot;/>  POLYGON_SHAPE <j:ClipImage shape=&quot;{ClipImage.POLYGON_SHAPE}&quot; units=&quot;%&quot; points=&quot;[50,0,0,100,100,100]&quot;/> <j:ClipImage shape=&quot;{ClipImage.POLYGON_SHAPE}&quot; units=&quot;%&quot; points=&quot;[20, 0, 0, 20, 30, 50, 0, 80, 20, 100, 50, 70, 80, 100, 100, 80, 70, 50, 100, 20, 80, 0, 50, 30]&quot;/>  ELLIPSE_SHAPE <j:ClipImage shape=&quot;{ClipImage.ELLIPSE_SHAPE}&quot; radius=&quot;46&quot; bradius=&quot;20&quot; x=&quot;50&quot; y=&quot;50&quot; units=&quot;%&quot;/>  INSET_SHAPE <j:ClipImage shape=&quot;{ClipImage.INSET_SHAPE}&quot; inset=&quot;[5, 20, 15, 10]&quot; rounds=&quot;[5, 20, 0, 10]&quot;  units=&quot;%&quot;/>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.10.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "INSET_SHAPE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "CIRCLE_SHAPE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "ELLIPSE_SHAPE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "POLYGON_SHAPE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "method",
        "qname": "org.apache.royale.jewel.beads.controls.image.ClipImage",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.10.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "shape",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "the shape for the clip. values can be &quot;inset&quot;, &quot;circle&quot;, &quot;ellipse&quot;, &quot;polygon&quot;"},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "radius",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "bradius",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "x",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "y",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "units",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "the units to use . values can be &quot;px&quot;, &quot;%&quot; defauls to &quot;%&quot;&quot;"},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "points",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Only for POLYGON shapes An Array of x and y points used in POLYGON shapes. Minimun 3 points If you want just 3 points add them in the following way: [x1, y1, x2, y2, x3, y3]"},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "inset",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Only for INSET shapes An Array of 4 values used in INSET shapes to limit the inset shape"},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "rounds",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Only for INSET shapes An Array of 4 values used in INSET shapes to round the corners between inset values"},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "border",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "the border tickness"},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "borderColor",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "the border color"},
      { "type": "accessor",
        "access": "write-only",
        "return": "org.apache.royale.core.IStrand",
        "qname": "strand",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "copy",
               "values": ["org.apache.royale.core.IBead#strand"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.10.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "createClipShape",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "ruleName", "type": "String"},
        { "name": "before", "type": "Boolean"}]}
      ]
  }