asdoc/org/apache/royale/textLayout/events/SelectionEvent.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.events.SelectionEvent",
  "baseClassname": "org.apache.royale.events.Event"
  ,
    "description": "A TextFlow instance dispatches a SelectionEvent object when an EditManager or SelectionManager changes or selects a range of text. For example, this event is dispatched not only when a range of text is selected, but also when the selection changes because the user clicks elsewhere in the text flow. Moreover, this event is also dispatched when an EditManager changes the text or text formatting within a range of text.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "SELECTION_CHANGE",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "The SelectionEvent.SELECTION_CHANGE constant defines the value of the type property of the event object for a selection event.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "SELECT_ALL",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {}},
      { "type": "method",
        "qname": "org.apache.royale.textLayout.events.SelectionEvent",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates an event object that contains information about a flow operation. inherited <code>type</code> property. There is only one type of SelectionEvent: <code>SelectionEvent.SELECTION_CHANGE</code>;",
        "tags": [
        {  "tagName": "param",
               "values": ["type  The type of the event. Event listeners can access this information through the", "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.", "range  An object of type ElementRange that describes the range of text selected."]},
            {  "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": "selectionState", "type": "org.apache.royale.textLayout.edit.SelectionState"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "org.apache.royale.textLayout.edit.SelectionState",
        "qname": "selectionState",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "An object of type SelectionState that represents the selected range associated with this SelectionEvent.  <p>You can use this property, along with the ElementRange class, to create an ElementRange instance that represents the range of selected text. You can use the following line of code to create an instance of the ElementRange class that represents the range of selected text (the <code>ev</code> variable represents the event object, and the conditional operator is used to guard against a <code>null</code> value for the <code>selectionState</code> property):</p> <listing> // Find selected element range var range:ElementRange = ev.selectionState ? ElementRange.createElementRange(ev.selectionState.textFlow, ev.selectionState.absoluteStart, ev.selectionState.absoluteEnd) : null;</listing>",
        "tags": [
        {  "tagName": "see",
               "values": ["org.apache.royale.textLayout.edit.ElementRange", "org.apache.royale.textLayout.edit.SelectionState"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }