asdoc/org/apache/royale/binding/WatcherBase.swf.json

{ "type": "class",
  "qname": "org.apache.royale.binding.WatcherBase",
  "baseClassname": ""
  ,
    "description": "The WatcherBase class is the base class for data-binding classes that watch various properties and styles for changes.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]},
      {  "tagName": "royalesuppresspublicvarwarning",
         "values": []}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.binding.WatcherBase",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "field",
        "qname": "listeners",
        "return": "Array",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The binding objects that are listening to this Watcher. The standard event mechanism isn't used because it's too heavyweight.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "children",
        "return": "Array",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Children of this watcher are watching sub values.  For example, if watching {a.b.c} and this watcher is watching "b", then it is the watchers watching "c" and "d" if there is an {a.b.d} being watched.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "value",
        "return": "Object",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The value of whatever it is we are watching.  For example, if watching {a.b.c} and this watcher is watching "b", then it is the value of "a.b".",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "parentChanged",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "This is an abstract method that subclasses implement.  Implementations handle changes in the parent chain.  For example, if watching {a.b.c} and this watcher is watching "b", then handle "a" changing.",
        "tags": [
        {  "tagName": "param",
               "values": ["parent The new parent."]},
            {  "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": "method",
        "qname": "addChild",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Add a child to this watcher, meaning that the child is watching a sub value of ours.  For example, if watching {a.b.c} and this watcher is watching "b", then this method is called to add the watcher watching "c".",
        "tags": [
        {  "tagName": "param",
               "values": ["child The new child"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "child", "type": "org.apache.royale.binding.WatcherBase"}]}
      ,
      { "type": "method",
        "qname": "addBinding",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Add a binding to this watcher, meaning that the binding is notified when our value changes.  Bindings are classes that actually perform the change based on changes detected to this portion of the chain.",
        "tags": [
        {  "tagName": "param",
               "values": ["binding The new binding."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "binding", "type": "org.apache.royale.binding.GenericBinding"}]}
      ,
      { "type": "method",
        "qname": "updateChildren",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "This method is called when the value might have changed and goes through and makes sure the children are updated.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": []}
      ,
      { "type": "method",
        "qname": "wrapUpdate",
        "namespace": "protected",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Calls a function inside a try catch block to try to update the value.",
        "tags": [
        {  "tagName": "param",
               "values": ["wrappedFunction The function to call."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": [{ "name": "wrappedFunction", "type": "Function"}]}
      ,
      { "type": "field",
        "qname": "allowedErrors",
        "return": "Array",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Certain errors are normal when executing an update, so we swallow them. Feel free to add more errors if needed.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "allowedErrorTypes",
        "return": "Array",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Certain errors classes are normal when executing an update, so we swallow all errors they represent.  Feel free to add more errors if needed.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "notifyListeners",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Notify the various bindings that the value has changed so they can update their data binding expressions.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10.2", "AIR 2.6"]},
            {  "tagName": "productversion",
               "values": ["Royale 0.0"]},
            {  "tagName": "royaleignorecoercion",
               "values": ["org.apache.royale.binding.GenericBinding"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "void",
          "params": []}
      ]
  }