asdoc/org/apache/royale/textLayout/elements/SubParagraphGroupElementBase.js.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.elements.SubParagraphGroupElementBase",
  "baseClassname": "org.apache.royale.textLayout.elements.FlowGroupElement"
  ,
    "description": "The SubParagraphGroupElementBase class groups FlowLeafElements together. A SubParagraphGroupElementBase is a child of a ParagraphElement object and it can contain one or more FlowLeafElement objects as children.",
  "tags": [
  {  "tagName": "see",
         "values": ["FlowLeafElement", "LinkElement", "ParagraphElement", "TCYElement"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.textLayout.elements.SubParagraphGroupElementBase",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor - creates a new SubParagraphGroupElementBase instance.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "uint",
        "qname": "precedence",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Precedence is used to determine which SPGE element will be the container element when two or more SPGEs of the same textLength are inside one another.  Precedence is used to determine which SubParagraphGroupElementBase is the owner when two or more elements have the same text and are embedded within each other.  Note: model permits any order and does not enforce precedence.  This is only a feature used by the EditManager  Example: SPGEs A(precedence 900), B(precedence 400), C(precedence 600) Editing Result when all wrap SpanElement &quot;123&quot;  <A><C><B>123</B></C></A>  If two or more SPGE's have the same precedence value, then the alphabetic order is used: Example: SPGE A(precedence 400), B(precedence 400), C(precedence 600)  <C><A><B>123</B></A></C>  Current values for SubParagraphGroupElementBase are: LinkElement - 800 TCYElement - 100  If the value is not overriden by descendents of SPGE, then value is kMaxSPGEPrecedence;",
        "tags": [
        {  "tagName": "private",
               "values": []},
            {  "tagName": "public",
               "values": ["getter to return the precedence value of this SubParagraphGroupElementBase"]}  ]},
      { "type": "accessor",
        "access": "read-only",
        "return": "org.apache.royale.text.engine.GroupElement",
        "qname": "groupElement",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "@private"},
      { "type": "accessor",
        "access": "read-only",
        "return": "Boolean",
        "qname": "allowNesting",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "@private SubParagraphGroupElement allow deep nesting, but LinkElements and TCYElements do not allow nesting (you can't have a link inside another link no matter how many group elements are in between). This function is called only from within the class hierarchy to find out whether"}]
  }