asdoc/org/apache/royale/textLayout/operations/ApplyElementIDOperation.js.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.operations.ApplyElementIDOperation",
  "baseClassname": "org.apache.royale.textLayout.operations.FlowElementOperation"
  ,
    "description": "The ChangeElementIDOperation class encapsulates an element ID change.",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.FlowElement", "org.apache.royale.textLayout.edit.EditManager", "org.apache.royale.textLayout.events.FlowOperationEvent"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.textLayout.operations.ApplyElementIDOperation",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates a ChangeElementIDOperation object.  <p>If the <code>relativeStart</code> or <code>relativeEnd</code> parameters are set, then the existing element is split into two elements, one using the existing ID and the other using the new ID. If both parameters are set, then the existing element is split into three elements. The first and last elements of the set are both assigned the original ID.</p>",
        "tags": [
        {  "tagName": "param",
               "values": ["operationState Specifies the selection state before the operation", "targetElement Specifies the element to change", "newID The ID to assign", "relativeStart An offset from the beginning of the target element.", "relativeEnd An offset from the end of the target element."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "operationState", "type": "org.apache.royale.textLayout.edit.SelectionState"},
        { "name": "targetElement", "type": "org.apache.royale.textLayout.elements.IFlowElement"},
        { "name": "newID", "type": "String"},
        { "name": "relativeStart", "type": "int"},
        { "name": "relativeEnd", "type": "int"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "newID",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The ID assigned by this operation.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }