ISelectionManager - Adobe ActionScript® 3 (AS3 ) API 参考

包	flashx.textLayout.edit
接口	public interface ISelectionManager extends IInteractionEventHandler
实现器	SelectionManager

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

ISelectionManager 接口定义用于处理文本选择的接口。

SelectionManager 可跟踪所选文本范围并处理 TextFlow 的事件。

选择可以是点选择或范围选择。点选择是一个插入点，通过绘制一个光标显示。范围选择包括锚点和活动点之间的文本。

公共属性

	属性		由以下参数定义
		absoluteEnd : int [只读] 选择部分末尾的文本位置，是自文本流起始位置的偏移。	ISelectionManager
		absoluteStart : int [只读] 选择部分开头的文本位置，是自文本流起始位置的偏移。	ISelectionManager
		activePosition : int [只读] 选择部分的活动点。	ISelectionManager
		anchorPosition : int [只读] 选择部分的锚点。	ISelectionManager
		currentSelectionFormat : SelectionFormat [只读] 当前 SelectionFormat 对象。	ISelectionManager
		editingMode : String [只读] 编辑模式。	ISelectionManager
		focused : Boolean [只读] 指示文本流中的容器是否具有焦点。	ISelectionManager
		focusedSelectionFormat : SelectionFormat 用于在焦点容器中绘制选择的 SelectionFormat 对象。	ISelectionManager
		inactiveSelectionFormat : SelectionFormat 当选择部分不在活动窗口中时，用于绘制选择的 SelectionFormat 对象。	ISelectionManager
		textFlow : flashx.textLayout.elements:TextFlow 由该选择管理器管理的 TextFlow 对象。	ISelectionManager
		unfocusedSelectionFormat : SelectionFormat 当选择部分不在焦点容器内但是位于活动窗口中时，用于绘制选择的 SelectionFormat 对象。	ISelectionManager
		windowActive : Boolean [只读] 指示与文本流关联的窗口是否是活动窗口。	ISelectionManager

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		activateHandler(event:Event):void 处理 activate 事件。	IInteractionEventHandler
		deactivateHandler(event:Event):void 处理 deactivate 事件。	IInteractionEventHandler
		editHandler(event:Event):void 处理 edit 事件。	IInteractionEventHandler
		flushPendingOperations():void 执行任何挂起的 FlowOperations。	ISelectionManager
		focusChangeHandler(event:FocusEvent):void 处理 focusChange 事件。	IInteractionEventHandler
		focusInHandler(event:FocusEvent):void 处理 focusIn 事件。	IInteractionEventHandler
		focusOutHandler(event:FocusEvent):void 处理 focusOut 事件。	IInteractionEventHandler
		getCommonCharacterFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat 获取对于指定的文本范围或当前所选项目中的所有字符都通用的字符格式属性。	ISelectionManager
		getCommonContainerFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat 获取对于指定的文本范围或当前所选项目中的所有容器都通用的容器格式属性。	ISelectionManager
		getCommonParagraphFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat 获取对于指定的文本范围或当前选区中的所有段落都通用的段落格式属性。	ISelectionManager
		getSelectionState():SelectionState 获取当前所选内容的 SelectionState 对象。	ISelectionManager
		hasSelection():Boolean 指示是否进行了选择。	ISelectionManager
		imeStartCompositionHandler(event:IMEEvent):void 处理 imeStartComposition 事件。	IInteractionEventHandler
		isRangeSelection():Boolean 指示选择时是否涵盖某一文本范围。	ISelectionManager
		keyDownHandler(event:KeyboardEvent):void 处理 keyDown 事件。	IInteractionEventHandler
		keyFocusChangeHandler(event:FocusEvent):void 处理 keyFocusChange 事件。	IInteractionEventHandler
		keyUpHandler(event:KeyboardEvent):void 处理 keyUp 事件。	IInteractionEventHandler
		menuSelectHandler(event:ContextMenuEvent):void 处理 menuSelect 事件。	IInteractionEventHandler
		mouseDoubleClickHandler(event:MouseEvent):void 处理 mouseDoubleClick 事件。	IInteractionEventHandler
		mouseDownHandler(event:MouseEvent):void 处理 mouseDown 事件。	IInteractionEventHandler
		mouseMoveHandler(event:MouseEvent):void 处理 mouseMove 事件。	IInteractionEventHandler
		mouseOutHandler(event:MouseEvent):void 处理 mouseOut 事件。	IInteractionEventHandler
		mouseOverHandler(event:MouseEvent):void 处理 mouseOver 事件。	IInteractionEventHandler
		mouseUpHandler(event:MouseEvent):void 处理 mouseUp 事件。	IInteractionEventHandler
		mouseWheelHandler(event:MouseEvent):void 处理 mouseWheel 事件。	IInteractionEventHandler
		notifyInsertOrDelete(absolutePosition:int, length:int):void 插入或删除文本时更新选择管理器。	ISelectionManager
		refreshSelection():void 重新显示选择形状。	ISelectionManager
		selectAll():void 选择整个流。	ISelectionManager
		selectRange(anchorPosition:int, activePosition:int):void 选择某一范围的文本。	ISelectionManager
		setFocus():void 将焦点设置到所选内容中的第一个容器。	ISelectionManager
		setSelectionState(state:SelectionState):void 设置当前选定内容的 SelectionState 对象。	ISelectionManager
		softKeyboardActivatingHandler(event:Event):void 处理 softKeyboardActivating 事件	IInteractionEventHandler
		textInputHandler(event:flash.events:TextEvent):void 处理 TextEvent。	IInteractionEventHandler

属性详细信息

absoluteEnd

属性

absoluteEnd:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择部分末尾的文本位置，是自文本流起始位置的偏移。

绝对终点与选择部分的活动点或锚点相同，具体取决于哪一个在文本流中更靠后。

实现
public function get absoluteEnd():int

absoluteStart

属性

absoluteStart:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择部分开头的文本位置，是自文本流起始位置的偏移。

绝对起点与选择部分的活动点或锚点相同，具体取决于哪一个在文本流中更靠前。

实现
public function get absoluteStart():int

activePosition

属性

activePosition:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择部分的活动点。

活动点是选择部分的不定终点。活动点随选择的修改而改变。活动点可以位于当前选择的起始或结束位置。

实现
public function get activePosition():int

anchorPosition

属性

anchorPosition:int [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择部分的锚点。

锚点是选择部分的固定终点。当扩展选择部分时，锚点不会随之改变。锚点可以位于当前选择的起始或结束位置。

实现
public function get anchorPosition():int

currentSelectionFormat

属性

currentSelectionFormat:SelectionFormat [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当前 SelectionFormat 对象。

当前 SelectionFormat 对象根据 windowActive 和 focused 属性的当前状态，从指定给 unfocusedSelectionFormat、inactiveSelectionFormat 和 focusedSelectionFormat 属性的 SelectionFormat 对象中进行选择。

实现
public function get currentSelectionFormat():SelectionFormat

editingMode

属性

editingMode:String [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

编辑模式。

编辑模式指示文本流是支持选择、编辑还是只读。通过指定选择管理器可允许对文本流进行选择，通过指定编辑管理器可允许对文本流进行编辑。表示编辑模式的常量在 EditingMode 类中进行定义。

实现
public function get editingMode():String

相关 API 元素

flashx.textLayout.EditingMode

focused

属性

focused:Boolean [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示文本流中的容器是否具有焦点。

如果文本流中的任意容器具有主焦点，则 focused 属性为 true。

实现
public function get focused():Boolean

focusedSelectionFormat

属性

focusedSelectionFormat:SelectionFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

用于在焦点容器中绘制选择的 SelectionFormat 对象。

实现
public function get focusedSelectionFormat():SelectionFormat
public function set focusedSelectionFormat(value:SelectionFormat):void

inactiveSelectionFormat

属性

inactiveSelectionFormat:SelectionFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当选择部分不在活动窗口中时，用于绘制选择的 SelectionFormat 对象。

实现
public function get inactiveSelectionFormat():SelectionFormat
public function set inactiveSelectionFormat(value:SelectionFormat):void

textFlow

属性

textFlow:flashx.textLayout.elements:TextFlow

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

由该选择管理器管理的 TextFlow 对象。

一个选择管理器只管理一个文本流。也可通过设置 TextFlow 对象的 interactionManager 属性，将选择管理器指定给相应文本流。

实现
public function get textFlow():flashx.textLayout.elements:TextFlow
public function set textFlow(value:flashx.textLayout.elements:TextFlow):void

unfocusedSelectionFormat

属性

unfocusedSelectionFormat:SelectionFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

当选择部分不在焦点容器内但是位于活动窗口中时，用于绘制选择的 SelectionFormat 对象。

实现
public function get unfocusedSelectionFormat():SelectionFormat
public function set unfocusedSelectionFormat(value:SelectionFormat):void

windowActive

属性

windowActive:Boolean [只读]

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示与文本流关联的窗口是否是活动窗口。

如果显示文本流的窗口是活动窗口，则 windowActive 属性为 true。

实现
public function get windowActive():Boolean

方法详细信息

flushPendingOperations

()

方法

public function flushPendingOperations():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

执行任何挂起的 FlowOperations。

某些编辑操作（例如插入文本）的执行被延迟，直到发生下一个 enterFrame 事件。调用 flushPendingOperations() 会使任何延迟的操作立即执行。

getCommonCharacterFormat

()

方法

 public function getCommonCharacterFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

获取对于指定的文本范围或当前所选项目中的所有字符都通用的字符格式属性。

对于指定的元素范围或选区中的所有字符具有不同值的格式属性在返回的 TextLayoutFormat 实例中设置为 null。

参数

range:flashx.textLayout.elements:TextRange (default = null) — 为其请求通用属性的可选的文本范围。如果为 null，则使用当前选区。

flashx.textLayout.formats:TextLayoutFormat — 通用字符样式设置

示例 ( 如何使用本示例 )

以下示例说明如何获取 ITextLayoutFormat 对象，该对象包含对选择内容中的所有元素通用的字符样式设置。（示例中的 textFlow 变量是 TextFlow 对象。）

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonCharacterFormat();

getCommonContainerFormat

()

方法

 public function getCommonContainerFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

获取对于指定的文本范围或当前所选项目中的所有容器都通用的容器格式属性。

对于指定的元素范围或选区中的所有容器具有不同值的格式属性在返回的 TextLayoutFormat 实例中设置为 null。

参数

range:flashx.textLayout.elements:TextRange (default = null) — 为其请求通用属性的可选的文本范围。如果为 null，则使用当前选区。

flashx.textLayout.formats:TextLayoutFormat — 通用容器样式设置

示例 ( 如何使用本示例 )

下面的示例说明如何使包含容器样式设置的 ITextLayoutFormat 对象对于选择内容中的所有元素通用。（示例中的 textFlow 变量是 TextFlow 对象。）

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonContainerFormat();

getCommonParagraphFormat

()

方法

 public function getCommonParagraphFormat(range:flashx.textLayout.elements:TextRange = null):flashx.textLayout.formats:TextLayoutFormat

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

获取对于指定的文本范围或当前选区中的所有段落都通用的段落格式属性。

对于指定的元素范围或选区中的所有段落具有不同值的格式属性在返回的 TextLayoutFormat 实例中设置为 null。

参数

range:flashx.textLayout.elements:TextRange (default = null) — 为其请求通用属性的可选的文本范围。如果为 null，则使用当前选区。

flashx.textLayout.formats:TextLayoutFormat — 通用段落样式设置

示例 ( 如何使用本示例 )

下面的示例说明如何使包含段落样式设置的 ITextLayoutFormat 对象对于选择内容中的所有元素通用。（示例中的 textFlow 变量是 TextFlow 对象。）

 var common:ITextLayoutFormat = textFlow.interactionManager.getCommonParagraphFormat();

getSelectionState

()

方法

public function getSelectionState():SelectionState

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

获取当前所选内容的 SelectionState 对象。

SelectionState

相关 API 元素

flashx.textLayout.edit.SelectionState

示例 ( 如何使用本示例 )

以下示例针对文本流中的当前选择获取 SelectionState 对象。（示例中的 textFlow 变量是 TextFlow 对象。）

 var selection:SelectionState = textFlow.interactionManager.getSelectionState();

hasSelection

()

方法

public function hasSelection():Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示是否进行了选择。

如果进行了范围选择或点选择，则返回 true。默认情况下，首次设置选择管理器时，不会进行选择（开始和结束都是 -1）。

Boolean

示例 ( 如何使用本示例 )

以下示例说明如何确定文本流是否存在选择部分。（示例中的 textFlow 变量是 TextFlow 对象。）

 var selection:SelectionState = textFlow.interactionManager.hasSelection();

isRangeSelection

()

方法

public function isRangeSelection():Boolean

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

指示选择时是否涵盖某一文本范围。

如果选择时包括多个位置，则返回 true。

Boolean

示例 ( 如何使用本示例 )

以下示例说明如何确定文本流中的当前选择是否在某一文本范围上扩展。（示例中的 textFlow 变量是 TextFlow 对象。）

 var selection:SelectionState = textFlow.interactionManager.isRangeSelection();

notifyInsertOrDelete

()

方法

public function notifyInsertOrDelete(absolutePosition:int, length:int):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

插入或删除文本时更新选择管理器。

更改文本流中的文本时，操作必须调用 notifyInsertOrDelete。选择管理器相应地调整基于索引的位置指示符。如果创建的新 Operation 类直接在文本流中更改文本（不使用其它操作），则该操作必须调用此函数使选择保持最新。

参数

	`absolutePosition:int` — 在文本中进行了更改的点。

	`length:int` — 正值或负值，指示插入或删除的字符数。

示例 ( 如何使用本示例 )

以下示例说明自定义 Operation 类中的函数会如何调用 notifyInsertOrDelete() 方法。

此函数作为某假设性操作的一部分替换 SpanElement 中的某一文本范围。

 import flashx.textLayout.elements.SpanElement;
 

function doReplace( span:SpanElement, newText:String, relativeStart:int, relativeEnd:int ):void
{
    span.replaceText(  relativeStart, relativeEnd, newText );
    var parentFlow:TextFlow = span.getTextFlow();
    var lengthDifference:int = newText.length - (relativeEnd - relativeStart);

    parentFlow.interactionManager.notifyInsertOrDelete(    span.getAbsoluteStart() + relativeStart, lengthDifference );
}

refreshSelection

()

方法

public function refreshSelection():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

重新显示选择形状。

注意：您无需直接调用此方法。该方法是自动调用的。

selectAll

()

方法

public function selectAll():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择整个流。

selectRange

()

方法

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

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

选择某一范围的文本。

如果任一参数值为负值，则会删除任何已经选择的部分。

参数

	`anchorPosition:int` — 新选择部分的锚点，是 TextFlow 中的绝对位置

	`activePosition:int` — 新选择部分的活动终点，是 TextFlow 中的绝对位置

示例 ( 如何使用本示例 )

以下示例创建文本流并进行选择：

 var textFlow:TextFlow = TextConverter.importToFlow( "Let me not to the marriage of true minds", TextConverter.PLAIN_TEXT_FORMAT );
 textFlow.interactionManager = new SelectionManager();
 
 textFlow.interactionManager.selectRange( 18, 26 ); // Selects the word 'marriage'

setFocus

()

方法

public function setFocus():void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

将焦点设置到所选内容中的第一个容器。

示例 ( 如何使用本示例 )

以下示例将焦点设置到文本流的当前选择中的第一个容器。（示例中的 textFlow 变量是 TextFlow 对象。）

 textFlow.interactionManager.setFocus();

setSelectionState

()

方法

public function setSelectionState(state:SelectionState):void

语言版本:

ActionScript 3.0

运行时版本:

Flash Player 10, AIR 1.5

设置当前选定内容的 SelectionState 对象。

参数

state:SelectionState

相关 API 元素

flashx.textLayout.edit.SelectionState

法律声明 | 在线隐私策略

ISelectionManager - AS3

类 x

absoluteEnd

absoluteStart

activePosition

anchorPosition

currentSelectionFormat

editingMode

focused

focusedSelectionFormat

inactiveSelectionFormat

textFlow

unfocusedSelectionFormat

windowActive

flushPendingOperations

getCommonCharacterFormat

getCommonContainerFormat

getCommonParagraphFormat

getSelectionState

hasSelection

isRangeSelection

notifyInsertOrDelete

refreshSelection

selectAll

selectRange

setFocus

setSelectionState