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

{ "type": "class",
  "qname": "org.apache.royale.jewel.Alert",
  "baseClassname": "org.apache.royale.jewel.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.core.IBorderBead: if present, draws a border around the Alert. org.apache.royale.core.IBackgroundBead: if present, places a solid color background below the Alert.  Note: Alert use the HTML <dialog> element, which currently has very limited cross-browser support. To ensure support across all modern browsers, we use use dialogPolyfill extern or creating your own. The required Dialog Polyfill lines are injected in the constructor",
  "tags": [
  {  "tagName": "viewbead",
         "values": []},
      {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.9.4"]},
      {  "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.9.4"]},
            {  "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.9.4"]},
            {  "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.9.4"]},
            {  "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.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "org.apache.royale.jewel.Alert",
        "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": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "title",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The title of the Alert.",
        "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 message to display in the Alert body.",
        "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": "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.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "createElement",
        "namespace": "protected",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.core.WrappedHTMLElement", "HTMLDialogElement"]}  ],
          "return": "org.apache.royale.core.WrappedHTMLElement",
          "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.", "String title An optional title for the Alert.", "uint flags Identifies which buttons to display in the alert.", "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.Alert",
          "params": [{ "name": "message", "type": "String"},
        { "name": "title", "type": "String"},
        { "name": "flags", "type": "uint"},
        { "name": "parent", "type": "Object"},
        { "name": "modal", "type": "Boolean"}]}
      ,
      { "type": "method",
        "qname": "showModal",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Shows the Alert modal anchored to the given parent object which is usally a root component such as a UIView or body if null",
        "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": "parent", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "show",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Shows the Alert non modal anchored to the given parent object which is usally a root component such as a UIView or body if null",
        "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": "parent", "type": "Object"}]}
      ,
      { "type": "method",
        "qname": "close",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Closes the dialog element.",
        "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": "buttonFlag", "type": "uint"}]}
      ]
  ,
  "events": [
  { "qname": "close",
        "type": "org.apache.royale.events.CloseEvent"
      }]
  }