| 包 | flash.text.engine |
| 类 | public final class ElementFormat |
| 继承 | ElementFormat  Object |
| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
应用于 TextBlock 中的 ContentElement 的 ElementFormat 对象不会使 TextBlock 无效。将 ElementFormat 应用于 ContentElement 后，将其 locked 属性设置为 true。无法更改已锁定 ElementFormat 对象的属性。相反，可以使用 clone() 方法创建此对象的没有锁定的副本，可以对此副本进行修改并将其分配给 ContentElement。
相关 API 元素
公共属性
隐藏继承的公共属性
显示继承的公共属性| 属性 | 由以下参数定义 | ||
|---|---|---|---|
| alignmentBaseline : String
指定包含元素中的基线类型，具有此格式的元素的主要基线将与此基线对齐。 | ElementFormat | ||
| alpha : Number
指定受此对象影响的行元素的透明效果。 | ElementFormat | ||
| baselineShift : Number
表示元素的基线偏移，以像素为单位。 | ElementFormat | ||
| breakOpportunity : String
应用于此文本的换行。 | ElementFormat | ||
| color : uint
表示文本的颜色。 | ElementFormat | ||
 | constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| digitCase : String
用于此文本的数字大小写。 | ElementFormat | ||
| digitWidth : String
用于此文本的数字宽度。 | ElementFormat | ||
| dominantBaseline : String
指定用作主要基线的基线类型。 | ElementFormat | ||
| fontDescription : FontDescription
其属性说明字体的对象。 | ElementFormat | ||
| fontSize : Number
文本的大小，以像素为单位。 | ElementFormat | ||
| kerning : String
字距调整可调整某些字符对之间的像素以提高可读性。 | ElementFormat | ||
| ligatureLevel : String
用于此文本的连字级别。 | ElementFormat | ||
| locale : String
文本的区域设置。 | ElementFormat | ||
| locked : Boolean
表示 ElementFormat 是否已锁定。 | ElementFormat | ||
| textRotation : String
设置应用于各个字型的旋转。 | ElementFormat | ||
| trackingLeft : Number
应用到每个字型左侧的间距或手动字距调整（以像素为单位）。 | ElementFormat | ||
| trackingRight : Number
应用到每个字型右侧的间距或手动字距调整（以像素为单位）。 | ElementFormat | ||
| typographicCase : String
用于此文本的印刷大小写。 | ElementFormat | ||
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")
创建 ElementFormat 对象。 | ElementFormat | ||
构造 ElementFormat 的没有锁定的克隆副本。 | ElementFormat | ||
返回一个 FontMetrics 对象，该对象的属性说明由 fontDescription 和 fontSize 指定的字体的全角字框、删除线位置、删除线粗细、下划线位置和下划线粗线。
| ElementFormat | ||
|
表示对象是否已经定义了指定的属性。 | Object | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
设置循环操作动态属性的可用性。 | Object | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
|
返回指定对象的字符串表示形式。 | Object | |
|
返回指定对象的原始值。 | Object | |
属性详细信息
alignmentBaseline | 属性 |
alignmentBaseline:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
指定包含元素中的基线类型，具有此格式的元素的主要基线将与此基线对齐。对此属性使用 TextBaseline 常量。
行中的最大垂直元素确定基线的对齐方式，除非将 TextBlock.baselineFontDescription 和 TextBlock.baselineFontSize 设置为覆盖该逻辑。
默认值为 TextBaseline.USE_DOMINANT_BASELINE。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
TextBaseline.ROMAN | dominantBaseline 与该行的罗马字基线对齐。 |
TextBaseline.ASCENT | dominantBaseline 与该行的上缘基线对齐。 |
TextBaseline.DESCENT | dominantBaseline 与该行的下缘基线对齐。 |
TextBaseline.IDEOGRAPHIC_TOP | dominantBaseline 与该行的表意顶部基线对齐。 |
TextBaseline.IDEOGRAPHIC_CENTER | dominantBaseline 与该行的表意中心基线对齐。 |
TextBaseline.IDEOGRAPHIC_BOTTOM | dominantBaseline 与该行的表意底部基线对齐。 |
TextBaseline.USE_DOMINANT_BASELINE | dominantBaseline 与该行的同一基线对齐。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 设置图形元素的 dominantBaseline 所对齐的行的对齐基线。 |
GroupElement | 没有任何效果。 |
TextElement | 设置文本元素的 dominantBaseline 所对齐的行的对齐基线。 |
实现
public function get alignmentBaseline():String public function set alignmentBaseline(value:String):void引发
ArgumentError — 如果设置的值不是 TextBaseline 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
alpha | 属性 |
alpha:Number| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
指定受此对象影响的行元素的透明效果。有效值范围介于 0（完全透明）到 1（完全不透明）之间。alpha 设置为 0 的显示对象是活动的，即使它们不可见。
默认值为 1。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 对图形元素应用指定的 Alpha。与在图形的 DisplayObject 本身或在 TextLine 上设置的任何 Alpha 进行乘法合并。 |
GroupElement | 没有任何效果。 |
TextElement | 对文本元素应用指定的 Alpha。与在 TextLine 上设置的任何 Alpha 进行乘法合并。 |
实现
public function get alpha():Number public function set alpha(value:Number):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
baselineShift | 属性 |
baselineShift:Number| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
表示元素的基线偏移，以像素为单位。
元素将按照这个量偏离 dominantBaseline。此偏移量将加到元素成员的 y 位置中，因此在非旋转的文本中，正基线偏移会向下移动元素，负基线偏移会向上移动元素。
默认值为 0.0，表示不偏移。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 将图形偏离基线。 |
GroupElement | 没有任何效果。 |
TextElement | 将文本偏离基线。 |
实现
public function get baselineShift():Number public function set baselineShift(value:Number):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
breakOpportunity | 属性 |
breakOpportunity:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
应用于此文本的换行。此属性确定在将换行文本分为多行时可用于断行的字符。将 BreakOpportunity 常量用于此属性。
默认值为 BreakOpportunity.AUTO。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
BreakOpportunity.AUTO | 换行基于标准的 Unicode 字符属性，如在文字间以及在连字符处换行。 |
BreakOpportunity.ANY | ContentElement 对象中的任何字符均可换行。此值通常用于亚洲文字中嵌入罗马文字并需要在文字的中间换行的场合。 |
BreakOpportunity.NONE | 范围内的任何字符均不可进行换行。 |
BreakOpportunity.ALL | 范围内的所有字符均可换行，表示换行符将出现在各个字符的后面。可用于创建路径文本这样的效果。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 确定组中相邻文本元素间的换行。如果组的 elementFormat 为 null，则使用相邻元素中第一个元素的格式。 |
TextElement | 确定文本元素中字符间的换行。 |
实现
public function get breakOpportunity():String public function set breakOpportunity(value:String):void引发
ArgumentError — 如果设置的值不是 BreakOpportunity 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
color | 属性 |
color:uint| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
表示文本的颜色。一个包含三个 8 位 RGB 分量的整数；例如，0xFF0000 为红色，0x00FF00 为绿色。
默认值为 0x000000，黑色。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 设置文本的颜色。 |
实现
public function get color():uint public function set color(value:uint):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
digitCase | 属性 |
digitCase:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
用于此文本的数字大小写。数字大小写会影响数字字符组的样式和位置。将 DigitCase 常量用于此属性。
默认值为 DigitCase.DEFAULT。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
DigitCase.DEFAULT | 对文本应用默认数字大小写。 |
DigitCase.LINING | 对文本应用全高数字大小写。 |
DigitCase.OLD_STYLE | 对文本应用旧样式数字大小写。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定用于元素中的文本的数字大小写。 |
实现
public function get digitCase():String public function set digitCase(value:String):void引发
ArgumentError — 如果设置的值不是 DigitCase 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
digitWidth | 属性 |
digitWidth:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
用于此文本的数字宽度。将 DigitWidth 常量用于此属性。
默认值为 DigitWidth.DEFAULT。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
DigitWidth.DEFAULT | 对文本应用默认数字宽度。 |
DigitWidth.PROPORTIONAL | 对文本应用变宽数字宽度。 |
DigitWidth.TABULAR | 对文本应用定宽数字宽度。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定用于元素中的文本的数字宽度。 |
实现
public function get digitWidth():String public function set digitWidth(value:String):void引发
ArgumentError — 如果设置的值不是 DigitWidth 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
dominantBaseline | 属性 |
dominantBaseline:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
指定用作主要基线的基线类型。将主要基线与对齐基线对齐以确定元素在行中的垂直位置。对此属性使用 TextBaseline 常量。
元素的内容将确定基线。对于 TextElement，字体和点值将确定基线。对于 GraphicElement，元素的高度将确定基线。
默认值为 TextBaseline.ROMAN。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
TextBaseline.ROMAN | 元素的罗马字基线将与 alignmentBaseline 对齐。 |
TextBaseline.ASCENT | 元素的上缘基线将与 alignmentBaseline 对齐。 |
TextBaseline.DESCENT | 元素的下缘基线将与 alignmentBaseline 对齐。 |
TextBaseline.IDEOGRAPHIC_TOP | 元素的表意顶部基线将与 alignmentBaseline 对齐。 |
TextBaseline.IDEOGRAPHIC_CENTER | 元素的表意中心基线将与 alignmentBaseline 对齐。 |
TextBaseline.IDEOGRAPHIC_BOTTOM | 元素的表意底部基线将与 alignmentBaseline 对齐。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 确定图形元素的哪些基线将与 alignmentBaseline 对齐。 |
GroupElement | 没有任何效果。 |
TextElement | 确定文本元素的哪些基线将与 alignmentBaseline 对齐。 |
实现
public function get dominantBaseline():String public function set dominantBaseline(value:String):void引发
ArgumentError — 如果设置的值不是 TextBaseline 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
fontDescription | 属性 |
fontDescription:FontDescription| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
其属性说明字体的对象。
默认值为默认构造的 FontDescription 对象。
如果设置了 fontDescription 属性，提供的 FontDescription 对象已锁定，则 locked 属性将设置为 true。无法修改已锁定 FontDescription。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定用于元素中的文本的字体。 |
实现
public function get fontDescription():FontDescription public function set fontDescription(value:FontDescription):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
fontSize | 属性 |
fontSize:Number| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
文本的大小，以像素为单位。
默认值为 12.0。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定元素中的文本的大小（以像素为单位）。 |
实现
public function get fontSize():Number public function set fontSize(value:Number):void引发
ArgumentError — 如果设置为小于零的值。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
kerning | 属性 |
kerning:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
字距调整可调整某些字符对之间的像素以提高可读性。具有字距微调表的所有字体都支持字距调整。
默认值为 Kerning.ON。
要设置该属性的值，请使用 Kerning 类中的下列常量：
| 字符串值 | 说明 |
|---|---|
Kerning.ON | 启用字距调整。 |
Kerning.OFF | 禁用字距调整。 |
Kerning.AUTO | 除不适合采用中文版式的字符外均已启用字距调整。如果两个字符都不是日文汉字、平假名或片假名，则在这两个字符之间应用字距调整。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 确定是否在组中的相邻文本元素间应用字距调整。如果组的 elementFormat 为 null，则使用相邻元素中第一个元素的格式。 |
TextElement | 确定是否在文本元素中的字符间应用字距调整。 |
实现
public function get kerning():String public function set kerning(value:String):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
ligatureLevel | 属性 |
ligatureLevel:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
用于此文本的连字级别。由两个或两个以上的字母结合在一起形成单个字型时就是连字。连字通常用于替换一些共享公共部分的连续字符，例如字母对“fi”、“fl”或“ae”。在拉丁语字符集和非拉丁语字符集中均可使用连字。将 LigatureLevel 常量用于此属性。
默认值为 LigatureLevel.COMMON。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
LigatureLevel.NONE | 不创建任何连字。 |
LigatureLevel.MINIMUM | 创建最少的连字。 |
LigatureLevel.COMMON | 创建常见连字。 |
LigatureLevel.UNCOMMON | 创建不常见连字。 |
LigatureLevel.EXOTIC | 创建外来语连字。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 确定组中相邻文本元素间的连字级别。如果组的 elementFormat 为 null，则使用相邻元素中第一个元素的格式。 |
TextElement | 确定文本元素中字符间的连字级别。 |
实现
public function get ligatureLevel():String public function set ligatureLevel(value:String):void引发
ArgumentError — 如果设置的值不是 LigatureLevel 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
locale | 属性 |
locale:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
文本的区域设置。控制大小写转换和形状。使用标准区域设置标识符。例如，"en"、"en_US" 和 "en-US" 均表示英语，"ja" 表示日语。有关区域设置代码列表的信息，请参阅 iso639-2 code list。
默认值为 "en"。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定元素中文本的转换和形状。 |
实现
public function get locale():String public function set locale(value:String):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
locked | 属性 |
locked:Boolean| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5., Flash Lite 4 |
表示 ElementFormat 是否已锁定。如果为 true，将无法修改 ElementFormat。调用 ElementFormat.clone() 获取 ElementFormat 对象的没有锁定的副本。
实现
public function get locked():Boolean public function set locked(value:Boolean):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
textRotation | 属性 |
textRotation:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
设置应用于各个字型的旋转。将 TextRotation 类中定义的常量用于此属性。
默认值为 TextRotation.AUTO。
任何字型的最终旋转均为 ElementFormat.textRotation、ContentElement.textRotation 与 TextBlock.lineRotation 之和。
您通常将此属性用于亚洲文字，在其中必须旋转字符才能在垂直布局中正确显示。将 TextRotation.AUTO 与 TextBlock.lineRotation = TextRotation.ROTATE_90 结合使用以实现该目的。
对不包含垂直布局信息的字体设置此属性可能会产生不良结果。包含 vmtx 或 VORG 表的字体（例如，日文字体、“MS Mincho”）能够正常工作，因为这些表提供布局引擎显示正确布局所需的数据。而未包含必要信息的字体（例如 Verdana）则不能正常工作。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
TextRotation.ROTATE_0 | 不旋转字型。 |
TextRotation.ROTATE_90 | 将字型顺时针旋转 90 度。 |
TextRotation.ROTATE_180 | 将字型旋转 180 度。 |
TextRotation.ROTATE_270 | 将字型顺时针旋转 270 度。 |
TextRotation.AUTO | 指定仅将全角和宽字型沿逆时针方向旋转 90 度，这是由字型的 Unicode 属性确定的。此值通常与亚洲文字一起使用，以便仅旋转那些需要旋转的字型。此旋转仅应用在垂直文本中，以将全角字符和宽字符返回到垂直方向，而不会影响其他的字符。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定文本元素中字型的旋转。 |
实现
public function get textRotation():String public function set textRotation(value:String):void引发
ArgumentError — 如果设置的值不是 TextRotation 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
trackingLeft | 属性 |
trackingLeft:Number| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5., Flash Lite 4 |
应用到每个字型左侧的间距或手动字距调整（以像素为单位）。如果启用 kerning，则会将 trackingLeft 值与字体字距微调表中的值相加。如果禁用 kerning，则使用 trackingLeft 值作为手动字距调整值。同时支持正值和负值。
通常，在 trackingRight 与 trackingLeft 之间拆分所需的间距值。否则，在混合方向文本中，一个双向边界处间距加倍，而另一个双向边界处不存在间距。
默认值为 0.0。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 确定应用到图形左侧的间距。 |
GroupElement | 没有任何效果。 |
TextElement | 确定应用到文本元素中字符左侧的间距。 |
示例：
//positive tracking added to kerning
var ef1:ElementFormat = new ElementFormat();
ef1.kerning = flash.text.engine.Kerning.ON;
ef1.trackingLeft = 0.5;
//negative manual kerning
var ef2:ElementFormat = new ElementFormat();
ef2.kerning = flash.text.engine.Kerning.OFF;
ef2.trackingLeft = -1.0;
实现
public function get trackingLeft():Number public function set trackingLeft(value:Number):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
trackingRight | 属性 |
trackingRight:Number| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5., Flash Lite 4 |
应用到每个字型右侧的间距或手动字距调整（以像素为单位）。如果启用 kerning，则会将 trackingRight 值与字体字距微调表中的值相加。如果禁用 kerning，则使用 trackingRight 值作为手动字距调整值。同时支持正值和负值。
通常，在 trackingRight 与 trackingLeft 之间拆分所需的间距值。否则，在混合方向文本中，一个双向边界处间距加倍，而另一个双向边界处不存在间距。
默认值为 0.0。
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 确定应用到图形右侧的间距。 |
GroupElement | 没有任何效果。 |
TextElement | 确定应用到文本元素中字符右侧的间距。 |
示例：
//positive tracking added to kerning
var ef1:ElementFormat = new ElementFormat();
ef1.kerning = flash.text.engine.Kerning.ON;
ef1.trackingRight = 0.5;
//negative manual kerning
var ef2:ElementFormat = new ElementFormat();
ef2.kerning = flash.text.engine.Kerning.OFF;
ef2.trackingRight = -1.0;
实现
public function get trackingRight():Number public function set trackingRight(value:Number):void引发
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
typographicCase | 属性 |
typographicCase:String| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
用于此文本的印刷大小写。将 TypographicCase 类中定义的常量用于此属性。
默认值为 TypographicCase.DEFAULT。
要设置此属性的值，请使用下列字符串值：
| 字符串值 | 说明 |
|---|---|
TypographicCase.DEFAULT | 指定正常大小写用于所有字符。 |
TypographicCase.TITLE | 指定大写字符在输出时使用标题字型。 |
TypographicCase.CAPS | 指定在输出时调整大写字符的间距。 |
TypographicCase.SMALL_CAPS | 指定大写字符在输出时使用小型大写字母字型。 |
TypographicCase.UPPERCASE | 指定所有字符在输出时都使用大写字型。 |
TypographicCase.LOWERCASE | 指定所有字符在输出时都使用小写字型。 |
TypographicCase.CAPS_AND_SMALL_CAPS | 指定所有小写字符在输出时都使用小型大写字母字型。 |
| 子类 | 设置属性的效果 |
|---|---|
GraphicElement | 没有任何效果。 |
GroupElement | 没有任何效果。 |
TextElement | 确定用于元素中的文本的印刷大小写。 |
实现
public function get typographicCase():String public function set typographicCase(value:String):void引发
ArgumentError — 如果设置的值不是 TypographicCase 的成员。
| |
IllegalOperationError — 如果在锁定 ElementFormat 对象（locked 为 true）之后进行设置。
|
相关 API 元素
构造函数详细信息
ElementFormat | () | 构造函数 |
public function ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
创建 ElementFormat 对象。
参数fontDescription:FontDescription (default = null)null。如果未提供字体说明，则构造默认字体说明。
| |
fontSize:Number (default = 12.0) | |
color:uint (default = 0x000000) | |
alpha:Number (default = 1.0)alpha 属性。
| |
textRotation:String (default = "auto") | |
dominantBaseline:String (default = "roman") | |
alignmentBaseline:String (default = "useDominantBaseline") | |
baselineShift:Number (default = 0.0) | |
kerning:String (default = "on") | |
trackingRight:Number (default = 0.0) | |
trackingLeft:Number (default = 0.0) | |
locale:String (default = "en") | |
breakOpportunity:String (default = "auto") | |
digitCase:String (default = "default") | |
digitWidth:String (default = "default") | |
ligatureLevel:String (default = "common") | |
typographicCase:String (default = "default") |
引发
ArgumentError — 指定的 fontSize 小于 0。
| |
ArgumentError — 指定的 textRotation 不是 TextRotation 的成员。
| |
ArgumentError — 指定的 dominantBaseline 不是 TextBaseline 的成员。
| |
ArgumentError — 指定的 alignmentBaseline 不是 TextBaseline 的成员。
| |
ArgumentError — 指定的 kerning 不是 Kerning 的成员。
| |
ArgumentError — 指定的 breakOpportunity 不是 BreakOpportunity 的成员。
| |
ArgumentError — 指定的 digitCase 不是 DigitCase 的成员。
| |
ArgumentError — 指定的 digitWidth 不是 DigitWidth 的成员。
| |
ArgumentError — 指定的 ligatureLevel 不是 LigatureLevel 的成员。
| |
ArgumentError — 指定的 typographicCase 不是 TypographicCase 的成员。
|
方法详细信息
clone | () | 方法 |
public function clone():ElementFormat| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
构造 ElementFormat 的没有锁定的克隆副本。
返回ElementFormat — ElementFormat 对象的没有锁定的副本。
|
示例 ( 如何使用本示例 )
此示例创建了一个 ElementFormat 对象并设置了 FontSize。使用 ElementFormat 创建新的 TextElement（因此锁定它），并将 TextElement 用作 TextBlock 的内容。从 TextBlock 创建的文本行。
要修改 ElementFormat 对象，请首先检查其 locked 属性。如果为 true，则使用 clone() 方法创建 ElementFormat 的没有锁定的副本，更改其属性，然后将此新的 ElementFormat 重新链接到 TextBlock。重新断开这些行后，新行将具有新的字体设置。
package {
import flash.display.Sprite;
import flash.text.engine.*;
public class ElementFormat_cloneExample extends Sprite {
private var ef1:ElementFormat;
private var ef2:ElementFormat;
public function ElementFormat_cloneExample():void {
var fd:FontDescription = new FontDescription();
fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
fd.fontName = "Palatino";
var ef1:ElementFormat = new ElementFormat(fd);
ef1.fontSize=20;
var str:String = "This is flash text 0123456789";
var tb:TextBlock = new TextBlock();
var te1:TextElement = new TextElement(str, ef1);
tb.content = te1;
var line1:TextLine = tb.createTextLine(null, 600);
addChild(line1);
ef2 = (ef1.locked) ? ef1.clone() : ef1;
ef2.fontSize = 32;
tb.content.elementFormat=ef2;
var line2:TextLine = tb.createTextLine(null, 600);
addChild(line2);
}
}
}
getFontMetrics | () | 方法 |
public function getFontMetrics():FontMetrics| 语言版本: | ActionScript 3.0 |
| 运行时版本: | Flash Player 10, AIR 1.5, Flash Lite 4 |
返回一个 FontMetrics 对象，该对象的属性说明由 fontDescription 和 fontSize 指定的字体的全角字框、删除线位置、删除线粗细、下划线位置和下划线粗线。
FontMetrics — 说明由 fontDescription 指定的字体的属性的 FontMetrics 对象。
|
相关 API 元素
示例 ( 如何使用本示例 )
此示例创建了一个具有指定的
FontDescription 的 ElementFormat 对象，并使用 getFontMetrics 方法显示 24 点的所选字体的度量。
package {
import flash.display.Sprite;
import flash.text.engine.*;
public class FontMetricsExample extends Sprite {
public function FontMetricsExample():void {
var fd:FontDescription = new FontDescription();
fd.fontName = "Garamond";
fd.fontWeight = flash.text.engine.FontWeight.BOLD;
var ef1:ElementFormat = new ElementFormat(fd);
ef1.fontSize = 24;
var fm1:FontMetrics = ef1.getFontMetrics();
trace(fm1.emBox);
trace(fm1.strikethroughOffset);
trace(fm1.strikethroughThickness);
trace(fm1.subscriptScale);
trace(fm1.subscriptOffset);
trace(fm1.superscriptScale);
trace(fm1.superscriptOffset);
trace(fm1.underlineOffset);
trace(fm1.underlineThickness);
}
}
}
示例 如何使用本示例
ElementFormatExample.as
此示例创建了两个 ElementFormat 对象并设置了它们的一些属性。然后，该示例将新的 ElementFormat 分配给 TextElement 对象，该对象已经被指定为 TextBlock 的内容。请注意，更改 TextElement 的 ElementFormat 不会影响父 TextBlock 以前创建的 TextLine。
package {
import flash.display.Sprite;
import flash.text.engine.*;
public class ElementFormatExample extends Sprite {
public function ElementFormatExample():void {
var fd:FontDescription = new FontDescription();
fd.fontName = "Garamond";
fd.fontWeight = flash.text.engine.FontWeight.BOLD;
var ef1:ElementFormat = new ElementFormat(fd);
ef1.fontSize = 30;
ef1.color = 0xFF0000;
ef1.alpha = 100;
ef1.kerning = flash.text.engine.Kerning.ON;
ef1.trackingRight = 2;
ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE;
ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT;
ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC;
var ef2:ElementFormat = new ElementFormat(fd);
ef2.fontSize = 30;
ef2.color = 0xFF0000;
ef2.alpha = 0.3;
ef2.kerning = flash.text.engine.Kerning.OFF;
ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE;
ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE;
ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180;
var str:String = "This is flash text 0123456789";
var tb:TextBlock = new TextBlock();
var te1:TextElement = new TextElement(str, ef1);
tb.content = te1;
var line1:TextLine = tb.createTextLine(null, 600);
addChild(line1);
line1.x = 15;
line1.y = 30;
tb.content.elementFormat = ef2;
var line2:TextLine = tb.createTextLine(null, 600);
addChild(line2);
line2.x = 15;
line2.y = 60;
}
}
}
Tue Jun 12 2018, 11:04 AM Z