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

{ "type": "class",
  "qname": "org.apache.royale.jewel.Wizard",
  "baseClassname": "org.apache.royale.jewel.Group"
  ,
    "description": "Wizard is a container that navigates from one content to the next. The content is organized in wizard pages It can provide previous and next navigation buttons",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.jewel.WizardPage"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.jewel.Wizard",
        "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": "method",
        "qname": "showPage",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Update currentStep by name finding the appropiate step",
        "tags": [
        {  "tagName": "see",
               "values": ["org.apache.royale.jewel.WizardContent.selectedContent"]},
            {  "tagName": "param",
               "values": ["stepName, that is the "id" of the content (the WizardPage) to activate"]}  ],
          "return": "void",
          "params": [{ "name": "stepName", "type": "String"}]}
      ,
      { "type": "method",
        "qname": "findStepByName",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "org.apache.royale.jewel.beads.models.WizardStep",
          "params": [{ "name": "name", "type": "String"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "title",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The string to display in the org.apache.royale.jewel.TitleBar.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.jewel.beads.models.WizardModel"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "activateEffect",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "turn on/off the transition effects",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.6"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.jewel.beads.models.WizardModel"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "htmlTitle",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The HTML string to display in the org.apache.royale.jewel.TitleBar.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.jewel.beads.models.WizardModel"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "previousButton",
        "return": "org.apache.royale.core.UIBase",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royalesuppresspublicvarwarning",
               "values": []}  ]},
      { "type": "field",
        "qname": "nextButton",
        "return": "org.apache.royale.core.UIBase",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "royalesuppresspublicvarwarning",
               "values": []}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "org.apache.royale.jewel.WizardContent",
        "qname": "content",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "the pages of the wizard"},
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.jewel.beads.models.WizardStep",
        "qname": "currentStep",
        "namespace": "public",
        "bindable": ["change"],
        "details": [],
        "deprecated": {},
          "description": "the current step or page visualized in this wizard",
        "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-only",
        "return": "int",
        "qname": "numElements",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "private",
               "values": []},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.jewel.beads.views.WizardView"]}  ]},
      { "type": "method",
        "qname": "$addElement",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "c", "type": "org.apache.royale.core.IChild"},
        { "name": "dispatchEvent", "type": "Boolean"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "int",
        "qname": "$numElements",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {}},
      { "type": "method",
        "qname": "$getElementAt",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "org.apache.royale.core.IChild",
          "params": [{ "name": "index", "type": "int"}]}
      ]
  ,
  "events": [
  { "qname": "goToPreviousStep",
        "type": "org.apache.royale.events.Event"
      ,
          "description": "Indicates that wizard navigates to the previous page.",
        "tags": [
        {  "tagName": "toplevel",
               "values": []},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "goToNextStep",
        "type": "org.apache.royale.events.Event"
      ,
          "description": "Indicates that wizard navigates to the next page.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "qname": "change",
        "type": "org.apache.royale.events.Event"
      ,
          "description": "Indicates a change of step",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }