asdoc/org/apache/royale/textLayout/formats/LeadingModel.swf.json

{ "type": "class",
  "qname": "org.apache.royale.textLayout.formats.LeadingModel",
  "baseClassname": ""
  ,
    "description": "Defines values for setting the <code>leadingModel</code> property of the <code>TextLayoutFormat</code> class, composed of valid combinations of leading basis and leading direction. Leading basis describes which baselines determine the leading (or <code>lineHeight</code>) of lines in a paragraph. Leading direction specifies whether the <code>lineHeight</code> property refers to the distance of a line's baseline from that of the line before it or the line after it. <p> <img src=&quot;../../../images/textLayout_baselines.jpg&quot; alt=&quot;baselines&quot; border=&quot;0&quot;/> <img src=&quot;../../../images/textLayout_LD1.jpg&quot; alt=&quot;leadingDirection_1&quot; border=&quot;0&quot;/> <img src=&quot;../../../images/textLayout_LD2.jpg&quot; alt=&quot;leadingDirection_2&quot; border=&quot;0&quot;/> <img src=&quot;../../../images/textLayout_LD3.jpg&quot; alt=&quot;leadingDirection_3&quot; border=&quot;0&quot;/> </p>",
  "tags": [
  {  "tagName": "see",
         "values": ["TextLayoutFormat#leadingModel", "TextLayoutFormat#lineHeight", "flash.text.TextField", "org.apache.royale.text.engine.TextLine"]},
      {  "tagName": "playerversion",
         "values": ["Flash 10", "AIR 1.5"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "ROMAN_UP",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is ROMAN and leading direction is UP. In other words, <code>lineHeight</code> refers to the distance of a line's Roman baseline from the previous line's Roman baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "IDEOGRAPHIC_TOP_UP",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is UP. In other words, <code>lineHeight</code> refers to the distance of a line's ideographic top baseline from the previous line's ideographic top baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "IDEOGRAPHIC_CENTER_UP",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is UP. In other words, <code>lineHeight</code> refers to the distance of a line's ideographic center baseline from the previous line's ideographic center baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "IDEOGRAPHIC_TOP_DOWN",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is DOWN. In other words, <code>lineHeight</code> refers to the distance of a line's ideographic top baseline from the next line's ideographic top baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "IDEOGRAPHIC_CENTER_DOWN",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is down. In other words, <code>lineHeight</code> refers to the distance of a line's ideographic center baseline from the next line's ideographic center baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "ASCENT_DESCENT_UP",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading basis is ASCENT/DESCENT and leading direction is UP. In other words, <code>lineHeight</code> refers to the distance of a line's ascent baseline from the previous line's descent baseline.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "AUTO",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies that leading model is chosen automatically based on the paragraph's <code>locale</code> property. For Japanese and Chinese, it is IDEOGRAPHIC_TOP_DOWN and for all others it is ROMAN_UP.   #IDEOGRAPHIC_TOP_DOWN #ROMAN_UP",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "APPROXIMATE_TEXT_FIELD",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies a leading model that approximates the line spacing behavior of <code>TextField</code>. It is similar to <code>ASCENT_DESCENT_UP</code> in that <code>lineHeight</code> refers to the distance of a line's ascent baseline from the previous line's descent baseline. However, baseline positions approximate those determined by <code>TextField</code>, rather than using metrics offered by <code>TextLine</code>.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "BOX",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Specifies a leading model based on the CSS inline formatting model, which involves stacking <i>line boxes</i> contiguously. A <i>line box</i> is defined as the bounding box around <i>inline boxes</i> for all leaf elements on the text line, after they have been aligned using <code>baselineShift</code>, <code>dominantBaseline</code>, <code>alignmentBaseline</code> etc. For a span, the <i>inline box</i> is obtained by applying leading equally above and below the text content such that its height equals <code>lineHeight</code>. For an inline graphic, <code>lineHeight</code> is ignored; the <i>inline box</i> is derived from its specified dimensions and padding values. Also, <code>firstBaselineOffset</code> is ignored with this leading model.  <p>For more information, see <a href='http://blogs.adobe.com/tlf/2010/11/box-leading-model.html'>Box leading model</a>.</p>",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 10", "AIR 1.5"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]}]
  }