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

{ "type": "class",
  "qname": "org.apache.royale.textLayout.operations.ApplyElementUserStyleOperation",
  "baseClassname": "org.apache.royale.textLayout.operations.FlowElementOperation"
  ,
    "description": "The ApplyElementUserStyleOperation class encapsulates a change in a style value of an element.",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.elements.FlowElement#userStyles", "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.ApplyElementUserStyleOperation",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates a ApplyElementUserStyleOperation object.  <p>If the <code>relativeStart</code> and <code>relativeEnd</code> parameters are set, then the existing element is split into multiple elements, the selected portion using the new style value and the rest using the existing style value.</p>",
        "tags": [
        {  "tagName": "param",
               "values": ["operationState Describes the range of text to style.", "targetElement Specifies the element to change.", "styleName The name of the style to change.", "value The new style value.", "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": "styleName", "type": "String"},
        { "name": "value", "type": "*"},
        { "name": "relativeStart", "type": "int"},
        { "name": "relativeEnd", "type": "int"}]}
      ,
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "styleName",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The name of the style changed.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "*",
        "qname": "newValue",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The new style value.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }