ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.formats 

LeadingModel  - AS3

Packageflashx.textLayout.formats
Classpublic final class LeadingModel
InheritanceLeadingModel Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Defines values for setting the leadingModel property of the TextLayoutFormat class, composed of valid combinations of leading basis and leading direction. Leading basis describes which baselines determine the leading (or lineHeight) of lines in a paragraph. Leading direction specifies whether the lineHeight property refers to the distance of a line's baseline from that of the line before it or the line after it.

baselines leadingDirection_1 leadingDirection_2 leadingDirection_3

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  APPROXIMATE_TEXT_FIELD : String = "approximateTextField"
[static] Specifies a leading model that approximates the line spacing behavior of TextField.
LeadingModel
  ASCENT_DESCENT_UP : String = "ascentDescentUp"
[static] Specifies that leading basis is ASCENT/DESCENT and leading direction is UP.
LeadingModel
  AUTO : String = "auto"
[static] Specifies that leading model is chosen automatically based on the paragraph's locale property.
LeadingModel
  BOX : String = "box"
[static] Specifies a leading model based on the CSS inline formatting model, which involves stacking line boxes contiguously.
LeadingModel
  IDEOGRAPHIC_CENTER_DOWN : String = "ideographicCenterDown"
[static] Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is down.
LeadingModel
  IDEOGRAPHIC_CENTER_UP : String = "ideographicCenterUp"
[static] Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is UP.
LeadingModel
  IDEOGRAPHIC_TOP_DOWN : String = "ideographicTopDown"
[static] Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is DOWN.
LeadingModel
  IDEOGRAPHIC_TOP_UP : String = "ideographicTopUp"
[static] Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is UP.
LeadingModel
  ROMAN_UP : String = "romanUp"
[static] Specifies that leading basis is ROMAN and leading direction is UP.
LeadingModel
Constant Detail

APPROXIMATE_TEXT_FIELD

Constant
public static const APPROXIMATE_TEXT_FIELD:String = "approximateTextField"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies a leading model that approximates the line spacing behavior of TextField. It is similar to ASCENT_DESCENT_UP in that lineHeight refers to the distance of a line's ascent baseline from the previous line's descent baseline. However, baseline positions approximate those determined by TextField, rather than using metrics offered by TextLine.

ASCENT_DESCENT_UP

Constant 
public static const ASCENT_DESCENT_UP:String = "ascentDescentUp"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is ASCENT/DESCENT and leading direction is UP. In other words, lineHeight refers to the distance of a line's ascent baseline from the previous line's descent baseline.

AUTO

Constant 
public static const AUTO:String = "auto"

Language Version: ActionScript #IDEOGRAPHIC_TOP_DOWN
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading model is chosen automatically based on the paragraph's locale property. For Japanese and Chinese, it is IDEOGRAPHIC_TOP_DOWN and for all others it is ROMAN_UP.

BOX

Constant 
public static const BOX:String = "box"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies a leading model based on the CSS inline formatting model, which involves stacking line boxes contiguously. A line box is defined as the bounding box around inline boxes for all leaf elements on the text line, after they have been aligned using baselineShift, dominantBaseline, alignmentBaseline etc. For a span, the inline box is obtained by applying leading equally above and below the text content such that its height equals lineHeight. For an inline graphic, lineHeight is ignored; the inline box is derived from its specified dimensions and padding values. Also, firstBaselineOffset is ignored with this leading model.

For more information, see Box leading model.

IDEOGRAPHIC_CENTER_DOWN

Constant 
public static const IDEOGRAPHIC_CENTER_DOWN:String = "ideographicCenterDown"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is down. In other words, lineHeight refers to the distance of a line's ideographic center baseline from the next line's ideographic center baseline.

IDEOGRAPHIC_CENTER_UP

Constant 
public static const IDEOGRAPHIC_CENTER_UP:String = "ideographicCenterUp"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is IDEOGRAPHIC_CENTER and leading direction is UP. In other words, lineHeight refers to the distance of a line's ideographic center baseline from the previous line's ideographic center baseline.

IDEOGRAPHIC_TOP_DOWN

Constant 
public static const IDEOGRAPHIC_TOP_DOWN:String = "ideographicTopDown"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is DOWN. In other words, lineHeight refers to the distance of a line's ideographic top baseline from the next line's ideographic top baseline.

IDEOGRAPHIC_TOP_UP

Constant 
public static const IDEOGRAPHIC_TOP_UP:String = "ideographicTopUp"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is IDEOGRAPHIC_TOP and leading direction is UP. In other words, lineHeight refers to the distance of a line's ideographic top baseline from the previous line's ideographic top baseline.

ROMAN_UP

Constant 
public static const ROMAN_UP:String = "romanUp"

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

Specifies that leading basis is ROMAN and leading direction is UP. In other words, lineHeight refers to the distance of a line's Roman baseline from the previous line's Roman baseline.