TabStopFormat

包	flashx.textLayout.formats
类	public class TabStopFormat
继承	TabStopFormat Object
实现	ITabStopFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

TabStopFormat 类表示段落中制表位的属性。可将 TextLayoutFormat.tabstops 属性设置为 TabStopFormat 对象的数组。

查看示例

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		alignment : * 此制表位的制表位对齐方式。	TabStopFormat
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		decimalAlignmentToken : * 如果对齐方式为 DECIMAL，则为要使用的对齐标记。	TabStopFormat
		defaultFormat : flashx.textLayout.formats:ITabStopFormat [静态] [只读] 返回使用默认设置的 TabStopFormat 对象。	TabStopFormat
		position : * 制表位相对于列开始边缘的位置（以像素为单位）。	TabStopFormat

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null) 创建新 TabStopFormat 对象。	TabStopFormat
		apply(incoming:flashx.textLayout.formats:ITabStopFormat):void 使用 incoming ITabStopFormat 实例中设置的属性值替换该 TabStopFormat 对象中的属性值。	TabStopFormat
		concat(incoming:flashx.textLayout.formats:ITabStopFormat):void 将 incoming ITabStopFormat 实例中的属性值与该 TabStopFormat 对象的值串联。	TabStopFormat
		concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void 将 incoming ITabStopFormat 实例中的属性值与该 TabStopFormat 对象的值串联。	TabStopFormat
		copy(values:flashx.textLayout.formats:ITabStopFormat):void 将 TabStopFormat 设置从 values ITabStopFormat 实例复制到该 TabStopFormat 对象中。	TabStopFormat
		getStyle(styleName:String):* 返回由指定样式名称的 styleProp 参数指定的样式的值。	TabStopFormat
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean [静态] 将 ITabStopFormat 实例 p1 中的属性与 ITabStopFormat 实例 p2 的属性相比较，如果所有属性匹配，则返回 true。	TabStopFormat
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void 将该 TabStopFormat 对象中的属性设置为 undefined（如果这些属性与 incoming ITabStopFormat 实例中的属性不匹配）。	TabStopFormat
		removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void 将该 TabStopFormat 对象中的属性设置为 undefined（如果这些属性与 incoming ITabStopFormat 实例中的属性匹配）。	TabStopFormat
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setStyle(styleName:String, value:*):void 将由指定样式名称的 styleProp 参数指定的样式的值设置为 value。	TabStopFormat
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		valueOf():Object 返回指定对象的原始值。	Object

属性详细信息

alignment

属性

alignment:*

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

此制表位的制表位对齐方式。

合法值为 TabAlignment.START、TabAlignment.CENTER、TabAlignment.END、TabAlignment.DECIMAL 和 FormatValue.INHERIT。

默认值未定义，指示未设置。

如果在层叠期间未定义，则此属性值为 TabAlignment.START。

实现
public function get alignment():*
public function set alignment(value:any):void

引发

RangeError — 当设置的值不在此属性的范围内时

decimalAlignmentToken

属性

decimalAlignmentToken:*

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

如果对齐方式为 DECIMAL，则为要使用的对齐标记。

默认值未定义，指示未设置。

如果在层叠期间未定义，则此属性值为 null。

实现
public function get decimalAlignmentToken():*
public function set decimalAlignmentToken(value:any):void

引发

RangeError — 当设置的值不在此属性的范围内时

defaultFormat

属性

defaultFormat:flashx.textLayout.formats:ITabStopFormat [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回使用默认设置的 TabStopFormat 对象。此函数始终返回相同的对象。

实现
public static function get defaultFormat():flashx.textLayout.formats:ITabStopFormat

position

属性

position:*

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

制表位相对于列开始边缘的位置（以像素为单位）。

合法值为 0 到 10000 范围内的数字和 FormatValue.INHERIT。

默认值未定义，指示未设置。

如果在层叠期间未定义，则此属性值为 0。

实现
public function get position():*
public function set position(value:any):void

引发

RangeError — 当设置的值不在此属性的范围内时

相关 API 元素

FormatValue.INHERIT

构造函数详细信息

()

构造函数

public function TabStopFormat(initialValues:flashx.textLayout.formats:ITabStopFormat = null)

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建新 TabStopFormat 对象。所有设置都是空的，或通过提供的 initialValues 对象进行初始化（可选）。

参数

initialValues:flashx.textLayout.formats:ITabStopFormat (default = null) — 从其复制初始值的可选实例。

相关 API 元素

defaultFormat

方法详细信息

apply

()

方法

public function apply(incoming:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

使用 incoming ITabStopFormat 实例中设置的属性值替换该 TabStopFormat 对象中的属性值。incoming ITabStopFormat 实例中值为 undefined 的属性在该对象中不会改变。

参数

incoming:flashx.textLayout.formats:ITabStopFormat — 其属性值应用于该 TabStopFormat 对象的实例。

concat

()

方法

public function concat(incoming:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 incoming ITabStopFormat 实例中的属性值与该 TabStopFormat 对象的值串联。在此（接收） TabStopFormat 对象中，值为 FormatValue.INHERIT 的属性和值为 undefined 的继承属性将从 incoming 对象获取新值。值为 undefined 的非继承属性将获取其默认值。所有其它属性值将保持不变。

参数

incoming:flashx.textLayout.formats:ITabStopFormat — 串联其值的实例。

concatInheritOnly

()

方法

public function concatInheritOnly(incoming:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 incoming ITabStopFormat 实例中的属性值与该 TabStopFormat 对象的值串联。在此（接收） TabStopFormat 对象中，值为 FormatValue.INHERIT 的属性和值为 undefined 的继承属性将从 incoming 对象获取新值。所有其它属性值将保持不变。

参数

incoming:flashx.textLayout.formats:ITabStopFormat — 串联其值的实例。

copy

()

方法

public function copy(values:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 TabStopFormat 设置从 values ITabStopFormat 实例复制到该 TabStopFormat 对象中。如果 values 为 null，则此 TabStopFormat 对象使用所有属性的未定义值初始化。

参数

values:flashx.textLayout.formats:ITabStopFormat — 从其复制值的可选实例。

getStyle

()

方法

public function getStyle(styleName:String):*

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回由指定样式名称的 styleProp 参数指定的样式的值。

参数

styleName:String — 要检索其值的样式的名称。

* — 指定的样式的值。类型随正在访问的样式类型而异。如果未设置样式，则返回 undefined。

isEqual

()

方法

 public static function isEqual(p1:flashx.textLayout.formats:ITabStopFormat, p2:flashx.textLayout.formats:ITabStopFormat):Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 ITabStopFormat 实例 p1 中的属性与 ITabStopFormat 实例 p2 的属性相比较，如果所有属性匹配，则返回 true。

参数

	`p1:flashx.textLayout.formats:ITabStopFormat` — 与 `p2` 比较的实例。

	`p2:flashx.textLayout.formats:ITabStopFormat` — 与 `p1` 比较的实例。

Boolean — 如果所有属性匹配，则为 true，否则为 false。

removeClashing

()

方法

public function removeClashing(incoming:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将该 TabStopFormat 对象中的属性设置为 undefined（如果这些属性与 incoming ITabStopFormat 实例中的属性不匹配）。

参数

incoming:flashx.textLayout.formats:ITabStopFormat — 与该 TabStopFormat 对象的属性值进行比较的实例。

removeMatching

()

方法

public function removeMatching(incoming:flashx.textLayout.formats:ITabStopFormat):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将该 TabStopFormat 对象中的属性设置为 undefined（如果这些属性与 incoming ITabStopFormat 实例中的属性匹配）。

参数

incoming:flashx.textLayout.formats:ITabStopFormat — 与该 TabStopFormat 对象的属性值进行比较的实例。

setStyle

()

方法

public function setStyle(styleName:String, value:*):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将由指定样式名称的 styleProp 参数指定的样式的值设置为 value。

参数

	`styleName:String` — 要设置其值的样式的名称。

	`value:*` — 要设置的值。

示例如何使用本示例

TabStopFormat_example.as

此示例创建一个段落，该段落使用一个含三个制表位的数组：在 50 像素处的左对齐制表位、在 150 像素处的中心对齐制表位、在 250 像素处的右对齐制表位。

package flashx.textLayout.formats.examples {
    import flash.display.Sprite;
    import flash.text.engine.TabAlignment;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.compose.StandardFlowComposer;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TabStopFormat;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class TabStopFormat_example extends Sprite
    {
        public function TabStopFormat_example()
        {
            var firstContainer:Sprite = new Sprite();
            this.stage.addChild( firstContainer );
            var textFlow:TextFlow = new TextFlow();
            var format:TextLayoutFormat = new TextLayoutFormat();
            var tabStop1:TabStopFormat = new TabStopFormat();
            var tabStop2:TabStopFormat = new TabStopFormat();
            var tabStop3:TabStopFormat = new TabStopFormat();
            tabStop1.alignment = flash.text.engine.TabAlignment.START;
            tabStop1.position = 50;
            tabStop2.alignment = flash.text.engine.TabAlignment.CENTER;
            tabStop2.position = 150;
            tabStop3.alignment = flash.text.engine.TabAlignment.END;
            tabStop3.position = 250;
            format.tabStops = new Array(tabStop1,tabStop2,tabStop3);
            textFlow.hostFormat = format;
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            span.text = "1\txxx\txxx\txxx\n2\tyyyyyy\tyyyyyy<\tyyyyyy\n3\tzz\tzz\tzz";
            p.addChild(span);
            textFlow.addChild(p);
            textFlow.flowComposer = new StandardFlowComposer();
            var firstController:ContainerController = new ContainerController(firstContainer, 300, 100 );
            textFlow.flowComposer.addController(firstController);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }        
}

法律声明 | 在线隐私策略

TabStopFormat - AS3

包x

语言元素

附录

包 flashx.textLayout.formats

alignment

decimalAlignmentToken

defaultFormat

position

TabStopFormat

apply

concat

concatInheritOnly

copy

getStyle

isEqual

removeClashing

removeMatching

setStyle