asdoc/org/apache/royale/textLayout/events/UpdateCompleteEvent.js.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.events.UpdateCompleteEvent",
  "baseClassname": "org.apache.royale.events.Event"
  ,
    "description": "A TextFlow instance dispatches this event after any of its containers completes an update. Each text container has two states: composition and display. This event notifies you when the display phase has ended. This provides an opportunity to make any necessary changes to the container when it is ready to be displayed, but hasn't yet been painted to the screen.  using the UpdateCompleteEvent, so I have included it as the class example instead of creating a new example. I've updated the description of the DamageEvent_example file to include prominent mention of the UpdateCompleteEvent.",
  "tags": [
  {  "tagName": "internal",
         "values": ["Note: the DamageEvent_example class contains a good example of"]},
      {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.TextFlow"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "UPDATE_COMPLETE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Defines the value of the <code>type</code> property of an <code>UpdateCompleteEvent</code> object",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "org.apache.royale.textLayout.events.UpdateCompleteEvent",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor This event cannot be cancelled.",
        "tags": [
        {  "tagName": "param",
               "values": ["type event type - use the static property UPDATE_COMPLETE.", "bubbles Indicates whether an event is a bubbling event. This event does not bubble.", "cancelable Indicates whether the behavior associated with the event can be prevented.", "controller The ContainerController whose container was updated", "textFlow The TextFlow which was updated"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "type", "type": "String"},
        { "name": "bubbles", "type": "Boolean"},
        { "name": "cancelable", "type": "Boolean"},
        { "name": "textFlow", "type": "org.apache.royale.textLayout.elements.ITextFlow"},
        { "name": "controller", "type": "org.apache.royale.textLayout.container.IContainerController"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.container.IContainerController",
        "qname": "controller",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The controller of the container being updated",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.elements.ITextFlow",
        "qname": "textFlow",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "TextFlow which has been updated.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }