flash.text.engine

# TextBaseline - AS3

Package | flash.text.engine
Class | public final class TextBaseline
Inheritance | TextBaseline Object

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

The TextBaseline class is an enumeration of constant values to use in setting the `dominantBaseline` and `alignmentBaseline` properties of the ElementFormat class. You can also use it in the `baselineZero` property of the TextBlock class. Consider this situation:

The line consists of four `TextElement` objects, containing 'a', 'b', 'cccccccc', and 'X' respectively. The element containing 'X' determines the line baselines because it is the largest element in the line. The roman baseline of the 'X' element is aligned with the roman baseline of the line. The ideographic top of the 'a' element is aligned with the ideographic top of the line. The ideographic bottom of the 'b' element is aligned with the ideographic bottom of the line. The ideographic center of the 'cccccccc' element is aligned with the ideographic center of the line.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ASCENT : String = "ascent" [static] Specifies an ascent baseline. | TextBaseline
|  | DESCENT : String = "descent" [static] Specifies a descent baseline. | TextBaseline
|  | IDEOGRAPHIC_BOTTOM : String = "ideographicBottom" [static] Specifies an ideographic bottom baseline. | TextBaseline
|  | IDEOGRAPHIC_CENTER : String = "ideographicCenter" [static] Specifies an ideographic center baseline. | TextBaseline
|  | IDEOGRAPHIC_TOP : String = "ideographicTop" [static] Specifies an ideographic top baseline. | TextBaseline
|  | ROMAN : String = "roman" [static] Specifies a roman baseline. | TextBaseline
|  | USE_DOMINANT_BASELINE : String = "useDominantBaseline" [static] Specifies that the alignmentBaseline is the same as the dominantBaseline. | TextBaseline

Constant Detail

### ASCENT

Constant

`public static const ASCENT:String = "ascent"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies an ascent baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text engine uses the geometric top of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### DESCENT

Constant

`public static const DESCENT:String = "descent"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies a descent baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text element uses the geometric bottom of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### IDEOGRAPHIC_BOTTOM

Constant

`public static const IDEOGRAPHIC_BOTTOM:String = "ideographicBottom"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies an ideographic bottom baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text engine uses the geometric bottom of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### IDEOGRAPHIC_CENTER

Constant

`public static const IDEOGRAPHIC_CENTER:String = "ideographicCenter"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies an ideographic center baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text engine uses the geometric center of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### IDEOGRAPHIC_TOP

Constant

`public static const IDEOGRAPHIC_TOP:String = "ideographicTop"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies an ideographic top baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text engine uses the geometric top of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### ROMAN

Constant

`public static const ROMAN:String = "roman"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies a roman baseline. For a text element, the font and point size of the text determine this value. For a graphic element, the text engine uses the geometric bottom of the element.

Related API Elements

ElementFormat.dominantBaseline
ElementFormat.alignmentBaseline
TextBlock.baselineZero

### USE_DOMINANT_BASELINE

Constant

`public static const USE_DOMINANT_BASELINE:String = "useDominantBaseline"`

Language Version: | ActionScript 3.0

Runtime Versions: | Flash Player 10, AIR 1.5, Flash Lite 4

Specifies that the alignmentBaseline is the same as the dominantBaseline. Use this value only to set `ElementFormat.alignmentBaseline`.

Related API Elements

ElementFormat.alignmentBaseline

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00