TextContainerManager

包	flashx.textLayout.container
类	public class TextContainerManager
继承	TextContainerManager EventDispatcher Object
实现	ISWFContext, IInteractionEventHandler, ISandboxSupport

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

管理容器中的文本。假定它管理容器的所有子代。如果每个 TextFlow 都存在一个容器，并且 TextFlow 不是主焦点、是静态文本或者很少选择，可以考虑使用 TextContainerManager 来改善性能。例如，这适用于表单字段中的文本。

相关 API 元素

ContainerController

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		compositionHeight : Number 返回容器内允许的文本垂直范围。	TextContainerManager
		compositionWidth : Number 返回容器内允许的文本水平范围。	TextContainerManager
		configuration : IConfiguration [只读] 该 TextContainerManager 的 Configuration 对象。	TextContainerManager
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		container : Sprite [只读] 返回包含该 TextContainerManager 管理的文本的容器 (DisplayObjectContainer)。	TextContainerManager
		defaultConfiguration : IConfiguration [静态] [只读] 该 TextContainerManager 的默认配置。	TextContainerManager
		editingMode : String 该 TextContainerManager 的编辑模式。	TextContainerManager
		horizontalScrollPolicy : String 控制工厂是生成所有文本行还是在填满容器范围时停止。指定水平滚动方式，这可以通过指定 ScrollPolicy 类的一个常量来设置：ON、OFF 或 AUTO。	TextContainerManager
		horizontalScrollPosition : Number 指定舞台上当前的水平滚动位置。	TextContainerManager
		hostFormat : flashx.textLayout.formats:ITextLayoutFormat 设置仅显示一个字符串时的格式。	TextContainerManager
		numLines : int [只读] 在流中合成的行的总数。	TextContainerManager
		swfContext : ISWFContext 用于根据需要在正确的 swf 上下文中进行 FTE 调用的可选 ISWFContext 实例。	TextContainerManager
		verticalScrollPolicy : String 控制工厂是生成所有文本行还是在填满容器范围时停止。指定垂直滚动方式，这可以通过指定 ScrollPolicy 类的一个常量来设置：ON、OFF 或 AUTO。	TextContainerManager
		verticalScrollPosition : Number 指定舞台上当前的垂直滚动位置。	TextContainerManager

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		TextContainerManager(container:Sprite, configuration:IConfiguration = null) 构造函数 - 创建 TextContainerManager 实例。	TextContainerManager
		activateHandler(event:Event):void 当客户端管理事件时处理 Event.ACTIVATE 事件。	TextContainerManager
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		beginInteraction():ISelectionManager 返回当前 ISelectionManager 实例。	TextContainerManager
		beginMouseCapture():void 请求客户端开始从安全沙箱外部转发 mouseup 和 mousemove 事件时调用。	TextContainerManager
		compose():void 合成容器文本；调用工厂或 updateAllControllers()。	TextContainerManager
		deactivateHandler(event:Event):void 当客户端管理事件时处理 Event.DEACTIVATE 事件。	TextContainerManager
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		drawBackgroundAndSetScrollRect(scrollX:Number, scrollY:Number):Boolean 如果它填充了容器的 scrollRect 属性则返回 true。	TextContainerManager
		editHandler(event:Event):void 当客户端管理事件时处理编辑事件（CUT、COPY、PASTE、SELECT_ALL）。	TextContainerManager
		endInteraction():void 终止交互。	TextContainerManager
		endMouseCapture():void 通知客户端不再需要从安全沙箱外部转发 mouseup 和 mousemove 事件时调用。	TextContainerManager
		focusChangeHandler(event:FocusEvent):void 当客户端管理事件时处理 FocusEvent.KEY_FOCUS_CHANGE 和 FocusEvent.MOUSE_FOCUS_CHANGE 事件。	TextContainerManager
		focusInHandler(event:FocusEvent):void 处理 focusIn 事件。	TextContainerManager
		focusOutHandler(event:FocusEvent):void 当客户端管理事件时处理 FocusEvent.FOCUS_OUT 事件。	TextContainerManager
		getContentBounds():Rectangle 创建一个矩形，它显示对 compose() 方法或 updateContainer() 方法的最后调用放置该文本的位置。	TextContainerManager
		getLineAt(index:int):flash.text.engine:TextLine 从合成的行数组中返回位于指定索引的 TextLine。	TextContainerManager
		getScrollDelta(numLines:int):Number 计算要向上或向下滚动指定行数所需的滚动距离。	TextContainerManager
		getText(separator:String = " "):String 返回在段落之间使用某一分隔符的当前文本。	TextContainerManager
		getTextFlow():flashx.textLayout.elements:TextFlow 当前 TextFlow。	TextContainerManager
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		imeStartCompositionHandler(event:IMEEvent):void 当客户端管理事件时处理 IME_START_COMPOSITION 事件。	TextContainerManager
		invalidateSelectionFormats():void 如果要更改选择格式 (SelectionFormat) 并希望更新 interactionManager，可调用此方法。	TextContainerManager
		invalidateUndoManager():void 如果您正在执行编辑且希望重置用于编辑的撤消管理器，可调用此方法。	TextContainerManager
		isDamaged():Boolean 如果需要合成内容则返回 true。	TextContainerManager
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		keyDownHandler(event:KeyboardEvent):void 当客户端管理事件时处理 KeyboardEvent.KEY_DOWN 事件。	TextContainerManager
		keyFocusChangeHandler(event:FocusEvent):void 当客户端管理事件时处理 FocusEvent.KEY_FOCUS_CHANGE 事件。	TextContainerManager
		keyUpHandler(event:KeyboardEvent):void 当客户端管理事件时处理 Keyboard.KEY_UP 事件。	TextContainerManager
		menuSelectHandler(event:ContextMenuEvent):void 当客户端管理事件时处理 ContextMenuEvent.MENU_SELECT 事件。	TextContainerManager
		mouseDoubleClickHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.DOUBLE_CLICK 事件。	TextContainerManager
		mouseDownHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.MOUSE_DOWN 事件。	TextContainerManager
		mouseMoveHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.MOUSE_MOVE 事件。	TextContainerManager
		mouseMoveSomewhere(e:Event):void 用于从安全沙箱外部转发 mouseMove 事件的客户端调用。	TextContainerManager
		mouseOutHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.MOUSE_OUT 事件。	TextContainerManager
		mouseOverHandler(event:MouseEvent):void 处理 mouseOver 事件。	TextContainerManager
		mouseUpHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.MOUSE_UP 事件。	TextContainerManager
		mouseUpSomewhere(e:Event):void 客户端调用以从安全沙箱外转发一个 mouseUp 事件。	TextContainerManager
		mouseWheelHandler(event:MouseEvent):void 当客户端管理事件时处理 MouseEvent.MOUSE_WHEEL 事件。	TextContainerManager
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		resetLine(textLine:flash.text.engine:TextLine):void	TextContainerManager
		scrollToRange(activePosition:int, anchorPosition:int):void 允许滚动，使文本范围在容器中可见。	TextContainerManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		setText(text:String):void 将 text 属性设置为指定的 String。	TextContainerManager
		setTextFlow(textFlow:flashx.textLayout.elements:TextFlow):void 将一个 TextFlow 设置到该 TextContainerManager 中，取代任何现有 TextFlow 并放弃当前文本。	TextContainerManager
		softKeyboardActivatingHandler(event:Event):void 当客户端管理事件时处理 SOFT_KEYBOARD_ACTIVATING 事件。	TextContainerManager
		textInputHandler(event:flash.events:TextEvent):void 当客户端管理事件时处理 TextEvent.TEXT_INPUT 事件。	TextContainerManager
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String 返回指定对象的字符串表示形式。	Object
		updateContainer():Boolean 更新显示；调用工厂或 updateAllControllers()。	TextContainerManager
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

受保护的方法

	方法		由以下参数定义
		createContextMenu():ContextMenu 为 TextContainerManager 创建一个 ContextMenu。	TextContainerManager
		createEditManager(undoManager:IUndoManager):IEditManager 创建一个编辑管理器，用于编辑。	TextContainerManager
		createSelectionManager():ISelectionManager 创建选择管理器，用于进行选择。	TextContainerManager
		getFocusedSelectionFormat():SelectionFormat 返回 focusedSelectionFormat - 默认情况下从配置获得。	TextContainerManager
		getInactiveSelectionFormat():SelectionFormat 返回 inactiveSelectionFormat - 默认情况下从配置获得。可以在子类中覆盖该方法以提供不同的 SelectionFormat。	TextContainerManager
		getUndoManager():IUndoManager 返回要使用的撤消管理器。	TextContainerManager
		getUnfocusedSelectionFormat():SelectionFormat 返回 unfocusedSelectionFormat - 默认情况下从配置获得。您可以在子类中覆盖该方法以提供不同的 SelectionFormat。	TextContainerManager

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
click	单击任何链接时调度。	TextContainerManager
compositionComplete	每次重新合成后调度。	TextContainerManager
damage	每次 TextFlow 对象受损时由该对象调度。	TextContainerManager
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher
flowOperationBegin	定义 flowOperationBegin 事件对象的 type 属性值。	TextContainerManager
flowOperationComplete	定义 flowOperationComplete 事件对象的 type 属性的值。	TextContainerManager
flowOperationEnd	定义 flowOperationEnd 事件对象的 type 属性值。	TextContainerManager
inlineGraphicStatusChanged	当由于宽度或高度设置为 auto 或百分比而使 InlineGraphicElement 调整了大小，且图形完成加载后进行调度。	TextContainerManager
mouseDown	在任何链接上按下鼠标时调度。	TextContainerManager
mouseMove	当鼠标经过任何链接时调度。	TextContainerManager
mouseUp	在任何链接上松开鼠标时调度。	TextContainerManager
rollOut	当鼠标离开任何链接时调度。	TextContainerManager
rollOver	当鼠标首次进入任何链接时调度。	TextContainerManager
scroll	在控制器容器中滚动了文本时由 TextFlow 对象调度。	TextContainerManager
selectionChange	每次更改所选项目后调度。	TextContainerManager
updateComplete	每次由于合成而使容器添加或更新了 DisplayObject 时由 TextFlow 对象调度。	TextContainerManager

属性详细信息

compositionHeight

属性

compositionHeight:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回容器内允许的文本垂直范围。该值以像素为单位指定。

在设置此属性后，容器中的文本会受损，需要进行合成。

实现
public function get compositionHeight():Number
public function set compositionHeight(value:Number):void

compositionWidth

属性

compositionWidth:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回容器内允许的文本水平范围。该值以像素为单位指定。

在设置此属性后，容器中的文本会受损，需要进行合成。

实现
public function get compositionWidth():Number
public function set compositionWidth(value:Number):void

configuration

属性

configuration:IConfiguration [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

该 TextContainerManager 的 Configuration 对象。

实现
public function get configuration():IConfiguration

相关 API 元素

IConfiguration

container

属性

container:Sprite [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回包含该 TextContainerManager 管理的文本的容器 (DisplayObjectContainer)。

实现
public function get container():Sprite

相关 API 元素

ContainerController.container

defaultConfiguration

属性

defaultConfiguration:IConfiguration [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

该 TextContainerManager 的默认配置。列和填充属性设置为 FormatValue.INHERIT。

实现
public static function get defaultConfiguration():IConfiguration

相关 API 元素

IConfiguration
FormatValue.INHERIT

editingMode

属性

editingMode:String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

该 TextContainerManager 的编辑模式。模式包括只读、允许读取和选择，以及允许编辑（读取、选择和写入）。可使用 EditingMode 类的常量值来设置此属性。

默认值为 READ_WRITE。

实现
public function get editingMode():String
public function set editingMode(value:String):void

相关 API 元素

EditingMode

horizontalScrollPolicy

属性

horizontalScrollPolicy:String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

控制工厂是生成所有文本行还是在填满容器范围时停止。

指定水平滚动方式，这可以通过指定 ScrollPolicy 类的一个常量来设置：ON、OFF 或 AUTO。

实现
public function get horizontalScrollPolicy():String
public function set horizontalScrollPolicy(value:String):void

horizontalScrollPosition

属性

horizontalScrollPosition:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指定舞台上当前的水平滚动位置。该值指定了自左端的像素数。

实现
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

hostFormat

属性

hostFormat:flashx.textLayout.formats:ITextLayoutFormat

设置仅显示一个字符串时的格式。如果显示的是 TextFlow，则没有即时效果。不会复制提供的 ITextLayoutFormat。如果没有调用此 setter 而修改它，则有即时效果。

实现
public function get hostFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set hostFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

numLines

属性

numLines:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在流中合成的行的总数。默认情况下，TLF 不合成整个流，并且此值可能不正确。使用 composeToPosition 合成所有行。

实现
public function get numLines():int

swfContext

属性

swfContext:ISWFContext

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

用于根据需要在正确的 swf 上下文中进行 FTE 调用的可选 ISWFContext 实例。

实现
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

相关 API 元素

flashx.textLayout.compose.ISWFContext

verticalScrollPolicy

属性

verticalScrollPolicy:String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

控制工厂是生成所有文本行还是在填满容器范围时停止。

指定垂直滚动方式，这可以通过指定 ScrollPolicy 类的一个常量来设置：ON、OFF 或 AUTO。

实现
public function get verticalScrollPolicy():String
public function set verticalScrollPolicy(value:String):void

verticalScrollPosition

属性

verticalScrollPosition:Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指定舞台上当前的垂直滚动位置。该值指定了距离顶部的像素数。

实现
public function get verticalScrollPosition():Number
public function set verticalScrollPosition(value:Number):void

构造函数详细信息

()

构造函数

public function TextContainerManager(container:Sprite, configuration:IConfiguration = null)

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

构造函数 - 创建 TextContainerManager 实例。为得到最佳结果：

从 TextContainerManager.defaultConfiguration 开始并修改它
在多个 InputManagers 之间共享相同 Configuration

参数

	`container:Sprite` — 用于管理文本行的 DisplayObjectContainer。

	`configuration:IConfiguration` (default = `null`) — - 用于与此 TextContainerManager 实例一起使用的 IConfiguration 实例。

方法详细信息

activateHandler

()

方法

public function activateHandler(event:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 Event.ACTIVATE 事件。

参数

event:Event — Event 对象。

相关 API 元素

Event.ACTIVATE

beginInteraction

()

方法

public function beginInteraction():ISelectionManager

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回当前 ISelectionManager 实例。转换为 TextFlow 实例，如有必要创建一个实例。

ISelectionManager — 该 TextContainerManager 实例的交互管理器。

相关 API 元素

ISelectionManager

beginMouseCapture

()

方法

public function beginMouseCapture():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

请求客户端开始从安全沙箱外部转发 mouseup 和 mousemove 事件时调用。

compose

()

方法

public function compose():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

合成容器文本；调用工厂或 updateAllControllers()。

createContextMenu

()

方法

protected function createContextMenu():ContextMenu

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

为 TextContainerManager 创建一个 ContextMenu。使用 ContextMenu 类的方法可向菜单中添加项。

您可以覆盖此方法，以定义一个自定义上下文菜单。

ContextMenu — 创建的上下文菜单。

相关 API 元素

ContextMenu

createEditManager

()

方法

protected function createEditManager(undoManager:IUndoManager):IEditManager

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建一个编辑管理器，用于编辑。如果您有自定义的 EditManager，并希望使用它取代默认设置，请覆盖此方法。

参数

undoManager:IUndoManager — 要创建的 EditManager 的 IUndoManager 实例。

IEditManager — 该 TextContainerManager 实例的编辑管理器。

createSelectionManager

()

方法

protected function createSelectionManager():ISelectionManager

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建选择管理器，用于进行选择。如果您有自定义的 SelectionManager，并希望使用它取代默认设置，请覆盖此方法。

ISelectionManager — 一个新 SelectionManager 实例。

deactivateHandler

()

方法

public function deactivateHandler(event:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 Event.DEACTIVATE 事件。

参数

event:Event — Event 对象。

相关 API 元素

Event.DEACTIVATE

drawBackgroundAndSetScrollRect

()

方法

public function drawBackgroundAndSetScrollRect(scrollX:Number, scrollY:Number):Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

如果它填充了容器的 scrollRect 属性则返回 true。此方法使您能够测试 scrollRect 是否是在没有实际访问 scrollRect 属性的情况下设置的，这种情况可能会造成性能问题。

覆盖此方法可绘制背景或边框。由于必须根据指定值设置 scrollRect，因此覆盖该方法可能需要慎重。

参数

	`scrollX:Number` — 滚动矩形的水平起始位置。

	`scrollY:Number` — 滚动矩形的垂直起始位置。

Boolean — 如果它创建了 scrollRect 对象则返回 true。

editHandler

()

方法

public function editHandler(event:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理编辑事件（CUT、COPY、PASTE、SELECT_ALL）。

参数

event:Event — 事件对象。

相关 API 元素

事件

endInteraction

()

方法

public function endInteraction():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

终止交互。

相关 API 元素

ISelectionManager

endMouseCapture

()

方法

public function endMouseCapture():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

通知客户端不再需要从安全沙箱外部转发 mouseup 和 mousemove 事件时调用。

focusChangeHandler

()

方法

public function focusChangeHandler(event:FocusEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 FocusEvent.KEY_FOCUS_CHANGE 和 FocusEvent.MOUSE_FOCUS_CHANGE 事件。

参数

event:FocusEvent — FocusEvent 对象。

focusInHandler

()

方法

public function focusInHandler(event:FocusEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

处理 focusIn 事件。

参数

event:FocusEvent

focusOutHandler

()

方法

public function focusOutHandler(event:FocusEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 FocusEvent.FOCUS_OUT 事件。

参数

event:FocusEvent — FocusEvent 对象。

相关 API 元素

FocusEvent.FOCUS_OUT

getContentBounds

()

方法

public function getContentBounds():Rectangle

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

创建一个矩形，它显示对 compose() 方法或 updateContainer() 方法的最后调用放置该文本的位置。

Rectangle — 内容的范围

相关 API 元素

compose()
updateContainer()

getFocusedSelectionFormat

()

方法

protected function getFocusedSelectionFormat():SelectionFormat

返回 focusedSelectionFormat - 默认情况下从配置获得。可以在子类中覆盖该方法以提供不同的 SelectionFormat。

SelectionFormat

getInactiveSelectionFormat

()

方法

protected function getInactiveSelectionFormat():SelectionFormat

返回 inactiveSelectionFormat - 默认情况下从配置获得。可以在子类中覆盖该方法以提供不同的 SelectionFormat。

SelectionFormat

getLineAt

()

方法

public function getLineAt(index:int):flash.text.engine:TextLine

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

从合成的行数组中返回位于指定索引的 TextLine。

参数

index:int — 找到文本中位于该索引位置的行。

flash.text.engine:TextLine — 位于指定索引的 TextLine。

getScrollDelta

()

方法

public function getScrollDelta(numLines:int):Number

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

计算要向上或向下滚动指定行数所需的滚动距离。如果行数为负值则会向上滚动，从而显示 TextFlow 顶部的更多行。如果行数为正值则会向下滚动，从而显示底部的下一行。

例如，向上滚动时，该方法使下一行完全可见。如果下一行被部分遮挡，而行数指定为 1，则该行将会完全可见。

参数

numLines:int — 要滚动的行数。

Number — 要滚动的空间增量

getText

()

方法

public function getText(separator:String = " "):String

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回在段落之间使用某一分隔符的当前文本。该分隔符可以使用 separator 参数进行指定。separator 参数的默认值为 Unicode 字符 'PARAGRAPH SEPARATOR' (U+2029)。

调用 setter 将放弃任何附加的 TextFlow。会丢失任意当前选择。

参数

separator:String (default = " ") — 要在段落之间设置的字符串。

String

getTextFlow

()

方法

public function getTextFlow():flashx.textLayout.elements:TextFlow

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当前 TextFlow。将其转化为完整的 TextFlow 表示形式（如果尚不是）。

flashx.textLayout.elements:TextFlow — 当前 TextFlow 对象

getUndoManager

()

方法

protected function getUndoManager():IUndoManager

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回要使用的撤消管理器。默认情况下会创建一个唯一的撤消管理器。如果您希望自定义该撤消管理器（例如，对多个 TextContainerManager 实例使用一个共享的撤消管理器），可以在子类中覆盖此方法。

IUndoManager — 新的 IUndoManager 实例。

getUnfocusedSelectionFormat

()

方法

protected function getUnfocusedSelectionFormat():SelectionFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

返回 unfocusedSelectionFormat - 默认情况下从配置获得。您可以在子类中覆盖该方法以提供不同的 SelectionFormat。

SelectionFormat

imeStartCompositionHandler

()

方法

public function imeStartCompositionHandler(event:IMEEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10.1, AIR 1.5

当客户端管理事件时处理 IME_START_COMPOSITION 事件。

参数

event:IMEEvent — IMEEvent 对象。

相关 API 元素

IMEEvent.IME_START_COMPOSITION

invalidateSelectionFormats

()

方法

public function invalidateSelectionFormats():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

如果要更改选择格式 (SelectionFormat) 并希望更新 interactionManager，可调用此方法。

invalidateUndoManager

()

方法

public function invalidateUndoManager():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

如果您正在执行编辑且希望重置用于编辑的撤消管理器，可调用此方法。

isDamaged

()

方法

public function isDamaged():Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

如果需要合成内容则返回 true。

Boolean — 如果需要合成内容则返回 true，否则返回 false。

keyDownHandler

()

方法

public function keyDownHandler(event:KeyboardEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 KeyboardEvent.KEY_DOWN 事件。

参数

event:KeyboardEvent — KeyboardEvent 对象。

相关 API 元素

KeyboardEvent.KEY_DOWN

keyFocusChangeHandler

()

方法

public function keyFocusChangeHandler(event:FocusEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 FocusEvent.KEY_FOCUS_CHANGE 事件。

参数

event:FocusEvent — FocusEvent 对象。

keyUpHandler

()

方法

public function keyUpHandler(event:KeyboardEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 Keyboard.KEY_UP 事件。

参数

event:KeyboardEvent — KeyboardEvent 对象。

相关 API 元素

KeyboardEvent.KEY_UP

menuSelectHandler

()

方法

public function menuSelectHandler(event:ContextMenuEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 ContextMenuEvent.MENU_SELECT 事件。

参数

event:ContextMenuEvent — ContextMenuEvent 对象。

相关 API 元素

ContextMenuEvent.MENU_SELECT

mouseDoubleClickHandler

()

方法

public function mouseDoubleClickHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.DOUBLE_CLICK 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.DOUBLE_CLICK

mouseDownHandler

()

方法

public function mouseDownHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.MOUSE_DOWN 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.MOUSE_DOWN

mouseMoveHandler

()

方法

public function mouseMoveHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.MOUSE_MOVE 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.MOUSE_MOVE

mouseMoveSomewhere

()

方法

public function mouseMoveSomewhere(e:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

用于从安全沙箱外部转发 mouseMove 事件的客户端调用。不需要鼠标移动的坐标。

参数

e:Event

mouseOutHandler

()

方法

public function mouseOutHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.MOUSE_OUT 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.MOUSE_OUT

mouseOverHandler

()

方法

public function mouseOverHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

处理 mouseOver 事件。

参数

event:MouseEvent

相关 API 元素

MouseEvent.MOUSE_OVER

mouseUpHandler

()

方法

public function mouseUpHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.MOUSE_UP 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.MOUSE_UP

mouseUpSomewhere

()

方法

public function mouseUpSomewhere(e:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

客户端调用以从安全沙箱外转发一个 mouseUp 事件。不需要鼠标向上的坐标。

参数

e:Event

mouseWheelHandler

()

方法

public function mouseWheelHandler(event:MouseEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 MouseEvent.MOUSE_WHEEL 事件。

参数

event:MouseEvent — MouseEvent 对象。

相关 API 元素

MouseEvent.MOUSE_WHEEL

resetLine

()

方法

public function resetLine(textLine:flash.text.engine:TextLine):void

参数

textLine:flash.text.engine:TextLine

scrollToRange

()

方法

public function scrollToRange(activePosition:int, anchorPosition:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

允许滚动，使文本范围在容器中可见。

参数

	`activePosition:int` — 当您扩展选择时随之改变的所选内容的末尾。可以是所选内容的开始或末尾，表示为距文本流起始位置的偏移。

	`anchorPosition:int` — 当扩展选择时所选内容的固定末尾。可以是所选内容的起始或末尾。

setText

()

方法

public function setText(text:String):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将 text 属性设置为指定的 String。放弃任何附加的 TextFlow。会丢失任意当前选择。

参数

text:String — 要设置的字符串

setTextFlow

()

方法

public function setTextFlow(textFlow:flashx.textLayout.elements:TextFlow):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将一个 TextFlow 设置到该 TextContainerManager 中，取代任何现有 TextFlow 并放弃当前文本。

参数

textFlow:flashx.textLayout.elements:TextFlow

softKeyboardActivatingHandler

()

方法

public function softKeyboardActivatingHandler(event:Event):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10.2, AIR 1.5

当客户端管理事件时处理 SOFT_KEYBOARD_ACTIVATING 事件。

参数

event:Event — SoftKeyboardEvent 对象。

textInputHandler

()

方法

public function textInputHandler(event:flash.events:TextEvent):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当客户端管理事件时处理 TextEvent.TEXT_INPUT 事件。

参数

event:flash.events:TextEvent — TextEvent 对象。

相关 API 元素

TextEvent.TEXT_INPUT

updateContainer

()

方法

public function updateContainer():Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

更新显示；调用工厂或 updateAllControllers()。

Boolean — 如果更改了任何内容，则为 true。

事件详细信息

click

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

单击任何链接时调度。

compositionComplete

事件

事件对象类型: flashx.textLayout.events.CompositionCompleteEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

每次重新合成后调度。

damage

事件

事件对象类型: flashx.textLayout.events.DamageEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

每次 TextFlow 对象受损时由该对象调度。

flowOperationBegin

事件

事件对象类型: flashx.textLayout.events.FlowOperationEvent
属性 FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_BEGIN

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

定义 flowOperationBegin 事件对象的 type 属性值。执行操作之前被调度。取消该事件会阻止操作的执行。

flowOperationComplete

事件

事件对象类型: flashx.textLayout.events.FlowOperationEvent
属性 FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_COMPLETE

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

定义 flowOperationComplete 事件对象的 type 属性的值。在完成所有操作（包括挂起操作和合成操作）、完成合成并滚动显示后调度。

flowOperationEnd

事件

事件对象类型: flashx.textLayout.events.FlowOperationEvent
属性 FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_END

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

定义 flowOperationEnd 事件对象的 type 属性值。在完成操作之后调度。所有错误都存储在 OperationEvent.error 中。如果发生错误，则取消该事件会阻止重新引发错误。一般情况下，所有错误都可能是致命的。

在此时（操作执行后）更改操作可能会失败。

inlineGraphicStatusChanged

事件

事件对象类型: flashx.textLayout.events.StatusChangeEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当由于宽度或高度设置为 auto 或百分比而使 InlineGraphicElement 调整了大小，且图形完成加载后进行调度。

mouseDown

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在任何链接上按下鼠标时调度。

mouseMove

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当鼠标经过任何链接时调度。

mouseUp

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在任何链接上松开鼠标时调度。

rollOut

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当鼠标离开任何链接时调度。

rollOver

事件

事件对象类型: flashx.textLayout.events.FlowElementMouseEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当鼠标首次进入任何链接时调度。

scroll

事件

事件对象类型: flashx.textLayout.events.TextLayoutEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

在控制器容器中滚动了文本时由 TextFlow 对象调度。

selectionChange

事件

事件对象类型: flashx.textLayout.events.SelectionEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

每次更改所选项目后调度。主要用于更新与当前选择相关的用户界面。

updateComplete

事件

事件对象类型: flashx.textLayout.events.UpdateCompleteEvent

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

每次由于合成而使容器添加或更新了 DisplayObject 时由 TextFlow 对象调度。

法律声明 | 在线隐私策略

TextContainerManager - AS3

包x

语言元素

附录

包 flashx.textLayout.container

compositionHeight

compositionWidth

configuration

container

defaultConfiguration

editingMode

horizontalScrollPolicy

horizontalScrollPosition

hostFormat

numLines

swfContext

verticalScrollPolicy

verticalScrollPosition