asdoc/org/apache/royale/jewel/Snackbar.swf.json

{ "type": "class",
  "qname": "org.apache.royale.jewel.Snackbar",
  "baseClassname": "org.apache.royale.core.StyledUIBase"
  ,
    "description": "The Snackbar class is a component that provide brief messages about app processes at the bottom that pops up over all other controls. The Snackbar component uses the SnackbarView bead to display messages and can contain a single action which configured through the action property. Because Snackbar disappear automatically, the action shouldn’t be “Dismiss” or “Cancel.” The Snackbar component uses the following beads:  org.apache.royale.core.IBeadModel: the data model for the Snackbar. org.apache.royale.core.IBeadView: the bead used to create the parts of the Snackbar. org.apache.royale.core.IBeadController: the bead used to handle disappear automatically.",
  "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.Snackbar",
        "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": "ACTION",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Action event name.",
        "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": "int",
        "qname": "duration",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The number of milliseconds to show the Snackbar.",
        "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": "String",
        "qname": "message",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The text message to display in the Snackbar.",
        "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": "String",
        "qname": "action",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The action to display on the Snackbar.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "show",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "This static method is a convenience function to quickly create and display an Snackbar. The message paramters are required, the others will default.",
        "tags": [
        {  "tagName": "param",
               "values": ["String message The message content of the Snackbar.", "int duration How long to show the Snackbar for.", "String actionText The action text of the Snackbar.", "Object parent The object that hosts the pop-up."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "org.apache.royale.jewel.Snackbar",
          "params": [{ "name": "message", "type": "String"},
        { "name": "duration", "type": "int"},
        { "name": "actionText", "type": "String"},
        { "name": "parent", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "show",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Shows the Snackbar anchored to a root component such as body",
        "tags": [
        {  "tagName": "param",
               "values": ["Object parent The object that hosts the pop-up."]},
            {  "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": "parentContainer", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "dismiss",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Dismiss the snackbar.",
        "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"}]}
      ]
  ,
  "events": [
  { "qname": "action",
        "type": "org.apache.royale.events.Event"
      }]
  }