Packageflashx.textLayout.formats
Interfacepublic interface ICharacterFormat
Implementors CharacterFormat

This interface provides read access to character-related properties.


Public Properties
 PropertyDefined By
  alignmentBaseline : String
[read-only] Specifies the line baseline to which the element baseline specified by the elementBaseline property should align to determine the vertical position of the element on the line.
ICharacterFormat
  baselineShift : Object
[read-only] Amount to shift the baseline from the elementBaseline.
ICharacterFormat
  breakOpportunity : String
[read-only] Controls where lines are allowed to break when wrapping text is broken into multiple lines.
ICharacterFormat
  cffHinting : String
[read-only] The type of CFF hinting used for this text.
ICharacterFormat
  color : Object
[read-only] Color of the text.
ICharacterFormat
  digitCase : String
[read-only] The type of digit case used for this text.
ICharacterFormat
  digitWidth : String
[read-only] Type of digit width used for this text.
ICharacterFormat
  dominantBaseline : String
[read-only] Specifies which of the baselines of the element snaps to the alignmentBaseline to determine the vertical position of the element on the line.
ICharacterFormat
  fontFamily : String
[read-only] The name of the font to use, or a comma-separated list of font names.
ICharacterFormat
  fontLookup : String
[read-only] Font lookup to use.
ICharacterFormat
  fontSize : Object
[read-only] The size of the text in pixels.
ICharacterFormat
  fontStyle : String
[read-only] Style of text.
ICharacterFormat
  fontWeight : String
[read-only] Weight of text.
ICharacterFormat
  kerning : String
[read-only] Kerning adjusts the pixels between certain character pairs to improve readability.
ICharacterFormat
  ligatureLevel : String
[read-only] Controls which of the ligatures that are defined in the font may be used in the text.
ICharacterFormat
  lineHeight : Object
[read-only] Leading controls for the text.
ICharacterFormat
  lineThrough : Object
[read-only] Strikethrough.
ICharacterFormat
  locale : String
[read-only] The locale of the text.
ICharacterFormat
  renderingMode : String
[read-only] The rendering mode used for this text.
ICharacterFormat
  textAlpha : Object
[read-only] Alpha (transparency) value for the text.
ICharacterFormat
  textDecoration : String
[read-only] Decoration on text.
ICharacterFormat
  textRotation : String
[read-only] Determines the amount of degrees to rotate this text.
ICharacterFormat
  trackingLeft : Object
[read-only] Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character.
ICharacterFormat
  trackingRight : Object
[read-only] Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character.
ICharacterFormat
  typographicCase : String
[read-only] The type of typographic case used for this text.
ICharacterFormat
  whiteSpaceCollapse : String
[read-only] The setting used to collapse or preserve whitespace when importing text into a TextFlow.
ICharacterFormat
Property Detail
alignmentBaselineproperty
alignmentBaseline:String  [read-only]

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

Specifies the line baseline to which the element baseline specified by the elementBaseline property should align to determine the vertical position of the element on the line. The largest element in the line generally determines the baselines.

baselines

Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE.

Default value is USE_DOMINANT_BASELINE.

Values may be null indicating not set.



Implementation
    public function get alignmentBaseline():String

See also

flash.text.engine.TextBaseline
baselineShiftproperty 
baselineShift:Object  [read-only]

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

Amount to shift the baseline from the elementBaseline . Units are in pixels, or a percentage of the fontSize (in which case, enter a string value, like 140%). Positive values shift the line down for horizontal text (left for vertical) and negative values shift it up for horizontal (right for vertical).

Legal values are flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are from -1000 to 1000.

Default value is 0.0.

Values may be null indicating not set.



Implementation
    public function get baselineShift():Object

See also

flashx.textLayout.formats.BaselineShift
breakOpportunityproperty 
breakOpportunity:String  [read-only]

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

Controls where lines are allowed to break when wrapping text is broken into multiple lines. AUTOMATIC is for setting text normally. NONE means that the line breaker will not break the text unless there are no other places to break the line and the text would otherwise overrun the measure. ANY allows the line to break anywhere, not just between words. ALL means that each typographic cluster will be put on a separate line (useful for text on a path).

Legal values are flash.text.engine.BreakOpportunity.ALL, flash.text.engine.BreakOpportunity.ANY, flash.text.engine.BreakOpportunity.AUTO, flash.text.engine.BreakOpportunity.NONE.

Default value is AUTO.

Values may be null indicating not set.



Implementation
    public function get breakOpportunity():String

See also

flash.text.engine.BreakOpportunity
cffHintingproperty 
cffHinting:String  [read-only]

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

The type of CFF hinting used for this text. CFF hinting determines whether Flash Player forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode property is set to flash.text.engine.RenderingMode.CFF, and the font is embedded ( fontLookup property is set to flash.text.engine.FontLookup.EMBEDDED_CFF). At small screen sizes, hinting produces a clear, legible text for human readers.

Legal values are flash.text.engine.CFFHinting.NONE, flash.text.engine.CFFHinting.HORIZONTAL_STEM.

Default value is HORIZONTAL_STEM.

Values may be null indicating not set.



Implementation
    public function get cffHinting():String

See also

flash.text.engine.CFFHinting
colorproperty 
color:Object  [read-only]

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

Color of the text. An integer containing three 8-bit RGB components; for example, 0xFF0000 is red and 0x00FF00 is green.

Default value is 0.

Values may be null indicating not set.



Implementation
    public function get color():Object
digitCaseproperty 
digitCase:String  [read-only]

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

The type of digit case used for this text. The OLD_STYLE setting approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The LINING setting has all-cap height and is typically monospaced to line up in charts.

digitCase

Legal values are flash.text.engine.DigitCase.DEFAULT, flash.text.engine.DigitCase.LINING, flash.text.engine.DigitCase.OLD_STYLE.

Default value is DEFAULT.

Values may be null indicating not set.



Implementation
    public function get digitCase():String

See also

flash.text.engine.DigitCase
digitWidthproperty 
digitWidth:String  [read-only]

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

Type of digit width used for this text. This can be PROPORTIONAL, which looks best for individual numbers, or TABULAR, which works best for numbers in tables, charts, and vertical rows.

digitWidth

Legal values are flash.text.engine.DigitWidth.DEFAULT, flash.text.engine.DigitWidth.PROPORTIONAL, flash.text.engine.DigitWidth.TABULAR.

Default value is DEFAULT.

Values may be null indicating not set.



Implementation
    public function get digitWidth():String

See also

flash.text.engine.DigitWidth
dominantBaselineproperty 
dominantBaseline:String  [read-only]

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

Specifies which of the baselines of the element snaps to the alignmentBaseline to determine the vertical position of the element on the line. These baseline choices are determined by the choice of font and the font size.

baselines

Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM.

Default value is ROMAN.

Values may be null indicating not set.



Implementation
    public function get dominantBaseline():String

See also

flash.text.engine.TextBaseline
fontFamilyproperty 
fontFamily:String  [read-only]

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

The name of the font to use, or a comma-separated list of font names. Flash Player renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found.

Default value is Times New Roman.

Values may be null indicating not set.



Implementation
    public function get fontFamily():String
fontLookupproperty 
fontLookup:String  [read-only]

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

Font lookup to use. Specifying a Device font uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying an Embedded_CFF font uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), text is consistently displayed in the chosen font.

Legal values are flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF.

Default value is DEVICE.

Values may be null indicating not set.



Implementation
    public function get fontLookup():String

See also

flash.text.engine.FontLookup
fontSizeproperty 
fontSize:Object  [read-only]

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

The size of the text in pixels.

Legal values are from 1 to 720.

Default value is 12.

Values may be null indicating not set.



Implementation
    public function get fontSize():Object
fontStyleproperty 
fontStyle:String  [read-only]

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

Style of text. May be normal, for use in plain text, or italic. Applies only to device fonts ( fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontPosture.NORMAL, flash.text.engine.FontPosture.ITALIC.

Default value is NORMAL.

Values may be null indicating not set.



Implementation
    public function get fontStyle():String

See also

flash.text.engine.FontPosture
fontWeightproperty 
fontWeight:String  [read-only]

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

Weight of text. May be normal, for use in plain text, or bold. Applies only to device fonts ( fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontWeight.NORMAL, flash.text.engine.FontWeight.BOLD.

Default value is NORMAL.

Values may be null indicating not set.



Implementation
    public function get fontWeight():String

See also

flash.text.engine.FontWeight
kerningproperty 
kerning:String  [read-only]

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

Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.

Legal values are flash.text.engine.Kerning.ON, flash.text.engine.Kerning.OFF, flash.text.engine.Kerning.AUTO.

Default value is ON.

Values may be null indicating not set.



Implementation
    public function get kerning():String

See also

flash.text.engine.Kerning
ligatureLevelproperty 
ligatureLevel:String  [read-only]

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

Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values MINIMUM, COMMON, UNCOMMON, and EXOTIC are additive - each value enables a new set of ligatures, but also includes those of the previous types.

Note: When working with Arabic or Syriac fonts, ligatureLevel must be set to MINIMUM or above.

ligatureLevel

Legal values are flash.text.engine.LigatureLevel.NONE, flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC.

Default value is COMMON.

Values may be null indicating not set.



Implementation
    public function get ligatureLevel():String

See also

flash.text.engine.LigatureLevel
lineHeightproperty 
lineHeight:Object  [read-only]

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

Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingDirection ) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.

lineHeight1 lineHeight2

Legal values as a number are from 0 to 720.

Legal values as a percent are from 0% to 1000%.

Default value is 120%.

Values may be null indicating not set.



Implementation
    public function get lineHeight():Object
lineThroughproperty 
lineThrough:Object  [read-only]

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

Strikethrough. If true, a line is drawn throught the middle of the text.

Legal values are from false to true.

Default value is false.

Values may be null indicating not set.



Implementation
    public function get lineThrough():Object
localeproperty 
locale:String  [read-only]

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

The locale of the text. Controls case transformations and shaping. Standard locale identifiers are used. For example en, en_US and en-US are all English, ja is Japanese.

Default value is en.

Values may be null indicating not set.



Implementation
    public function get locale():String
renderingModeproperty 
renderingMode:String  [read-only]

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

The rendering mode used for this text. Applies only to embedded fonts ( fontLookup property is set to flash.text.engine.FontLookup.EMBEDDED_CFF).

Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF.

Default value is CFF.

Values may be null indicating not set.



Implementation
    public function get renderingMode():String

See also

flash.text.engine.RenderingMode
textAlphaproperty 
textAlpha:Object  [read-only]

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

Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with alpha set to 0 are active, even though they are invisible.

Legal values are from 0 to 1.

Default value is 1.

Values may be null indicating not set.



Implementation
    public function get textAlpha():Object
textDecorationproperty 
textDecoration:String  [read-only]

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

Decoration on text. By default this is none, but underline may be applied.

Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE.

Default value is NONE.

Values may be null indicating not set.



Implementation
    public function get textDecoration():String

See also

flashx.textLayout.formats.TextDecoration
textRotationproperty 
textRotation:String  [read-only]

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

Determines the amount of degrees to rotate this text.

Legal values are flash.text.engine.TextRotation.ROTATE_0, flash.text.engine.TextRotation.ROTATE_180, flash.text.engine.TextRotation.ROTATE_270, flash.text.engine.TextRotation.ROTATE_90, flash.text.engine.TextRotation.AUTO.

Default value is AUTO.

Values may be null indicating not set.



Implementation
    public function get textRotation():String

See also

flash.text.engine.TextRotation
trackingLeftproperty 
trackingLeft:Object  [read-only]

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

Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the trackingLeft value is added to the values in the kerning table for the font. If kerning is disabled, the trackingLeft value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are from -100% to 100%.

Default value is 0.

Values may be null indicating not set.



Implementation
    public function get trackingLeft():Object
trackingRightproperty 
trackingRight:Object  [read-only]

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

Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the trackingRight value is added to the values in the kerning table for the font. If kerning is disabled, the trackingRight value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are from -100% to 100%.

Default value is 0.

Values may be null indicating not set.



Implementation
    public function get trackingRight():Object
typographicCaseproperty 
typographicCase:String  [read-only]

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

The type of typographic case used for this text. Below are some examples:

typographicCase

Legal values are flash.text.engine.TypographicCase.DEFAULT, flash.text.engine.TypographicCase.TITLE, flash.text.engine.TypographicCase.CAPS, flash.text.engine.TypographicCase.SMALL_CAPS, flash.text.engine.TypographicCase.UPPERCASE, flash.text.engine.TypographicCase.LOWERCASE, flash.text.engine.TypographicCase.CAPS_AND_SMALL_CAPS.

Default value is DEFAULT.

Values may be null indicating not set.



Implementation
    public function get typographicCase():String

See also

flash.text.engine.TypographicCase
whiteSpaceCollapseproperty 
whiteSpaceCollapse:String  [read-only]

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

The setting used to collapse or preserve whitespace when importing text into a TextFlow. PRESERVE retains all whitespace characters. When using COLLAPSE, within a block of imported text, newlines, tabs, and leading/trailing spaces will be removed. Line break tags () and Unicode line separator characters are retained.

Legal values are flashx.textLayout.formats.WhiteSpaceCollapse.PRESERVE, flashx.textLayout.formats.WhiteSpaceCollapse.COLLAPSE.

Default value is COLLAPSE.

Values may be null indicating not set.



Implementation
    public function get whiteSpaceCollapse():String

See also

flashx.textLayout.formats.WhiteSpaceCollapse



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Thu Nov 20 2008, 04:03 AM -08:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/textlayout/flashx/textLayout/formats/ICharacterFormat.html