asdoc/org/apache/royale/textLayout/edit/SelectionFormat.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.edit.SelectionFormat",
  "baseClassname": ""
  ,
    "description": "The SelectionFormat class defines the properties of a selection highlight.",
  "tags": [
  {  "tagName": "see",
         "values": ["org.apache.royale.textLayout.edit.ISelectionManager", "org.apache.royale.textLayout.edit.SelectionManager"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.textLayout.edit.SelectionFormat",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Creates a SelectionFormat object with the specified properties.  <p>A SelectionFormat created with the default values will use black for the highlight colors, 1.0 for the alphas, and BlendMode.DIFFERENCE for the blending modes. The cursor blink rate is 500 milliseconds.</p>  <p>Setting the <code>pointAlpha</code> and <code>rangeAlpha</code> properties to zero disables selection highlighting.</p>  <p>Non-zero blink rate is only used when an EditManager is attached to the TextFlow.</p>  (completely transparent) and 1 (completely opaque, which is the default). to set this parameter. (completely transparent) and 1 (completely opaque, which is the default). to set this parameter.",
        "tags": [
        {  "tagName": "see",
               "values": ["flash.display.BlendMode", "#pointAlpha", "#rangeAlpha"]},
            {  "tagName": "param",
               "values": ["rangeColor The color for drawing the highlight.", "rangeAlpha The transparency value for drawing the highlight. Valid values are between 0", "rangeBlendMode The blend mode for drawing the highlight. Use constants defined in the BlendMode class", "pointColor The color for the drawing cursor.", "pointAlpha The transparency value for drawing the cursor. Valid values are between 0", "pointBlendMode The blend mode for drawing the cursor. Use constants defined in the BlendMode class", "pointBlinkRate The rate at which the cursor blinks, in milliseconds."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": [{ "name": "rangeColor", "type": "uint"},
        { "name": "rangeAlpha", "type": "Number"},
        { "name": "rangeBlendMode", "type": "String"},
        { "name": "pointColor", "type": "uint"},
        { "name": "pointAlpha", "type": "Number"},
        { "name": "pointBlendMode", "type": "String"},
        { "name": "pointBlinkRate", "type": "Number"},
        { "name": "pointBlinkAlpha", "type": "Number"},
        { "name": "pointBlinkColor", "type": "uint"}]}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "uint",
        "qname": "rangeColor",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The color for drawing the highlight of a range selection.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Number",
        "qname": "rangeAlpha",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The alpha for drawing the highlight of a range selection. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).  <p>Setting the <code>pointAlpha</code> and <code>rangeAlpha</code> properties to zero disables selection highlighting.</p>",
        "tags": [
        {  "tagName": "see",
               "values": ["#pointAlpha"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "String",
        "qname": "rangeBlendMode",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The blending mode for drawing the highlight of a range selection.",
        "tags": [
        {  "tagName": "see",
               "values": ["flash.display.BlendMode"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "uint",
        "qname": "pointColor",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The color for drawing the cursor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Number",
        "qname": "pointAlpha",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The alpha for drawing the cursor. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).  <p>Setting the <code>pointAlpha</code> and <code>rangeAlpha</code> properties to zero disables selection highlighting.</p>",
        "tags": [
        {  "tagName": "see",
               "values": ["#rangeAlpha"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Number",
        "qname": "pointBlinkRate",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The rate at which the cursor blinks, in milliseconds.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "Number",
        "qname": "pointBlinkAlpha",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The alpha of the cursor blinks while blinking.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "uint",
        "qname": "pointBlinkColor",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The color of the cursor while blinking.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "String",
        "qname": "pointBlendMode",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The blend mode for drawing the cursor.",
        "tags": [
        {  "tagName": "see",
               "values": ["flash.display.BlendMode"]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "equals",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Determines whether this SelectionFormat object has the same property values as another SelectionFormat object.",
        "tags": [
        {  "tagName": "param",
               "values": ["selectionFormat the SelectionFormat to compare against."]},
            {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "return",
               "values": ["<code>true</code>, if the property values are identical; <code>false</code>, otherwise."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Boolean",
          "params": [{ "name": "selectionFormat", "type": "org.apache.royale.textLayout.edit.SelectionFormat"}]}
      ]
  }