asdoc/org/apache/royale/html/Alert.js.json

{ "type": "class",
  "qname": "org.apache.royale.html.Alert",
  "baseClassname": "org.apache.royale.html.Group"
  ,
    "description": "The Alert class is a component that displays a message and one or more buttons in a view that pops up over all other controls and views. The Alert component uses the AlertView bead to display a modal dialog with a title and a variety of buttons configured through the flag property of its show() static function. The Alert component uses the following beads:  org.apache.royale.core.IBeadModel: the data model for the Alert. org.apache.royale.core.IBeadView: the bead used to create the parts of the Alert. org.apache.royale.core.IBeadController: the bead used to handle input events. org.apache.royale.html.beads.IBorderBead: if present, draws a border around the Alert. org.apache.royale.html.beads.IBackgroundBead: if present, places a solid color background below the Alert.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "YES",
        "return": "uint",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The bitmask button flag to show the YES button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "NO",
        "return": "uint",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The bitmask button flag to show the NO button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "OK",
        "return": "uint",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The bitmask button flag to show the OK button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "CANCEL",
        "return": "uint",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The bitmask button flag to show the Cancel button.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "org.apache.royale.html.Alert",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "method",
        "qname": "show",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "This static method is a convenience function to quickly create and display an Alert. The text and parent paramters are required, the others will default.",
        "tags": [
        {  "tagName": "param",
               "values": ["String message The message content of the Alert.", "Object parent The object that hosts the pop-up.", "String title An optional title for the Alert.", "uint flags Identifies which buttons to display in the alert."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "org.apache.royale.html.Alert",
          "params": [{ "name": "message", "type": "String"},
        { "name": "parent", "type": "Object"},
        { "name": "title", "type": "String"},
        { "name": "flags", "type": "uint"}]}
      ,
      { "type": "method",
        "qname": "show",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Shows the Alert anchored to the given parent object which is usally a root component such as a UIView..",
        "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.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "parent", "type": "Object"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "title",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The tile of the Alert.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "message",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The message to display in the Alert body.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "uint",
        "qname": "flags",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The buttons to display on the Alert as bit-mask values.  Alert.YES Alert.NO Alert.OK Alert.CANCEL",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  ,
  "events": [
  { "qname": "close",
        "type": "org.apache.royale.events.CloseEvent"
      }]
  }