TextContainerManager

套件	flashx.textLayout.container
類別	public class TextContainerManager
繼承	TextContainerManager EventDispatcher Object
實作	ISWFContext, IInteractionEventHandler, ISandboxSupport

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

管理容器中的文字。假設其管理容器的所有子系。請考慮使用 TextContainerManager 以獲得較佳的效能，以避免每個 TextFlow 各有一個容器，而 TextFlow 卻不是主焦點、是靜態文字或不經常選取。例如，非常適用於表單欄位中的文字。

相關 API 元素

ContainerController

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		compositionHeight : Number 傳回容器內的文字允許的垂直範圍。	TextContainerManager
		compositionWidth : Number 傳回容器內的文字允許的水平範圍。	TextContainerManager
		configuration : IConfiguration [唯讀] 此 TextContainerManager 的 Configuration 物件。	TextContainerManager
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		container : Sprite [唯讀] 傳回容器 (DisplayObjectContainer)，其保存此 TextContainerManager 管理的文字。	TextContainerManager
		defaultConfiguration : IConfiguration [靜態] [唯讀] 此 TextContainerManager 的預設組態。	TextContainerManager
		editingMode : String 此 TextContainerManager 的編輯模式。	TextContainerManager
		horizontalScrollPolicy : String 當容器邊界填滿後，控制 factory 是否產生所有文字行或停駐點。指定水平捲動原則，可指定下列 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 當容器邊界填滿後，控制 factory 是否產生所有文字行或停駐點。指定垂直捲動原則，可指定下列 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 撰寫容器文字；呼叫 factory 或 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 屬性設定為指定字串。	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 更新顯示；呼叫 factory 或 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

傳回容器 (DisplayObjectContainer)，其保存此 TextContainerManager 管理的文字。

實作
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

當容器邊界填滿後，控制 factory 是否產生所有文字行或停駐點。

指定水平捲動原則，可指定下列 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

當容器邊界填滿後，控制 factory 是否產生所有文字行或停駐點。

指定垂直捲動原則，可指定下列 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 實體，並在需要時建立一個 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

撰寫容器文字；呼叫 factory 或 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 — 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 屬性設定為指定字串。捨棄任何附加的 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

更新顯示；呼叫 factory 或 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