asdoc/org/apache/royale/jewel/supportClasses/button/SimpleButton.swf.json

{ "type": "class",
  "qname": "org.apache.royale.jewel.supportClasses.button.SimpleButton",
  "baseClassname": "org.apache.royale.core.UIButtonBase"
  ,
    "description": "The Jewel SimpleButton class is a simple button.  Use Jewel Button for buttons that should show text.  SimpleButton is a commonly used rectangular button. It looks like it can be pressed and allow users to take actions, and make choices, with a single click or tap. It typically use event listeners to perform an action when the user interact with the control. When a user clicks the mouse or tap with the finger this control it dispatches a click event.  This is the lightest weight button used for non-text buttons like the arrow buttons in a Scrollbar or NumericStepper.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.6"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.jewel.supportClasses.button.SimpleButton",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "classSelectorList",
        "return": "org.apache.royale.utils.ClassSelectorList",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "emphasis",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Applies emphasis color display. Possible constant values are: PRIMARY, SECONDARY, EMPHASIZED. Colors are defined in royale jewel theme CSS.  Left without value to get the default look (light or dark).",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "outlined",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Applies outlined style to the button. This combines with the emphasis styles",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.7"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "unboxed",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Applies unboxed style to the button. This combines with the emphasis styles",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.7"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "addClass",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Add a class selector to the list.",
        "tags": [
        {  "tagName": "param",
               "values": ["name Name of selector to add."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "name", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "removeClass",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Removes a class selector from the list.",
        "tags": [
        {  "tagName": "param",
               "values": ["name Name of selector to remove."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["HTMLElement", "DOMTokenList"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "name", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "toggleClass",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Add or remove a class selector to/from the list.",
        "tags": [
        {  "tagName": "param",
               "values": ["name Name of selector to add or remove.", "value True to add, False to remove."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "name", "type": "String"},
        { "name": "value", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "containsClass",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Search for the name in the element class list",
        "tags": [
        {  "tagName": "param",
               "values": ["name Name of selector to find."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "return",
               "values": ["return true if the name is found or false otherwise."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "name", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "replaceClass",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Replace a class for a new one",
        "tags": [
        {  "tagName": "param",
               "values": ["oldClass Name of selector to remove.", "newClass Name of selector to set."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.10.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "oldClass", "type": "String"},
        { "name": "newClass", "type": "String"}]}
      ]
  ,
  "events": [
  { "qname": "click",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user clicks on a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "rollOver",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user moves onto a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "rollOut",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user moves out a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseDown",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user press mouse over a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseUp",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user release mouse over a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseMove",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user moves mouse pointer over a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseOut",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user moves mouse pointer out of a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseOver",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user moves onto a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "mouseWheel",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user scrolls mouse whell over a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "doubleClick",
        "type": "org.apache.royale.events.MouseEvent"
      ,
          "description": "Dispatched when the user double-click over a button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }