asdoc/org/apache/royale/jewel/beads/models/DateChooserModel.swf.json

{ "type": "class",
  "qname": "org.apache.royale.jewel.beads.models.DateChooserModel",
  "baseClassname": "org.apache.royale.events.EventDispatcher"
  ,
    "description": "The DateChooserModel is a bead class that manages the data for a DataChooser. This includes arrays of names for the months and days of the week as well the currently selected date.",
  "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.beads.models.DateChooserModel",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "write-only",
        "return": "org.apache.royale.core.IStrand",
        "qname": "strand",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "copy",
               "values": ["org.apache.royale.core.IBead#strand"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.9.4"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "int",
        "qname": "viewState",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "0 - days (calendar view): Select a day in a month calendar view, can navigate by months 1 - years (year view): Select a year from a list of years, can navigate by group of years 2 - months (months view): Select a month from the list of all months, there is no navigation",
        "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": "Array",
        "qname": "dayNames",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An array of strings used to name the days of the week with Sunday being the first element of the array.",
        "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": "Array",
        "qname": "monthNames",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An array of strings used to name the months of the year with January being the first element of the array.",
        "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": "Number",
        "qname": "displayedYear",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The year currently displayed by the DateChooser.",
        "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": "MINIMUM_YEAR",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "field",
        "qname": "MAXIMUM_YEAR",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Number",
        "qname": "navigateYears",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The year currently displayed while navigating in year view",
        "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": "Number",
        "qname": "displayedMonth",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The month currently displayed by the DateChooser.",
        "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": "Number",
        "qname": "firstDayOfWeek",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The index of the first day of the week, Sunday = 0.",
        "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": "NUM_DAYS_VIEW",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "days",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The array of days in date form used in days view the number of days in view comes from NUM_DAYS_VIEW",
        "tags": [
        {  "tagName": "return",
               "values": [""]}  ]},
      { "type": "field",
        "qname": "NUM_YEARS_VIEW",
        "return": "int",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "years",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The array of year in date form used in year view the number of years in view comes from NUM_YEARS_VIEW",
        "tags": [
        {  "tagName": "return",
               "values": [""]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Array",
        "qname": "months",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The array of 12 month in date form used in month view",
        "tags": [
        {  "tagName": "return",
               "values": [""]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Date",
        "qname": "selectedDate",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The currently selected date or null if no date has been selected.",
        "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": "changeYear",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "newYear", "type": "Number"}]}
      ,
      { "type": "method",
        "qname": "changeMonth",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "newMonth", "type": "Number"}]}
      ,
      { "type": "method",
        "qname": "cycleArray",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Cycle days array for offsetting when change firstDayOfWeek",
        "tags": [
        {  "tagName": "param",
               "values": ["array , the array to get a position", "index, the index in the array to use", "offset, the offset to apply, this could be positive or negative"]},
            {  "tagName": "return",
               "values": ["the cycled position"]}  ],
          "return": "Number",
          "params": [{ "name": "array", "type": "Array"},
        { "name": "index", "type": "Number"},
        { "name": "offset", "type": "Number"}]}
      ]
  }