FlowElement

套件	flashx.textLayout.elements
類別	public class FlowElement
繼承	FlowElement Object
實作	ITextLayoutFormat
子類別	FlowGroupElement, FlowLeafElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

流排中的文字儲存於樹狀結構表單中，而此表單具有代表文字內邏輯區域樹狀結構的元素。FlowElement 類別是此樹狀結構中所有物件的抽象基底類別。FlowElement 物件代表段落、段落內的文字範圍，以及段落群組。

可撰寫 FlowElement 樹狀結構的根物件一律是 TextFlow 物件。樹狀結構的分葉元素一律會是 FlowLeafElement 類別的子類別。在可撰寫 TextFlow 中排列的所有分葉都會有 ParagraphElement 祖系。

您無法直接建立 FlowElement 物件。叫用新的 FlowElement() 時擲出錯誤例外。

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		alignmentBaseline : * TextLayoutFormat：指定主基線對齊的基線。	FlowElement
		backgroundAlpha : * TextLayoutFormat：背景的 Alpha (透明度) 值 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		backgroundColor : * TextLayoutFormat：文字的背景色彩 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		baselineShift : * TextLayoutFormat：從 dominantBaseline 值位移基線的量。	FlowElement
		blockProgression : * TextLayoutFormat：指定行位置為垂直或水平走向。	FlowElement
		breakOpportunity : * TextLayoutFormat：將換行文字斷行時，控制斷行的位置。	FlowElement
		cffHinting : * TextLayoutFormat：用於此文字的 CFF 提示類型。	FlowElement
		clearFloats : * TextLayoutFormat：控制文字包圍在浮動物件四周的方式。	FlowElement
		color : * TextLayoutFormat：文字的色彩。	FlowElement
		columnCount : * TextLayoutFormat：文字欄的數目 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		columnGap : * TextLayoutFormat：以像素為單位，指定欄之間所留間距空間的量 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		columnWidth : * TextLayoutFormat：以像素為單位的欄寬 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		computedFormat : flashx.textLayout.formats:ITextLayoutFormat [唯讀] 傳回對此元素使用的計算格式特質。	FlowElement
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		coreStyles : Object [唯讀] 傳回此 FlowElement 的 coreStyles。	FlowElement
		digitCase : * TextLayoutFormat：用於此文字的數字大小寫類型。	FlowElement
		digitWidth : * TextLayoutFormat：用於此文字的數字寬度類型。	FlowElement
		direction : * TextLayoutFormat：指定文字區塊內文字的預設雙向內嵌層級。	FlowElement
		dominantBaseline : * TextLayoutFormat：指定貼齊 alignmentBaseline 的元素基線，以決定行上元素的垂直位置。	FlowElement
		firstBaselineOffset : * TextLayoutFormat：指定容器中第一行的基線位置。	FlowElement
		fontFamily : * TextLayoutFormat：要使用的字體名稱，或是以逗號分隔的字體名稱清單。	FlowElement
		fontLookup : * TextLayoutFormat：要使用字體查詢。	FlowElement
		fontSize : * TextLayoutFormat：以像素為單位的文字大小。	FlowElement
		fontStyle : * TextLayoutFormat：文字樣式。	FlowElement
		fontWeight : * TextLayoutFormat：字體粗細。	FlowElement
		format : flashx.textLayout.formats:ITextLayoutFormat 直接套用至此元素的 TextLayoutFormat 屬性。	FlowElement
		id : String 指定元素的識別名稱，如此只要參照此 id 就可以設定元素的樣式。	FlowElement
		justificationRule : * TextLayoutFormat：對齊段落中文字所使用的規則。	FlowElement
		justificationStyle : * TextLayoutFormat：段落對齊所用的樣式。	FlowElement
		kerning : * TextLayoutFormat：字距微調會調整某些字元組之間的像素，以改善可讀性。	FlowElement
		leadingModel : * TextLayoutFormat：指定行距模型，它結合了行距基礎及行距方向。	FlowElement
		ligatureLevel : * TextLayoutFormat：控制字體中定義的哪些連字可用於文字。	FlowElement
		lineBreak : * TextLayoutFormat：控制容器內的文字換行 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		lineHeight : * TextLayoutFormat：文字的行距控制。	FlowElement
		lineThrough : * TextLayoutFormat：若為 true，將套用刪除線，亦即通過文字中間的線。	FlowElement
		linkActiveFormat : * TextLayoutFormat：定義正常狀態下的連結格式化特質。	FlowElement
		linkHoverFormat : * TextLayoutFormat：定義滑鼠位於連結範圍 (滑入) 時，停留狀態連結的格式化特質。	FlowElement
		linkNormalFormat : * TextLayoutFormat：定義正常狀態下的連結格式化特質。	FlowElement
		listAutoPadding : * TextLayoutFormat：當清單開始邊緣該側的邊框距離值設為 auto 時，這會將清單的開始邊緣指定為自動縮排。	FlowElement
		listMarkerFormat : * TextLayoutFormat：定義格式化特質清單標記。	FlowElement
		listStylePosition : * TextLayoutFormat：有效值為 ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT。若未定義預設值，則表示未設定。如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。	FlowElement
		listStyleType : * TextLayoutFormat：有效值為 ListStyleType.UPPER_ALPHA、ListStyleType.LOWER_ALPHA、ListStyleType.UPPER_ROMAN、ListStyleType.LOWER_ROMAN、ListStyleType.NONE、ListStyleType.DISC、ListStyleType.CIRCLE、ListStyleType.SQUARE、ListStyleType.BOX、ListStyleType.CHECK、ListStyleType.DIAMOND、ListStyleType.HYPHEN、ListStyleType.ARABIC_INDIC、ListStyleType.BENGALI、ListStyleType.DECIMAL、ListStyleType.DECIMAL_LEADING_ZERO、ListStyleType.DEVANAGARI、ListStyleType.GUJARATI、ListStyleType.GURMUKHI、ListStyleType.KANNADA、ListStyleType.PERSIAN、ListStyleType.THAI、ListStyleType.URDU、ListStyleType.CJK_EARTHLY_BRANCH、ListStyleType.CJK_HEAVENLY_STEM、ListStyleType.HANGUL、ListStyleType.HANGUL_CONSTANT、ListStyleType.HIRAGANA、ListStyleType.HIRAGANA_IROHA、ListStyleType.KATAKANA、ListStyleType.KATAKANA_IROHA、ListStyleType.LOWER_ALPHA、ListStyleType.LOWER_GREEK、ListStyleType.LOWER_LATIN、ListStyleType.UPPER_ALPHA、ListStyleType.UPPER_GREEK、ListStyleType.UPPER_LATIN、FormatValue.INHERIT。若未定義預設值，則表示未設定。如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。	FlowElement
		locale : * TextLayoutFormat：文字的地區設定。	FlowElement
		paddingBottom : * TextLayoutFormat：下方內移距 (像素)。	FlowElement
		paddingLeft : * TextLayoutFormat：左方內移距 (像素)。	FlowElement
		paddingRight : * TextLayoutFormat：右方內移距 (像素)。	FlowElement
		paddingTop : * TextLayoutFormat：上方內移距 (像素)。	FlowElement
		paragraphEndIndent : * TextLayoutFormat：指定段落結尾邊緣縮排量的數字 (以像素為單位)。	FlowElement
		paragraphSpaceAfter : * TextLayoutFormat：一個數字，指定段落後面要保留的空間量 (像素)。	FlowElement
		paragraphSpaceBefore : * TextLayoutFormat：一個數字，指定段落前面要保留的空間量 (像素)。	FlowElement
		paragraphStartIndent : * TextLayoutFormat：指定段落開頭邊緣縮排量的數字 (以像素為單位)。	FlowElement
		parent : FlowGroupElement [唯讀] 傳回此 FlowElement 物件的父輩。	FlowElement
		parentRelativeEnd : int [唯讀] 傳回父輩中此 FlowElement 物件的相對結尾。	FlowElement
		parentRelativeStart : int [唯讀] 傳回父輩中此 FlowElement 物件的相對開頭。	FlowElement
		renderingMode : * TextLayoutFormat：用於此文字的顯示模式。	FlowElement
		styleName : * TextLayoutFormat：指定元素的識別類別，如此只要參照此 styleName 就可以設定元素的樣式。	FlowElement
		styles : Object [唯讀] 傳回此 FlowElement 的樣式。	FlowElement
		tabStops : * TextLayoutFormat：指定段落關聯的定位停駐點。	FlowElement
		textAlign : * TextLayoutFormat：段落中各行相對於容器的對齊方式。	FlowElement
		textAlignLast : * TextLayoutFormat：段落中最後 (或唯一的) 一行相對於齊行文字中之容器的對齊方式。	FlowElement
		textAlpha : * TextLayoutFormat：文字的 Alpha (透明) 值。	FlowElement
		textDecoration : * TextLayoutFormat：文字上的裝飾。	FlowElement
		textIndent : * TextLayoutFormat：以像素為單位，指定段落中第一行縮排量的數字。	FlowElement
		textJustify : * TextLayoutFormat：指定對齊文字的選項。	FlowElement
		textLength : int [唯讀] 傳回此 FlowElement 物件及其子系所擁有的文字總長度。	FlowElement
		textRotation : * TextLayoutFormat：決定此文字要旋轉的度數。	FlowElement
		tracking : Object [唯寫] 設定字距調整，且與 trackingRight 屬性的意義相同。	FlowElement
		trackingLeft : * TextLayoutFormat：以像素為單位代表要套用至每個字元左側字距調整 (手動字距微調) 量的數字 (或 fontSize 的百分比，例如，120%)。	FlowElement
		trackingRight : * TextLayoutFormat：以像素為單位代表要套用至每個字元右側字距調整 (手動字距微調) 量的數字 (或 fontSize 的百分比，例如，120%)。	FlowElement
		typeName : String 每個 FlowElement 都有 typeName。	FlowElement
		typographicCase : * TextLayoutFormat：用於此文字的印刷大小寫類型。	FlowElement
		userStyles : Object 可讓您讀寫 FlowElement 物件上的使用者樣式。	FlowElement
		verticalAlign : * TextLayoutFormat：垂直對齊或齊行 (如果重疊顯示時未定義，則採用預設值)。	FlowElement
		whiteSpaceCollapse : * TextLayoutFormat：將文字匯入 TextFlow 時捨去或保留空格。	FlowElement
		wordSpacing : * TextLayoutFormat：指定對齊時要使用之文字間的最佳、最小及最大間距 (標準間距寬度的倍數)。	FlowElement

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		FlowElement() 基底類別 - 叫用新的 FlowElement() 時擲出錯誤例外。	FlowElement
		clearStyle(styleProp:String):void 清除此 FlowElement 物件中由 styleProp 參數所指定的樣式。	FlowElement
		deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement 製作此 FlowElement 物件 (包含任何子系) 的深層複本，這會複製兩個指定字元位置之間的內容，並傳回複本做為 FlowElement 物件。	FlowElement
		equalUserStyles(otherElement:FlowElement):Boolean 將這一個的 userStyles 與 otherElement 的 userStyles 進行比較。	FlowElement
		getAbsoluteStart():int 傳回文字流排中的元素開始位置做為絕對索引。	FlowElement
		getCharAtPosition(relativePosition:int):String 傳回指定位置的字元 (與此 FlowElement 物件相對的位置)。	FlowElement
		getCharCodeAtPosition(relativePosition:int):int 傳回指定位置的字元碼 (與此 FlowElement 相對的位置)。	FlowElement
		getElementRelativeStart(ancestorElement:FlowElement):int 傳回此元素的開頭 (與祖系元素相對的位置)。	FlowElement
		getNextSibling():FlowElement 傳回文字流排階層中的下一個 FlowElement 同級項目。	FlowElement
		getParagraph():ParagraphElement 傳回與此元素相關的 ParagraphElement 物件。	FlowElement
		getPreviousSibling():FlowElement 傳回文字流排階層中的上一個 FlowElement 同級項目。	FlowElement
		getStyle(styleProp:String):* 傳回 styleProp 參數所指定的樣式值，此參數會指定樣式名稱，而且可以包含任何使用者樣式名稱。	FlowElement
		getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String 從流排元素取得指定的文字範圍。	FlowElement
		getTextFlow():flashx.textLayout.elements:TextFlow 往上瀏覽文字流排階層，以傳回元素的根 TextFlow 物件。	FlowElement
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		initialized(document:Object, id:String):void 實作物件已經建立而且在 MXML 標籤上指定的所有組件屬性已經初始化後，為 MXML 物件進行呼叫。	FlowElement
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		setStyle(styleProp:String, newValue:*):void 將 styleProp 參數所指定的樣式設為 newValue 參數所指定的值。	FlowElement
		shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement 製作此 FlowElement 物件的複本，這會複製兩個指定字元位置之間的內容。	FlowElement
		splitAtPosition(relativePosition:int):FlowElement 在 relativePosition 參數指定的位置分割此 FlowElement 物件，而此參數是此元素在文字中的相對位置。	FlowElement
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 會傳回指定之物件的字串形式。	Object
		valueOf():Object 會傳回指定之物件的基本值。	Object

屬性詳細資訊

alignmentBaseline

屬性

alignmentBaseline:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定主基線對齊的基線。例如，如果設定 dominantBaseline 為 ASCENT，設定 alignmentBaseline 為 DESCENT 會使得文字上方對齊 DESCENT 基線，或在基線之下。通常是由字行中的最大元素決定基線。

baselines

有效值是 TextBaseline.ROMAN、TextBaseline.ASCENT、TextBaseline.DESCENT、TextBaseline.IDEOGRAPHIC_TOP、TextBaseline.IDEOGRAPHIC_CENTER、TextBaseline.IDEOGRAPHIC_BOTTOM、TextBaseline.USE_DOMINANT_BASELINE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextBaseline.USE_DOMINANT_BASELINE。

實作
public function get alignmentBaseline():*
public function set alignmentBaseline(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.TextBaseline

backgroundAlpha

屬性

backgroundAlpha:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：背景的 Alpha (透明度) 值 (如果重疊顯示時未定義，則採用預設值)。值為 0 時表示完全透明，值為 1 時表示完全不透明。alpha 設為 0 的顯示物件都是作用中的狀態，即使看不見它們亦然。

有效值是從 0 到 1 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 1。

實作
public function get backgroundAlpha():*
public function set backgroundAlpha(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

backgroundColor

屬性

backgroundColor:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字的背景色彩 (如果重疊顯示時未定義，則採用預設值)。可以是常數值 BackgroundColor.TRANSPARENT，或指定 3 個 8 位元 RGB (紅色、綠色、藍色) 值的 16 進位值；例如，0xFF0000 是紅色，而 0x00FF00 是綠色。

有效字串值為 BackgroundColor.TRANSPARENT、FormatValue.INHERIT 以及從 0x0 到 0xffffffff 的單位。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 BackgroundColor.TRANSPARENT。

實作
public function get backgroundColor():*
public function set backgroundColor(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

baselineShift

屬性

baselineShift:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：從 dominantBaseline 值位移基線的量。單位為像素，或 fontSize 的百分比 (在此情況下，請輸入字串值，如 140%)。正值會將水平文字上移 (垂直文字則右移)，負值則會將水平文字下移 (垂直文字則左移)。

有效值是 BaselineShift.SUPERSCRIPT、BaselineShift.SUBSCRIPT、FormatValue.INHERIT。

有效值是從 -1000 到 1000 之間的數字。

有效值是從 -1000 到 1000 之間數字的百分比。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0.0。

實作
public function get baselineShift():*
public function set baselineShift(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.BaselineShift

blockProgression

屬性

blockProgression:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定行位置為垂直或水平走向。行由上到下 (BlockProgression.TB，用於水平文字) 排列，或由右向左 (BlockProgression.RL，用於垂直文字) 排列。

有效值是 BlockProgression.RL、BlockProgression.TB、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 BlockProgression.TB。

實作
public function get blockProgression():*
public function set blockProgression(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

breakOpportunity

屬性

breakOpportunity:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：將換行文字斷行時，控制斷行的位置。設定為 BreakOpportunity.AUTO 以一般方式斷行。設定為 BreakOpportunity.NONE 則文字不斷行，除非文字超過度量且沒有其他空間可斷行。。設定為 BreakOpportunity.ANY 可在任意位置斷行，而非只限於在單字之間斷行。設定為 BreakOpportunity.ALL 使每個印刷群集放置於個別行 (對路徑上的文字很實用)。

有效值為 BreakOpportunity.ALL、BreakOpportunity.ANY、BreakOpportunity.AUTO、BreakOpportunity.NONE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 BreakOpportunity.AUTO。

實作
public function get breakOpportunity():*
public function set breakOpportunity(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.BreakOpportunity

cffHinting

屬性

cffHinting:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：用於此文字的 CFF 提示類型。CFF 提示會決定 Flash 執行階段是否強制強式水平詞幹以符合子像素格線。只有當 renderingMode 屬性設定為 RenderingMode.CFF，且字體為內嵌時 (fontLookup 屬性設定為 FontLookup.EMBEDDED_CFF)，才會套用此屬性。在小型螢幕上，提示會為讀者產生清晰、易辨識的文字。

有效值為 CFFHinting.NONE、CFFHinting.HORIZONTAL_STEM、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 CFFHinting.HORIZONTAL_STEM。

實作
public function get cffHinting():*
public function set cffHinting(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.CFFHinting

clearFloats

屬性

clearFloats:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：控制文字包圍在浮動物件四周的方式。若值為 none，將允許文字以最緊密的方式圍繞在浮動物件的四周。若值為 left，將導致文字略過含有左邊浮動物件之容器的任何部分；若值為 right，將導致文字略過含有右邊浮動物件之容器的任何部分。若值為 both，將導致文字略過所有的浮動物件。

有效值為 ClearFloats.START、ClearFloats.END、ClearFloats.LEFT、ClearFloats.RIGHT、ClearFloats.BOTH、ClearFloats.NONE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 ClearFloats.NONE。

實作
public function get clearFloats():*
public function set clearFloats(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.ClearFloats

color

屬性

color:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字的色彩。指定 3 個 8 位元 RGB (紅色、綠色、藍色) 值的 16 進位數字；例如 0xFF0000 為紅色，而 0x00FF00 為綠色。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get color():*
public function set color(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

columnCount

屬性

columnCount:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字欄的數目 (如果重疊顯示時未定義，則採用預設值)。欄的數目會覆寫其他的欄設定。值為整數，如果未指定值，則為 FormatValue.AUTO。如果未指定 columnCount，則會使用 columnWidth 建立容器內可容納的最大欄位數目。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 1 至 50 的整數。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get columnCount():*
public function set columnCount(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.FormatValue

columnGap

屬性

columnGap:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：以像素為單位，指定欄之間所留間距空間的量 (如果重疊顯示時未定義，則採用預設值)。值為數字

有效值是從 0 到 1000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 20。

實作
public function get columnGap():*
public function set columnGap(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

columnWidth

屬性

columnWidth:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：以像素為單位的欄寬 (如果重疊顯示時未定義，則採用預設值)。如果您指定欄的寬度，而非數目，則在具有容器寬度和 columnGap 設定的情況下，TextLayout 會儘可能建立符合該寬度的最大欄數。在最後一欄之後，任何剩餘的空格都是靠左對齊。值為數字。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 0 到 8000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get columnWidth():*
public function set columnWidth(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.FormatValue

computedFormat

屬性

computedFormat:flashx.textLayout.formats:ITextLayoutFormat [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回對此元素使用的計算格式特質。請考量父元素的特質繼承性。

實作
public function get computedFormat():flashx.textLayout.formats:ITextLayoutFormat

相關 API 元素

ITextLayoutFormat

coreStyles

屬性

coreStyles:Object [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回此 FlowElement 的 coreStyles。注意：getter 會複製核心樣式字典。coreStyles 物件會封裝由 TextLayoutFormat 定義且位於 TextLayoutFormat.description 中的格式。coreStyles 物件包含一個 stylename-value 組的陣列。

實作
public function get coreStyles():Object

digitCase

屬性

digitCase:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：用於此文字的數字大小寫類型。設定值為 DigitCase.OLD_STYLE 會使用不同的字母上緣和字母下緣模擬小寫字體。數字是等比例的間距。只有在選取的字樣中可使用此樣式，大部分是在補充或專業字體中。DigitCase.LINING 設定具有全部大寫字高度，而且通常在圖表中以固定間距排列。

digitCase

有效值為 DigitCase.DEFAULT、DigitCase.LINING、DigitCase.OLD_STYLE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 DigitCase.DEFAULT。

實作
public function get digitCase():*
public function set digitCase(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.DigitCase

digitWidth

屬性

digitWidth:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：用於此文字的數字寬度類型。這可以是 DigitWidth.PROPORTIONAL (對於個別數字的顯示效果最佳) 或 DigitWidth.TABULAR (最適用於表格、圖表及垂直行中的數字)。

digitWidth

有效值為 DigitWidth.DEFAULT、DigitWidth.PROPORTIONAL、DigitWidth.TABULAR、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 DigitWidth.DEFAULT。

實作
public function get digitWidth():*
public function set digitWidth(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.DigitWidth

direction

屬性

direction:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定文字區塊內文字的預設雙向內嵌層級。由左向右的讀取順序，如同拉丁文樣式手寫體，或由右向左的讀取順序，如同阿拉伯文或希伯來文。在容器層級套用此屬性時，它也會影響欄方向。就像文字一樣，欄可以由左向右或由右向左。下面是一些範例：

direction

有效值為 Direction.LTR、Direction.RTL、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 Direction.LTR。

實作
public function get direction():*
public function set direction(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.Direction

dominantBaseline

屬性

dominantBaseline:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定貼齊 alignmentBaseline 的元素基線，以決定行上元素的垂直位置。TextBaseline.AUTO 的值根據父段落的 locale 屬性選取主基線。針對日文與中文，選取的基線值為 TextBaseline.IDEOGRAPHIC_CENTER；其他則為 TextBaseline.ROMAN。這些基線的選擇是由字體及字體大小的選擇所決定。

baselines

有效值為 FormatValue.AUTO、TextBaseline.ROMAN、TextBaseline.ASCENT、TextBaseline.DESCENT、TextBaseline.IDEOGRAPHIC_TOP、TextBaseline.IDEOGRAPHIC_CENTER、TextBaseline.IDEOGRAPHIC_BOTTOM、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FormatValue.AUTO。

實作
public function get dominantBaseline():*
public function set dominantBaseline(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.TextBaseline

firstBaselineOffset

屬性

firstBaselineOffset:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定容器中第一行的基線位置。此屬性參照的基線，是依據容器層級地區而定。對於日文和中文，它會是 TextBaseline.IDEOGRAPHIC_BOTTOM；而對於所有其他語言，則為 TextBaseline.ROMAN。從容器的上方內移距 (或如果 blockProgression 是 RL，則為右方內移距) 到首行基線的偏移量，可以是 BaselineOffset.ASCENT (相當於字行上緣)、BaselineOffset.LINE_HEIGHT (相當於首行高度)，或任何固定值數字，以指定絕對距離。BaselineOffset.AUTO 對齊字行上緣與容器上方內移距。

firstBaselineOffset1 firstBaselineOffset2 firstBaselineOffset3 firstBaselineOffset4

有效字串值為 BaselineOffset.AUTO、BaselineOffset.ASCENT、BaselineOffset.LINE_HEIGHT、FormatValue.INHERIT 以及從 0 到 1000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 BaselineOffset.AUTO。

實作
public function get firstBaselineOffset():*
public function set firstBaselineOffset(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

fontFamily

屬性

fontFamily:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：要使用的字體名稱，或是以逗號分隔的字體名稱清單。Flash 執行階段會以清單中的第一個可用字體來顯示元素。例如，Arial, Helvetica, _sans 會讓 Player 先搜尋 Arial，如果找不到 Arial 則搜尋 Helvetica，如果這兩項都找不到，則搜尋 _sans。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 Arial。

實作
public function get fontFamily():*
public function set fontFamily(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

fontLookup

屬性

fontLookup:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：要使用字體查詢。指定 FontLookup.DEVICE 使用執行 SWF 檔案之系統上所安裝的字體。裝置字體會導致影片大小變得較小，但文字在不同系統及平台間的顯示不盡相同。指定 FontLookup.EMBEDDED_CFF 使用內嵌於已發佈的 SWF 檔案的字體外框。內嵌的字體會增加 SWF 檔案的大小 (有時差距極大)，但文字會一律以所選的字體顯示。

有效值為 FontLookup.DEVICE、FontLookup.EMBEDDED_CFF、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FontLookup.DEVICE。

實作
public function get fontLookup():*
public function set fontLookup(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.FontLookup

fontStyle

屬性

fontStyle:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字樣式。可以是 FontPosture.NORMAL (用於純文字) 或 FontPosture.ITALIC (用於斜體字)。此屬性只套用到裝置字體 (fontLookup 屬性設定為 flash.text.engine.FontLookup.DEVICE)。

有效值是 FontPosture.NORMAL、FontPosture.ITALIC、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FontPosture.NORMAL。

實作
public function get fontStyle():*
public function set fontStyle(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.FontPosture

fontWeight

屬性

fontWeight:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：字體粗細。可以是 FontWeight.NORMAL (用於純文字) 或 FontWeight.BOLD。只套用到裝置字體 (fontLookup 屬性設定為 flash.text.engine.FontLookup.DEVICE)。

有效值為 FontWeight.NORMAL、FontWeight.BOLD、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FontWeight.NORMAL。

實作
public function get fontWeight():*
public function set fontWeight(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.FontWeight

format

屬性

format:flashx.textLayout.formats:ITextLayoutFormat

直接套用至此元素的 TextLayoutFormat 屬性。

每個元素可能會將已套用的屬性當成其格式一部分。套用至此元素的屬性會覆寫繼承自父輩的屬性。如果未覆寫子系中的屬性，則套用至此元素的屬性會由元素的子系來繼承這些屬性。如果元素未套用任何屬性，則這會是 null。

實作
public function get format():flashx.textLayout.formats:ITextLayoutFormat
public function set format(value:flashx.textLayout.formats:ITextLayoutFormat):void

id

屬性

id:String

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

指定元素的識別名稱，如此只要參照此 id 就可以設定元素的樣式。例如，下行設定 id 為 span1 之 SpanElement 物件的顏色：

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);

實作
public function get id():String
public function set id(value:String):void

相關 API 元素

TextFlow.getElementByID()

justificationRule

屬性

justificationRule:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：對齊段落中文字所使用的規則。預設值為 FormatValue.AUTO，可根據段落的 locale 屬性來對齊文字。除了日文與中文之外的所有語言，FormatValue.AUTO 會成為 JustificationRule.SPACE，可為空白字元增加額外的空間。針對日文與中文，FormatValue.AUTO 會成為 JustficationRule.EAST_ASIAN。對齊在某種程度上會變更標點符號的間距。在羅馬文字中，逗號與日文句號佔用完整的字元寬度，但是在東亞文字中，則只有一半的字元寬度。此外，在東亞文字中，連續標點符號之間的間距會變得較小，以遵循傳統東亞印刷慣例。請注意，下列範例中，行距會套用至段落的第二行。在東亞版本中，最後兩行向左推送。在羅馬版本中，第二行以及接續的字行向左推送。

justificationRule

有效值為 JustificationRule.EAST_ASIAN、JustificationRule.SPACE、FormatValue.AUTO、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FormatValue.AUTO。

實作
public function get justificationRule():*
public function set justificationRule(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

justificationStyle

屬性

justificationStyle:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：段落對齊所用的樣式。只能與 JustificationRule.EAST_ASIAN 的 justificationRule 設定一起使用。FormatValue.AUTO 的預設值針對所有地區設定解析為 JustificationStyle.PUSH_IN_KINSOKU。JustificationStyle 類別定義的常數指定處理避頭尾字元 (不能在字行開頭或結尾出現的日文字元) 的選項。如果您要加寬文字，請指定 JustificationStyle.PUSH-OUT-ONLY。如果您想要讓行為的效果類似使用 JustificationRule.SPACE 的 justificationRule 的效果，請使用 JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT。

有效值為 JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT、JustificationStyle.PUSH_IN_KINSOKU、JustificationStyle.PUSH_OUT_ONLY、FormatValue.AUTO、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 FormatValue.AUTO。

實作
public function get justificationStyle():*
public function set justificationStyle(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.JustificationStyle

kerning

屬性

kerning:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：字距微調會調整某些字元組之間的像素，以改善可讀性。具有特殊字距表的所有字體都支援特殊字距。

有效值為 Kerning.ON、Kerning.OFF、Kerning.AUTO、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 Kerning.AUTO。

實作
public function get kerning():*
public function set kerning(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.Kerning

leadingModel

屬性

leadingModel:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定行距模型，它結合了行距基礎及行距方向。行距基礎是 lineHeight 屬性參照的基線。行矩方向決定 lineHeight 屬性參照的是某線條基線與其前線條之間的距離，或是與其後線條之間的距離。FormatValue.AUTO 的預設值乃是根據段落的 locale 屬性來解析。對於日文和中文，它會是 LeadingModel.IDEOGRAPHIC_TOP_DOWN，而對於所有其他語言，則是 LeadingModel.ROMAN_UP。

行距基礎：

leadingBasis1 leadingBasis2 leadingBasis3

行距方向：

leadingDirection1 leadingDirection2 leadingDirection3

有效值為 LeadingModel.ROMAN_UP、LeadingModel.IDEOGRAPHIC_TOP_UP、LeadingModel.IDEOGRAPHIC_CENTER_UP、LeadingModel.IDEOGRAPHIC_TOP_DOWN、LeadingModel.IDEOGRAPHIC_CENTER_DOWN、LeadingModel.APPROXIMATE_TEXT_FIELD、LeadingModel.ASCENT_DESCENT_UP、LeadingModel.BOX、LeadingModel.AUTO、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 LeadingModel.AUTO。

實作
public function get leadingModel():*
public function set leadingModel(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.LeadingModel

ligatureLevel

屬性

ligatureLevel:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：控制字體中定義的哪些連字可用於文字。這些設定的每一個所顯示的連字與字體有相依性。當兩個以上的字母形式接合為單一字符時，會發生連字。連字通常會取代共享相同組件的連續字元，如字母組「fi」、「fl」或「ae」。連字可用於拉丁文和非拉丁文字元集。由於 LigatureLevel 類別的值 - MINIMUM、COMMON、UNCOMMON 與 EXOTIC 所啟用的連字具有累增效果。每個值啟用一組新的連字，但也包括先前類型。

注意：使用阿拉伯文或斯拉夫文字體時，ligatureLevel 必須設為 MINIMUM 或更大值。

ligatureLevel

有效值為 LigatureLevel.MINIMUM、LigatureLevel.COMMON、LigatureLevel.UNCOMMON、LigatureLevel.EXOTIC、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 LigatureLevel.COMMON。

實作
public function get ligatureLevel():*
public function set ligatureLevel(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.LigatureLevel

lineBreak

屬性

lineBreak:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：控制容器內的文字換行 (如果重疊顯示時未定義，則採用預設值)。容器中的文字可設定為符合容器寬度 (LineBreak.TO_FIT)，或者可設定為只在明確的歸位字元或換行字元 (LineBreak.EXPLICIT) 時斷行。

有效值是 LineBreak.EXPLICIT、LineBreak.TO_FIT、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 LineBreak.TO_FIT。

實作
public function get lineBreak():*
public function set lineBreak(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.LineBreak

lineHeight

屬性

lineHeight:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字的行距控制。上一行或下一行基線 (根據 LeadingModel) 到目前字行基線的距離等於字行中任一字元所套用的最大行距。這可以是數字或百分比。如果指定百分比，請輸入字串值，如 140%。

lineHeight1 lineHeight2

有效值是從 -720 到 720 之間的數字。

有效值是從 -1000% 到 1000% 之間數字的百分比。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 120%。

實作
public function get lineHeight():*
public function set lineHeight(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

lineThrough

屬性

lineThrough:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：若為 true，將套用刪除線，亦即通過文字中間的線。

有效值為 true、false 與 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 false。

實作
public function get lineThrough():*
public function set lineThrough(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

linkActiveFormat

屬性

linkActiveFormat:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：定義正常狀態下的連結格式化特質。這個值會貫穿整個階層而且會套用至任何為後代的連結。接受 inherit、ITextLayoutFormat 或將具有索引鍵及值做為成員的物件陣列轉換為 TextLayoutFormat。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 null。

實作
public function get linkActiveFormat():*
public function set linkActiveFormat(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

linkHoverFormat

屬性

linkHoverFormat:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：定義滑鼠位於連結範圍 (滑入) 時，停留狀態連結的格式化特質。這個值會貫穿整個階層而且會套用至任何為後代的連結。接受 inherit、ITextLayoutFormat 或將具有索引鍵及值做為成員的物件陣列轉換為 TextLayoutFormat。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 null。

實作
public function get linkHoverFormat():*
public function set linkHoverFormat(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

linkNormalFormat

屬性

linkNormalFormat:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 null。

實作
public function get linkNormalFormat():*
public function set linkNormalFormat(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

listAutoPadding

屬性

listAutoPadding:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：當清單開始邊緣該側的邊框距離值設為 auto 時，這會將清單的開始邊緣指定為自動縮排。

有效值是從 -1000 到 1000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 40。

實作
public function get listAutoPadding():*
public function set listAutoPadding(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

listMarkerFormat

屬性

listMarkerFormat:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：定義格式化特質清單標記。這個值會貫穿整個階層而且會套用至任何為後代的連結。接受 inherit、IListMarkerFormat 或將具有索引鍵及值做為成員的物件陣列轉換為 ListMarkerFormat。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 null。

實作
public function get listMarkerFormat():*
public function set listMarkerFormat(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

listStylePosition

屬性

listStylePosition:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat:

有效值為 ListStylePosition.INSIDE、ListStylePosition.OUTSIDE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 ListStylePosition.OUTSIDE。

實作
public function get listStylePosition():*
public function set listStylePosition(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

listStyleType

屬性

listStyleType:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat:

有效值為 ListStyleType.UPPER_ALPHA、ListStyleType.LOWER_ALPHA、ListStyleType.UPPER_ROMAN、ListStyleType.LOWER_ROMAN、ListStyleType.NONE、ListStyleType.DISC、ListStyleType.CIRCLE、ListStyleType.SQUARE、ListStyleType.BOX、ListStyleType.CHECK、ListStyleType.DIAMOND、ListStyleType.HYPHEN、ListStyleType.ARABIC_INDIC、ListStyleType.BENGALI、ListStyleType.DECIMAL、ListStyleType.DECIMAL_LEADING_ZERO、ListStyleType.DEVANAGARI、ListStyleType.GUJARATI、ListStyleType.GURMUKHI、ListStyleType.KANNADA、ListStyleType.PERSIAN、ListStyleType.THAI、ListStyleType.URDU、ListStyleType.CJK_EARTHLY_BRANCH、ListStyleType.CJK_HEAVENLY_STEM、ListStyleType.HANGUL、ListStyleType.HANGUL_CONSTANT、ListStyleType.HIRAGANA、ListStyleType.HIRAGANA_IROHA、ListStyleType.KATAKANA、ListStyleType.KATAKANA_IROHA、ListStyleType.LOWER_ALPHA、ListStyleType.LOWER_GREEK、ListStyleType.LOWER_LATIN、ListStyleType.UPPER_ALPHA、ListStyleType.UPPER_GREEK、ListStyleType.UPPER_LATIN、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 ListStyleType.DISC。

實作
public function get listStyleType():*
public function set listStyleType(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.ListStyleType

locale

屬性

locale:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字的地區設定。控制大小寫轉換和形狀。使用 Unicode Technical Standard #35 中描述的標準地區識別名稱。例如 en、en_US 以及 en-US 都是英文，ja 則是日文。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 en。

實作
public function get locale():*
public function set locale(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paddingBottom

屬性

paddingBottom:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：下方內移距 (像素)。除了開端邊框距離為 45 的清單以外，auto 的預設值均為零 (如果重疊顯示時未定義，則採用預設值)。容器下方邊緣與文字之間的間距。值為 Number 或 auto。

使用水平文字時，在具有多欄的可捲動容器中，第一欄及接續各欄會在容器結尾以空格顯示邊框距離，但在最後一欄，如果文字無法完全填入，則必須捲動才能看到邊框距離。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 -8000 到 8000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get paddingBottom():*
public function set paddingBottom(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paddingLeft

屬性

paddingLeft:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：左方內移距 (像素)。除了開端邊框距離為 45 的清單以外，auto 的預設值均為零 (如果重疊顯示時未定義，則採用預設值)。容器左方邊緣與文字之間的間距。值為 Number 或 auto。

使用垂直文字時，在具有多欄的可捲動容器中，第一欄及接續各欄會在容器結尾以空格顯示邊框距離，但在最後一欄，如果文字無法完全填入，則必須捲動才能看到邊框距離。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 -8000 到 8000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get paddingLeft():*
public function set paddingLeft(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paddingRight

屬性

paddingRight:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：右方內移距 (像素)。除了開端邊框距離為 45 的清單以外，auto 的預設值均為零 (如果重疊顯示時未定義，則採用預設值)。容器右方邊緣與文字之間的間距。值為 Number 或 auto。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 -8000 到 8000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get paddingRight():*
public function set paddingRight(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paddingTop

屬性

paddingTop:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：上方內移距 (像素)。除了開端邊框距離為 45 的清單以外，auto 的預設值均為零 (如果重疊顯示時未定義，則採用預設值)。容器上方邊緣與文字之間的間距。值為 Number 或 auto。

有效字串值為 FormatValue.AUTO、FormatValue.INHERIT 以及從 -8000 到 8000 的數字。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 FormatValue.AUTO。

實作
public function get paddingTop():*
public function set paddingTop(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paragraphEndIndent

屬性

paragraphEndIndent:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定段落結尾邊緣縮排量的數字 (以像素為單位)。參考由左至右文字的右邊，與由右至左文字的左邊。

有效值是從 0 到 8000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get paragraphEndIndent():*
public function set paragraphEndIndent(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paragraphSpaceAfter

屬性

paragraphSpaceAfter:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：一個數字，指定段落後面要保留的空間量 (像素)。使用 paragraphSpaceBefore 在前後收合。

有效值是從 0 到 8000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get paragraphSpaceAfter():*
public function set paragraphSpaceAfter(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paragraphSpaceBefore

屬性

paragraphSpaceBefore:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：一個數字，指定段落前面要保留的空間量 (像素)。使用 paragraphSpaceAfter 在前後收合。

有效值是從 0 到 8000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get paragraphSpaceBefore():*
public function set paragraphSpaceBefore(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

paragraphStartIndent

屬性

paragraphStartIndent:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定段落開頭邊緣縮排量的數字 (以像素為單位)。參考由左至右文字的左邊，與由右至左文字的右邊。

有效值是從 0 到 8000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get paragraphStartIndent():*
public function set paragraphStartIndent(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

parent

屬性

parent:FlowGroupElement [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回此 FlowElement 物件的父輩。每個 FlowElement 最多會有一個父輩。

實作
public function get parent():FlowGroupElement

parentRelativeEnd

屬性

parentRelativeEnd:int [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回父輩中此 FlowElement 物件的相對結尾。如果父輩是 null，則這一律會等於 textLength。如果父輩不是 null，則此值是此項目與所有先前同級項目的文字長度總和，而這會是下一個 FlowElement 物件中的第一個字元。

實作
public function get parentRelativeEnd():int

相關 API 元素

FlowGroupElement
textLength

parentRelativeStart

屬性

parentRelativeStart:int [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回父輩中此 FlowElement 物件的相對開頭。如果父輩是 null，則此值一律是零。如果父輩不是 null，則此值是所有先前同級項目的文字長度總和。

實作
public function get parentRelativeStart():int

相關 API 元素

textLength

renderingMode

屬性

renderingMode:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：用於此文字的顯示模式。只套用到內嵌字體 (fontLookup 屬性設定為 FontLookup.EMBEDDED_CFF)。

有效值是 RenderingMode.NORMAL、RenderingMode.CFF、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 RenderingMode.CFF。

實作
public function get renderingMode():*
public function set renderingMode(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.RenderingMode

styleName

屬性

styleName:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定元素的識別類別，如此只要參照此 styleName 就可以設定元素的樣式。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 null。

實作
public function get styleName():*
public function set styleName(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

styles

屬性

styles:Object [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回此 FlowElement 的樣式。注意：getter 會複製樣式字典。傳回的物件會封裝已設定於包含核心與使用者樣式之格式屬性的所有樣式。傳回的物件包含一個 stylename-value 組的陣列。

實作
public function get styles():Object

tabStops

屬性

tabStops:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定段落關聯的定位停駐點。Setter 可以使用 TabStopFormat 的陣列、壓縮字串表示法、未定義或 FormatValue.INHERIT。壓縮字串表示法一律轉換為 TabStopFormat 的陣列。

字串基礎格式是一份定位停駐點清單，其中使用一或多個空格分隔每個定位停駐點。

定位停駐點會採用下列格式：<alignment type><alignment position>|<alignment token>。

對齊類型是單一字元，可以是 S、E、C 或 D (或對等的小寫字母)。S 或 s 表示開頭 (start)，E 或 e 表示結尾 (end)，C 或 c 表示中間 (center)，D 或 d 表示小數 (decimal)。對齊類型是選擇性項目，如果未指定，則預設為 S。

對齊位置是一個數字，並根據數字 (小數或科學標記法) 的 FXG 規格指定。需要有對齊位置。

垂直分隔列用於分隔對齊位置與對齊字符，並應只在對齊字符存在時才出現。

如果對齊類型是 D，則對齊字符為選擇性，而且如果對齊類型不是 D，就不應出現。對齊字符可以是由任何結束定位停駐點的空格所終止的字元順序 (對於最後一個定位停駐點而言，終止間距是選擇性的；對齊字符的結尾是隱含的)。如果使用反斜線 (\) 跳開，則空格可做為對齊字符的一部分。如果使用另一個反斜線 (\\) 跳開，則反斜線可做為對齊字符的一部分。如果對齊方式類型為 D，且未指定對齊字符，則會採用 null 預設值。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 null。

實作
public function get tabStops():*
public function set tabStops(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.TabStopFormat

textAlign

屬性

textAlign:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：段落中各行相對於容器的對齊方式。TextAlign.LEFT 沿著容器左方邊緣對齊字行。TextAlign.RIGHT 對齊右方邊緣。TextAlign.CENTER 讓字行的左方及右方邊緣等距。TextAlign.JUSTIFY 會延展行以填滿空間。TextAlign.START 等同於設定由左向右文字的靠左對齊，或由右向左文字的靠右對齊。TextAlign.END 等同於設定由左向右文字的靠右對齊，或由右向左文字的靠左對齊。

有效值為 TextAlign.LEFT、TextAlign.RIGHT、TextAlign.CENTER、TextAlign.JUSTIFY、TextAlign.START、TextAlign.END、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextAlign.START。

實作
public function get textAlign():*
public function set textAlign(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.TextAlign

textAlignLast

屬性

textAlignLast:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：段落中最後 (或唯一的) 一行相對於齊行文字中之容器的對齊方式。如果 textAlign 設定為 TextAlign.JUSTIFY，textAlignLast 會指定最後一行 (或唯一的一行，如果這是一個單行區塊時) 的對齊方式。值類似於 textAlign。

有效值為 TextAlign.LEFT、TextAlign.RIGHT、TextAlign.CENTER、TextAlign.JUSTIFY、TextAlign.START、TextAlign.END、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextAlign.START。

實作
public function get textAlignLast():*
public function set textAlignLast(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.TextAlign

textAlpha

屬性

textAlpha:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字的 Alpha (透明) 值。值為 0 時表示完全透明，值為 1 時表示完全不透明。textAlpha 設為 0 的顯示物件都是作用中狀態，即便看不見亦是如此。

有效值是從 0 到 1 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 1。

實作
public function get textAlpha():*
public function set textAlpha(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

textDecoration

屬性

textDecoration:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：文字上的裝飾。用於套用底線；預設為 none。

有效值為 TextDecoration.NONE、TextDecoration.UNDERLINE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextDecoration.NONE。

實作
public function get textDecoration():*
public function set textDecoration(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

textIndent

屬性

textIndent:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：以像素為單位，指定段落中第一行縮排量的數字。負值縮排會將行推向邊界，因而可能超出容器。

有效值是從 -8000 到 8000 的數字以及 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get textIndent():*
public function set textIndent(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

textJustify

屬性

textJustify:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定對齊文字的選項。預設值為 TextJustify.INTER_WORD，表示將額外空間增加到空白字元。TextJustify.DISTRIBUTE 將額外空間增加到空白字元以及個別字母之間。僅與 JustificationRule.SPACE 的 justificationRule 值一併使用。

有效值為 TextJustify.INTER_WORD、TextJustify.DISTRIBUTE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextJustify.INTER_WORD。

實作
public function get textJustify():*
public function set textJustify(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.TextJustify

textLength

屬性

textLength:int [唯讀]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回此 FlowElement 物件及其子系所擁有的文字總長度。如果元素沒有文字，則 textLength 的值通常是零。

ParagraphElement 物件的最終範圍具有最後一個 SpanElement 物件的段落結束字元。段落結束字元將併入該 SpanElement 物件及其所有父輩的 textLength 值中。它不會併入 SpanElement 物件的 text 屬性中。

實作
public function get textLength():int

相關 API 元素

textLength

textRotation

屬性

textRotation:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：決定此文字要旋轉的度數。

有效值為 TextRotation.ROTATE_0、TextRotation.ROTATE_180、TextRotation.ROTATE_270、TextRotation.ROTATE_90、TextRotation.AUTO、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TextRotation.AUTO。

實作
public function get textRotation():*
public function set textRotation(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flash.text.engine.TextRotation

tracking

屬性

tracking:Object [唯寫]

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

設定字距調整，且與 trackingRight 屬性的意義相同。指定為像素數或 fontSize 的百分比。

實作
public function set tracking(value:Object):void

相關 API 元素

trackingRight

trackingLeft

屬性

trackingLeft:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：以像素為單位代表要套用至每個字元左側字距調整 (手動字距微調) 量的數字 (或 fontSize 的百分比，例如，120%)。如果已啟用特殊字距，trackingLeft 值就會加入到該字體之特殊字距表中的值。如果已停用特殊字距，trackingLeft 值會當做手動特殊字距值來使用。同時支援正值與負值。

有效值是從 -1000 到 1000 之間的數字。

有效值是從 -1000% 到 1000% 之間數字的百分比。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get trackingLeft():*
public function set trackingLeft(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

trackingRight

屬性

trackingRight:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：以像素為單位代表要套用至每個字元右側字距調整 (手動字距微調) 量的數字 (或 fontSize 的百分比，例如，120%)。如果已啟用特殊字距，trackingRight 值就會加入到該字體之特殊字距表中的值。如果已停用特殊字距，trackingRight 值會當做手動特殊字距值來使用。同時支援正值與負值。

有效值是從 -1000 到 1000 之間的數字。

有效值是從 -1000% 到 1000% 之間數字的百分比。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 0。

實作
public function get trackingRight():*
public function set trackingRight(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

typeName

屬性

typeName:String

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

每個 FlowElement 都有 typeName。typeName 預設為 TextConverter 使用的字串 textLayoutFormat。此 API 可用來將不同的 typeName 設定至 FlowElement。通常這樣做是為了支援 CSS 中的 type 選取器。

如需如何使用此動作的相關資訊，請參閱 TEXT_FIELD_HTML_FORMAT 文件。

實作
public function get typeName():String
public function set typeName(value:String):void

typographicCase

屬性

typographicCase:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：用於此文字的印刷大小寫類型。下面是一些範例：

typographicCase

有效值是 TLFTypographicCase.DEFAULT、TLFTypographicCase.CAPS_TO_SMALL_CAPS、TLFTypographicCase.UPPERCASE、TLFTypographicCase.LOWERCASE、TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 TLFTypographicCase.DEFAULT。

實作
public function get typographicCase():*
public function set typographicCase(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

userStyles

屬性

userStyles:Object

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

可讓您讀寫 FlowElement 物件上的使用者樣式。注意：讀取此屬性會複製設定於此元素格式中的 userStyles。

實作
public function get userStyles():Object
public function set userStyles(value:Object):void

verticalAlign

屬性

verticalAlign:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：垂直對齊或齊行 (如果重疊顯示時未定義，則採用預設值)。決定容器內 TextFlow 元素的對齊方式。

有效值是 VerticalAlign.TOP、VerticalAlign.MIDDLE、VerticalAlign.BOTTOM、VerticalAlign.JUSTIFY、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義，則此屬性的值就會是 VerticalAlign.TOP。

實作
public function get verticalAlign():*
public function set verticalAlign(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

相關 API 元素

flashx.textLayout.formats.VerticalAlign

whiteSpaceCollapse

屬性

whiteSpaceCollapse:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：將文字匯入 TextFlow 時捨去或保留空格。WhiteSpaceCollapse.PRESERVE 保留所有空白字元。WhiteSpaceCollapse.COLLAPSE 移除匯入文字區塊內的換行、定位點以及開頭和結尾空白。斷行標籤 () 和 Unicode 字行分隔符號字元都將保留。

有效值為 WhiteSpaceCollapse.PRESERVE、WhiteSpaceCollapse.COLLAPSE、FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 WhiteSpaceCollapse.COLLAPSE。

實作
public function get whiteSpaceCollapse():*
public function set whiteSpaceCollapse(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

wordSpacing

屬性

wordSpacing:*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

TextLayoutFormat：指定對齊時要使用之文字間的最佳、最小及最大間距 (標準間距寬度的倍數)。最佳間距可用來指定所需的間距大小，以作為字體中定義之值的分數。textJustify 為均分時會使用最小和最大值，以決定文字之間的間距寬窄，然後才使用字元間距來對齊行。

有效值是從 -1000% 到 1000% 之間數字的百分比。

有效值包括 FormatValue.INHERIT。

若未定義預設值，則表示未設定。

如果重疊顯示時未定義此屬性，則此屬性將繼承祖系的值。如果沒有祖系設定此屬性，則值將為 100%、50%、150%。

實作
public function get wordSpacing():*
public function set wordSpacing(value:any):void

擲回值

RangeError — 設定時值不在此屬性的範圍內

建構函式詳細資料

()

建構函式

public function FlowElement()

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

基底類別 - 叫用新的 FlowElement() 時擲出錯誤例外。

方法詳細資訊

clearStyle

()

方法

public function clearStyle(styleProp:String):void

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

清除此 FlowElement 物件中由 styleProp 參數所指定的樣式。將值設定成 undefined。

參數

styleProp:String — 要清除的樣式名稱。

相關 API 元素

getStyle()
setStyle()
userStyles

範例 ( 如何使用本範例 )

此範例顯示 clearStyle() 將樣式的值設為 undefined，但是仍然可以將繼承值套用至該樣式。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_clearStyleExample extends Sprite{    
        public function FlowElement_clearStyleExample()
        {
            // create a container and a TextFlow object
            var container:Sprite = new Sprite();
            this.addChild(container);
            var textFlow:TextFlow = new TextFlow();
            
            // create a paragraph and set lineThrough style to true 
            var paragraph:ParagraphElement = new ParagraphElement();
            paragraph.setStyle("color", 204);
            // create two spans of text
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();            
            span1.text = "After calling clearStyle(), the value of color for span1 is: ";     
            span2.text = " but the value of span1.getStyle() for color is ";
            span3.text = " because getStyle() returns the inherited value that's applied to the style.";
            span1.clearStyle("color");        // undefined
            span1.text += span1.color;
            paragraph.addChild(span1);
            paragraph.addChild(span2);
            span2.text += span1.getStyle("color");    //204 
            paragraph.addChild(span3);
            
            textFlow.addChild(paragraph);
            // add controller, then update controller to display text
            var firstController:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(firstController);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

deepCopy

()

方法

public function deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

製作此 FlowElement 物件 (包含任何子系) 的深層複本，這會複製兩個指定字元位置之間的內容，並傳回複本做為 FlowElement 物件。

未含任何引數時，deepCopy() 預設會複製整個元素。

參數

	`relativeStart:int` (default = `0`) — 要複製之第一個字元的相對文字位置。第一個位置是 0。

	`relativeEnd:int` (default = `-1`) — 要複製之最後一個字元的相對文字位置。值 -1 指出複製到結尾。

傳回值

FlowElement — 深層複本作業所建立的物件。

相關 API 元素

shallowCopy()

範例 ( 如何使用本範例 )

此範例會建立第二個段落做為第一個段落的深層複本 (以偏移量 3 開始)，並顯示結果。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_deepCopyExample extends Sprite{    
        public function FlowElement_deepCopyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            // add text to the spans and spans to the paragraph
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            // make a deep copy of paragraph p, starting at relative offset 3; copy to end
            var p2:ParagraphElement = p.deepCopy(3, -1) as ParagraphElement; 
            // add copied paragraph (p2) to textflow; add composer and controller 
            // and update controller to display text
            textFlow.addChild(p2);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();    // 'lo, World!'
        }
    }
}

equalUserStyles

()

方法

public function equalUserStyles(otherElement:FlowElement):Boolean

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

將這一個的 userStyles 與 otherElement 的 userStyles 進行比較。

參數

otherElement:FlowElement — 要與使用者樣式進行比較的 FlowElement 物件

傳回值

Boolean — 如果使用者樣式相等，則為 true，否則為 false。

相關 API 元素

getStyle()
setStyle()
userStyles

getAbsoluteStart

()

方法

public function getAbsoluteStart():int

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回文字流排中的元素開始位置做為絕對索引。流排中的第一個字元位置是 0。

傳回值

int — 從 TextFlow 物件開頭算起的元素開始索引。

相關 API 元素

parentRelativeStart
TextFlow

範例 ( 如何使用本範例 )

此範例使用兩個 SpanElement 物件來建立段落，並呼叫 span2.getAbsoluteStart() 以取得 span2 的開始位置。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getAbsoluteStartExample extends Sprite
    {    
        public function FlowElement_getAbsoluteStartExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            // add text to the spans, spans to the paragraph, and paragraph to the text flow
            span1.text = "The start of span2 ";
            span2.text = "in this paragraph is at index: ";
            p.fontSize = 20;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // find the starting position of span2 and update controller to display text
            span2.text += span2.getAbsoluteStart();  // 19
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

getCharAtPosition

()

方法

public function getCharAtPosition(relativePosition:int):String

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回指定位置的字元 (與此 FlowElement 物件相對的位置)。第一個字元位於相對位置 0。

參數

relativePosition:int — 此 FlowElement 物件中字元的相對位置。

傳回值

String — 包含字元的字串。

相關 API 元素

getCharCodeAtPosition()

範例 ( 如何使用本範例 )

此範例傳回 SpanElement 中相對位置 27 的字元。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getCharAtPositionExample extends Sprite
    {        
        public function FlowElement_getCharAtPositionExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to the two spans, calling getCharAtPosition() to return the
            // character at relative position 27 in the first span
            span1.text = "The character at offset 27 in this paragraph is: ";
            span2.text =  span1.getCharAtPosition(27) + ".";    // i
            
            // add spans to paragraph p   
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getCharCodeAtPosition

()

方法

public function getCharCodeAtPosition(relativePosition:int):int

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回指定位置的字元碼 (與此 FlowElement 相對的位置)。第一個字元位於相對位置 0。

參數

relativePosition:int — 此 FlowElement 物件中字元的相對位置。

傳回值

int — 位於指定位置之字元的 Unicode 值。

相關 API 元素

getCharAtPosition()

範例 ( 如何使用本範例 )

此範例傳回 SpanElement 中相對位置 16 之字元的字元碼。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getCharCodeAtPositionExample extends Sprite
    {        
        public function FlowElement_getCharCodeAtPositionExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            //create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to spans; use getCharCodeAtPosition() to add char code from pos. 16
            // of span1
            
            span1.text = "The character code at offset 16 in this paragraph is: ";
            span2.text =  String(span1.getCharCodeAtPosition(16)) + ".";    // 100 (d)
            
            // add spans to paragraph p   
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getElementRelativeStart

()

方法

public function getElementRelativeStart(ancestorElement:FlowElement):int

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回此元素的開頭 (與祖系元素相對的位置)。假設祖系元素位在父鏈結中。如果祖系元素是父輩，則與 this.parentRelativeStart 相同。如果祖系元素是上兩層項目，則與 parentRelativeStart 加上 parent.parentRelativeStart 相同，以此類推。

參數

ancestorElement:FlowElement — 想要在其中尋找此元素相對開頭的元素。

傳回值

int — 此元素的偏移量。

相關 API 元素

getAbsoluteStart()

範例 ( 如何使用本範例 )

此範例呼叫 getElementRelativeStart() 以判斷段落內，連結的相對開始位置。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getElementRelativeStartExample extends Sprite
    {        
        public function FlowElement_getElementRelativeStartExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            
            // add text to first two spans
            span1.text = "The relative start of the link SpanElement (";
            span2.text =  ") in this paragraph is at position ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add first span, link, and second span to paragraph p   
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            
            // call getElementRelativeStart() to get start of linkSpan and add to span 3
            span3.text = String(linkSpan.getElementRelativeStart(p)) + ".";  // 44.
            p.addChild(span3);
            
            // add paragraph p to text flow and update controller to display it
            textFlow.addChild(p);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getNextSibling

()

方法

public function getNextSibling():FlowElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回文字流排階層中的下一個 FlowElement 同級項目。

傳回值

FlowElement — 下一個類型相同的 FlowElement 物件，或如果沒有同級項目，則為 null。

相關 API 元素

getPreviousSibling()

範例 ( 如何使用本範例 )

此範例使用兩個 SpanElement 物件來顯示 Hello World，並將 span2.getNextSibling() 的結果設為紅色。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getNextSiblingExample extends Sprite
    {        
        public function FlowElement_getNextSiblingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var nextSpanElement:SpanElement = new SpanElement();
            // add text, set font size, add spans to paragraph, add paragraph to text flow
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // get next SpanElement for span1 and set its color to red; display text
            nextSpanElement = SpanElement(span1.getNextSibling());
            nextSpanElement.color = 0xCC0000;
            textFlow.flowComposer.addController(new ContainerController(this,stage.stageWidth,stage.stageHeight));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

getParagraph

()

方法

public function getParagraph():ParagraphElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回與此元素相關的 ParagraphElement 物件。它會查閱文字流排階層，並傳回第一個 ParagraphElement 物件。

傳回值

ParagraphElement — 與此 FlowElement 物件相關的 ParagraphElement 物件。

相關 API 元素

getTextFlow()
ParagraphElement

範例 ( 如何使用本範例 )

此範例使用 getParagraph() 傳回 LinkElement 物件的 ParagraphElement。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getParagraphExample extends Sprite
    {        
        public function FlowElement_getParagraphExample()
        {
            // create a container and a controller for it and add to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to first span
            span1.text = "Text that includes a link to ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add text to second span and add spans and link to paragraph p
            span2.text = ". Notice that paragraph p2 is identical to paragraph p."; 
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            
            // call getParagraph() to retrieve paragaph for LinkElement 
            var p2:ParagraphElement = link.getParagraph();
            
            // add paragraph p2 to the text flow and display it
            textFlow.addChild(p2);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers();
        }
    }
}

getPreviousSibling

()

方法

public function getPreviousSibling():FlowElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回文字流排階層中的上一個 FlowElement 同級項目。

傳回值

FlowElement — 上一個類型相同的 FlowElement 物件，或如果沒有上一個同級項目，則為 null。

相關 API 元素

getNextSibling()

範例 ( 如何使用本範例 )

此範例使用兩個 SpanElement 物件來顯示 Hello World，並將 span2.getPreviousSibling() 的結果設為紅色。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getPreviousSiblingExample extends Sprite
    {        
        public function FlowElement_getPreviousSiblingExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var prevSpanElement:SpanElement = new SpanElement();
            // add text, set font size, add spans to paragraph, add paragraph to text flow
            span1.text = "Hello, ";
            span2.text = "World!";
            p.fontSize = 48;
            p.addChild(span1);
            p.addChild(span2);
            textFlow.addChild(p);
            // get previous SpanElement for span2 and set its color to red; display text
            prevSpanElement = SpanElement(span2.getPreviousSibling());
            prevSpanElement.color = 0xCC0000;
            textFlow.flowComposer.addController(new ContainerController(this,400,200));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

getStyle

()

方法

public function getStyle(styleProp:String):*

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

傳回 styleProp 參數所指定的樣式值，此參數會指定樣式名稱，而且可以包含任何使用者樣式名稱。存取現有範圍、段落、文字流排或容器樣式。如果特定元素的樣式值是 undefined，請搜尋父樹狀結構。

參數

styleProp:String — 要擷取其值的樣式名稱。

傳回值

* — 指定樣式的值。類型則會視存取的樣式類型而不同。如果未設定樣式，則傳回 undefined。

相關 API 元素

clearStyle()
setStyle()
userStyles

範例 ( 如何使用本範例 )

此範例會呼叫 getStyle() 以判斷是否將 lineThrough 樣式套用至範圍。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getStyleExample extends Sprite
    {        
        public function FlowElement_getStyleExample()
        {
            // create a container and a TextFlow object
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            var textFlow:TextFlow = new TextFlow();
            
            // create a paragraph and set lineThrough style to true 
            var paragraph:ParagraphElement = new ParagraphElement();
            paragraph.setStyle("lineThrough", true);
            // create two spans of text
            var p1Span1:SpanElement = new SpanElement();
            var p1Span2:SpanElement = new SpanElement();            
            p1Span1.text = "It was a dark and stormy night. ";
            p1Span2.text = "The quick red fox jumped over the lazy brown dog.";
            paragraph.addChild(p1Span1);
            paragraph.addChild(p1Span2);
            
            // call getStyle() for 1st span to see if lineThrough is on
            if(p1Span1.getStyle("lineThrough") == true)
                p1Span1.setStyle("lineThrough", false)    // if so, turn it off for this span
            textFlow.addChild(paragraph);
            
            // add composer and controller, then update controller to display text
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

getText

()

方法

public function getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

從流排元素取得指定的文字範圍。

參數

	`relativeStart:int` (default = `0`) — 要擷取文字範圍的開頭位置 (相對於 FlowElement 的開頭)

	`relativeEnd:int` (default = `-1`) — 要擷取文字範圍的結束位置 (相對於 FlowElement 的開頭)，-1 代表直到元素的結尾

	`paragraphSeparator:String` (default = " ") — 置於段落之間的字元

傳回值

String — 要求的文字。

getTextFlow

()

方法

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

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

往上瀏覽文字流排階層，以傳回元素的根 TextFlow 物件。

傳回值

flashx.textLayout.elements:TextFlow — 此 FlowElement 物件的根 TextFlow 物件。

相關 API 元素

TextFlow

範例 ( 如何使用本範例 )

此範例搭配使用 getTextFlow() 與 LinkElement 物件，以傳回它的根 TextFlow。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_getTextFlowExample extends Sprite
    {        
        public function FlowElement_getTextFlowExample()
        {
            // create a container and a controller for it and add to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController(container, 400, 200);
            this.stage.addChild( container );
                        
            //create TextFlow, ParagraphElement, SpanElement, and LinkElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to first span
            span1.text = "Text that includes a link to ";
            
            // create link span, add text and corresponding URL and add to link
            var linkSpan:SpanElement = new SpanElement();
            linkSpan.text = "Adobe's website";
            link.href = "http://www.adobe.com";
            link.addChild(linkSpan);
            
            // add text to second span, add spans and link to paragraph p, and
            // add paragraph p to textFlow
            span2.text = ". Notice that textFlow2 is identical to textFlow."; 
            p.addChild(span1);
            p.addChild(link);
            p.addChild(span2);
            textFlow.addChild(p);
            
            // use getTextFlow() with LinkElement to return its TextFlow; update controller
            // and display it
            var textFlow2:TextFlow = link.getTextFlow();     
            textFlow2.flowComposer.addController( controller );                               
            textFlow2.flowComposer.updateAllControllers();
        }
    }
}

initialized

()

方法

public function initialized(document:Object, id:String):void

實作物件已經建立而且在 MXML 標籤上指定的所有組件屬性已經初始化後，為 MXML 物件進行呼叫。

參數

	`document:Object` — MXML 文件，物件就由它建立的。

	`id:String` — 文件參照此物件時使用的識別名稱。

setStyle

()

方法

public function setStyle(styleProp:String, newValue:*):void

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

將 styleProp 參數所指定的樣式設為 newValue 參數所指定的值。您可以設定範圍、段落、文字流排或容器樣式 (包含任何使用者名稱/值配對)。

注意：如果指定自訂樣式，則 Text Layout Framework 可以將它匯入及匯出，但是編譯的 MXML 無法支援它。

參數

	`styleProp:String` — 要設定的樣式名稱。

	`newValue:*` — 要設定樣式的目標值。

相關 API 元素

clearStyle()
getStyle()
userStyles

範例 ( 如何使用本範例 )

此範例會呼叫 setStyle() 以設定範圍的顏色，並將文字流排的字體樣式設為斜體。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flash.text.engine.FontPosture;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_setStyleExample extends Sprite
    {        
        public function FlowElement_setStyleExample()
        {
            // create a container and a controller for it and add it to the stage
            var container:Sprite = new Sprite();
            var controller:ContainerController = new ContainerController( container, 400, 200 );
            this.stage.addChild( container );
            
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            
            // add text to the spans
            span1.text = "Hello, ";
            span2.text = "World!";
            
            // set the color style for span2 and add spans to paragraph p
            span2.setStyle("color", 0xCC0000);
            p.addChild(span1);
            p.addChild(span2);
            
            // add paragraph to text flow, set fontStyle for the text flow to italic,
            // and update controller to display the paragraph
            textFlow.addChild(p);
            textFlow.setStyle("fontStyle", FontPosture.ITALIC);
            textFlow.flowComposer.addController( controller );                               
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}

shallowCopy

()

方法

public function shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

製作此 FlowElement 物件的複本，這會複製兩個指定字元位置之間的內容。它會傳回複本做為新的 FlowElement 物件。與 deepCopy() 不同，shallowCopy() 不會複製此 FlowElement 物件的任何子系。

未含任何引數時，shallowCopy() 預設會複製所有內容。

參數

	`relativeStart:int` (default = `0`) — 要複製之第一個字元的相對文字位置。第一個位置是 0。

	`relativeEnd:int` (default = `-1`) — 要複製之最後一個字元的相對文字位置。值 -1 指出複製到結尾。

傳回值

FlowElement — 複本作業所建立的物件。

相關 API 元素

deepCopy()

範例 ( 如何使用本範例 )

此範例會建立第二個段落做為第一個段落的淺層複本，並表示新段落沒有子項。

package flashx.textLayout.elements.examples {
    
    import flash.display.Sprite;
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    
    public class FlowElement_shallowCopyExample extends Sprite
    {        
        public function FlowElement_shallowCopyExample()
        {
            // create a container and add it to the stage
            var container:Sprite = new Sprite();
            this.stage.addChild(container);
            // create TextFlow, ParagraphElement, and SpanElement objects
            var textFlow:TextFlow = new TextFlow();
            var p:ParagraphElement = new ParagraphElement();
            var span1:SpanElement = new SpanElement();
            var span2:SpanElement = new SpanElement();
            var span3:SpanElement = new SpanElement();
            // add text to the spans, spans to the paragraph
            span1.text = "paragraph2 has  ";
            span3.text = " children, so it would display nothing."
            p.fontSize = 20;
            p.addChild(span1);
            p.addChild(span2);
            p.addChild(span3);
            // create paragraph p2 as a shallow copy of paragraph p
            var p2:ParagraphElement = p.shallowCopy(3, -1) as ParagraphElement; 
            // add the number of children that p2 has to span2 for paragraph p
            span2.text += p2.numChildren;    // 0
            // add paragraph p to textFlow and update controller to display it
            textFlow.addChild(p);
            var controller:ContainerController = new ContainerController(container, 200, 200 );
            textFlow.flowComposer.addController(controller);
            textFlow.flowComposer.updateAllControllers();  
        }
    }
}

splitAtPosition

()

方法

public function splitAtPosition(relativePosition:int):FlowElement

語言版本:

ActionScript 3.0

執行階段版本:

Flash Player 10, AIR 1.5

在 relativePosition 參數指定的位置分割此 FlowElement 物件，而此參數是此元素在文字中的相對位置。此方法只會分割 SpanElement 及 FlowGroupElement 物件。

參數

relativePosition:int — 分割原始物件內容的位置，而第一個位置是 0。

傳回值

FlowElement — 包含原始物件內容的新物件，從指定位置開始。

擲回值

RangeError — 如果 relativePosition 大於 textLength，或小於 0。

法律聲明 | 線上隱私權政策

FlowElement - AS3

套件x

語言元素

附錄

套件 flashx.textLayout.elements

alignmentBaseline

backgroundAlpha

backgroundColor

baselineShift

blockProgression

breakOpportunity

cffHinting

clearFloats

color

columnCount

columnGap

columnWidth

computedFormat

coreStyles

digitCase

digitWidth

direction

dominantBaseline

firstBaselineOffset

fontFamily

fontLookup

fontSize

fontStyle

fontWeight

format

id

justificationRule

justificationStyle

kerning

leadingModel

ligatureLevel

lineBreak

lineHeight

lineThrough

linkActiveFormat

linkHoverFormat

linkNormalFormat

listAutoPadding

listMarkerFormat

listStylePosition

listStyleType

locale

paddingBottom

paddingLeft

paddingRight

paddingTop

paragraphEndIndent

paragraphSpaceAfter

paragraphSpaceBefore

paragraphStartIndent

parent

parentRelativeEnd

parentRelativeStart

renderingMode

styleName

styles

tabStops

textAlign

textAlignLast

textAlpha

textDecoration

textIndent

textJustify

textLength

textRotation

tracking

trackingLeft

trackingRight

typeName

typographicCase

userStyles

verticalAlign

whiteSpaceCollapse

wordSpacing

FlowElement