flashx.textLayout.edit.ISelectionManager

	Property	Defined By
		absoluteEnd : int [read-only] The text position of the end of the selection, as an offset from the start of the text flow.	ISelectionManager
		absoluteStart : int [read-only] The text position of the start of the selection, as an offset from the start of the text flow.	ISelectionManager
		activeCellPosition : CellCoordinates Active end of the current cell selection, as coordinates within the table.	ISelectionManager
		activePosition : int [read-only] The active point of the selection.	ISelectionManager
		anchorCellPosition : CellCoordinates Anchor point of the current cell selection, as coordinates within the table.	ISelectionManager
		anchorPosition : int [read-only] The anchor point of the selection.	ISelectionManager
		currentCellSelectionFormat : SelectionFormat [read-only] The current Cell SelectionFormat object.	ISelectionManager
		currentSelectionFormat : SelectionFormat [read-only] The current SelectionFormat object.	ISelectionManager
		currentTable : TableElement	ISelectionManager
		editingMode : String [read-only] The editing mode.	ISelectionManager
		focused : Boolean [read-only] Indicates whether a container in the text flow has the focus.	ISelectionManager
		focusedCellSelectionFormat : SelectionFormat The SelectionFormat object used to draw cell selections in a focused container.	ISelectionManager
		focusedSelectionFormat : SelectionFormat The SelectionFormat object used to draw the selection in a focused container.	ISelectionManager
		inactiveCellSelectionFormat : SelectionFormat The SelectionFormat object used to draw cell selections when they are not in the active window.	ISelectionManager
		inactiveSelectionFormat : SelectionFormat The SelectionFormat object used to draw the selection when it is not in the active window.	ISelectionManager
		selectionType : String [read-only] Indicates the type of selection.	ISelectionManager
		subManager : ISelectionManager The ISelectionManager object used to for cell selections nested within the TextFlow managed by this ISelectionManager.	ISelectionManager
		superManager : ISelectionManager The ISelectionManager object used to manage the parent TextFlow of this ISelectionManager (i.e.	ISelectionManager
		textFlow : TextFlow The TextFlow object managed by this selection manager.	ISelectionManager
		unfocusedCellSelectionFormat : SelectionFormat The SelectionFormat object used to draw cell selections when they are not in a focused container, but are in the active window.	ISelectionManager
		unfocusedSelectionFormat : SelectionFormat The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.	ISelectionManager
		windowActive : Boolean [read-only] Indicates whether the window associated with the text flow is active.	ISelectionManager

	Method	Defined By
		activateHandler(event:Event):void Processes an activate event.	IInteractionEventHandler
		clearSelection():void Clears the selection shapes.	ISelectionManager
		deactivateHandler(event:Event):void Processes a deactivate event.	IInteractionEventHandler
		deselect():void Removes any selection from the text flow	ISelectionManager
		editHandler(event:Event):void Processes an edit event.	IInteractionEventHandler
		flushPendingOperations():void Executes any pending FlowOperations.	ISelectionManager
		focusChangeHandler(event:FocusEvent):void Processes a focusChange event.	IInteractionEventHandler
		focusInHandler(event:FocusEvent):void Processes a focusIn event.	IInteractionEventHandler
		focusOutHandler(event:FocusEvent):void Processes a focusOut event.	IInteractionEventHandler
		getCellRange():CellRange	ISelectionManager
		getCommonCharacterFormat(range:TextRange = null):TextLayoutFormat Gets the character format attributes that are common to all characters in the specified text range or current selection.	ISelectionManager
		getCommonContainerFormat(range:TextRange = null):TextLayoutFormat Gets the container format attributes that are common to all containers in the specified text range or current selection.	ISelectionManager
		getCommonParagraphFormat(range:TextRange = null):TextLayoutFormat Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.	ISelectionManager
		getSelectionState():SelectionState Gets the SelectionState object of the current selection.	ISelectionManager
		hasAnySelection():Boolean Indicates whether there is a text or cell selection.	ISelectionManager
		hasCellRangeSelection():Boolean	ISelectionManager
		hasSelection():Boolean Indicates whether there is a text selection.	ISelectionManager
		imeStartCompositionHandler(event:IMEEvent):void Processes an imeStartComposition event	IInteractionEventHandler
		isRangeSelection():Boolean Indicates whether the selection covers a range of text.	ISelectionManager
		keyDownHandler(event:KeyboardEvent):void Processes a keyDown event.	IInteractionEventHandler
		keyFocusChangeHandler(event:FocusEvent):void Processes a keyFocusChange event.	IInteractionEventHandler
		keyUpHandler(event:KeyboardEvent):void Processes a keyUp event.	IInteractionEventHandler
		menuSelectHandler(event:ContextMenuEvent):void Processes a menuSelect event.	IInteractionEventHandler
		mouseDoubleClickHandler(event:MouseEvent):void Processes a mouseDoubleClick event.	IInteractionEventHandler
		mouseDownHandler(event:MouseEvent):void Processes a mouseDown event.	IInteractionEventHandler
		mouseMoveHandler(event:MouseEvent):void Processes a mouseMove event.	IInteractionEventHandler
		mouseOutHandler(event:MouseEvent):void Processes a mouseOut event.	IInteractionEventHandler
		mouseOverHandler(event:MouseEvent):void Processes a mouseOver event.	IInteractionEventHandler
		mouseUpHandler(event:MouseEvent):void Processes a mouseUp event.	IInteractionEventHandler
		mouseWheelHandler(event:MouseEvent):void Processes a mouseWheel event.	IInteractionEventHandler
		notifyInsertOrDelete(absolutePosition:int, length:int):void Updates the selection manager when text is inserted or deleted.	ISelectionManager
		refreshSelection():void Redisplays the selection shapes.	ISelectionManager
		selectAll():void Selects the entire flow.	ISelectionManager
		selectCellRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates):void	ISelectionManager
		selectFirstPosition():void Selects the first position in the entire flow.	ISelectionManager
		selectLastPosition():void Selects the last position in the entire flow.	ISelectionManager
		selectRange(anchorPosition:int, activePosition:int):void Selects a range of text.	ISelectionManager
		setCellRange(range:CellRange):void	ISelectionManager
		setFocus():void Gives the focus to the first container in the selection.	ISelectionManager
		setSelectionState(state:SelectionState):void Sets the SelectionState object of the current selection.	ISelectionManager
		softKeyboardActivatingHandler(event:Event):void Processes an softKeyboardActivating event	IInteractionEventHandler
		textInputHandler(event:TextEvent):void Processes a TextEvent.	IInteractionEventHandler

Property Detail

absoluteEnd

property

absoluteEnd:int [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The text position of the end of the selection, as an offset from the start of the text flow.

The absolute end is the same as either the active or the anchor point of the selection, whichever comes last in the text flow.

Implementation
public function get absoluteEnd():int

absoluteStart

property

absoluteStart:int [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The text position of the start of the selection, as an offset from the start of the text flow.

The absolute start is the same as either the active or the anchor point of the selection, whichever comes first in the text flow.

Implementation
public function get absoluteStart():int

activeCellPosition

property

activeCellPosition:CellCoordinates

Active end of the current cell selection, as coordinates within the table.

Implementation
public function get activeCellPosition():CellCoordinates
public function set activeCellPosition(value:CellCoordinates):void

activePosition

property

activePosition:int [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The active point of the selection.

The active point is the volatile end of the selection. The active point is changed when the selection is modified. The active point can be at either the beginning or the end of the selection.

Implementation
public function get activePosition():int

anchorCellPosition

property

anchorCellPosition:CellCoordinates

Anchor point of the current cell selection, as coordinates within the table.

Implementation
public function get anchorCellPosition():CellCoordinates
public function set anchorCellPosition(value:CellCoordinates):void

anchorPosition

property

anchorPosition:int [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The anchor point of the selection.

An anchor point is the stable end of the selection. When the selection is extended, the anchor point does not change. The anchor point can be at either the beginning or the end of the selection.

Implementation
public function get anchorPosition():int

currentCellSelectionFormat

property

currentCellSelectionFormat:SelectionFormat [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The current Cell SelectionFormat object.

The current cell SelectionFormat object is chosen from the SelectionFormat objects assigned to the unfocusedCellSelectionFormat, inactiveCellSelectionFormat and focusedCellSelectionFormat properties based on the current state of the windowActive and focused properties.

Implementation
public function get currentCellSelectionFormat():SelectionFormat

currentSelectionFormat

property

currentSelectionFormat:SelectionFormat [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The current SelectionFormat object.

The current SelectionFormat object is chosen from the SelectionFormat objects assigned to the unfocusedSelectionFormat, inactiveSelectionFormat and focusedSelectionFormat properties based on the current state of the windowActive and focused properties.

Implementation
public function get currentSelectionFormat():SelectionFormat

currentTable

property

currentTable:TableElement

Implementation
public function get currentTable():TableElement
public function set currentTable(value:TableElement):void

editingMode

property

editingMode:String [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The editing mode.

The editing mode indicates whether the text flow supports selection, editing, or only reading. A text flow is made selectable by assigning a selection manager and editable by assigning an edit manager. Constants representing the editing modes are defined in the EditingMode class.

Implementation
public function get editingMode():String

See also

flashx.textLayout.EditingMode

focused

property

focused:Boolean [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates whether a container in the text flow has the focus.

The focused property is true if any of the containers in the text flow has key focus.

Implementation
public function get focused():Boolean

focusedCellSelectionFormat

property

focusedCellSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw cell selections in a focused container.

Implementation
public function get focusedCellSelectionFormat():SelectionFormat
public function set focusedCellSelectionFormat(value:SelectionFormat):void

focusedSelectionFormat

property

focusedSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection in a focused container.

Implementation
public function get focusedSelectionFormat():SelectionFormat
public function set focusedSelectionFormat(value:SelectionFormat):void

inactiveCellSelectionFormat

property

inactiveCellSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw cell selections when they are not in the active window.

Implementation
public function get inactiveCellSelectionFormat():SelectionFormat
public function set inactiveCellSelectionFormat(value:SelectionFormat):void

inactiveSelectionFormat

property

inactiveSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection when it is not in the active window.

Implementation
public function get inactiveSelectionFormat():SelectionFormat
public function set inactiveSelectionFormat(value:SelectionFormat):void

selectionType

property

selectionType:String [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates the type of selection.

The selectionType describes the kind of selection. It can either be SelectionType.TEXT or SelectionType.CELLS

Implementation
public function get selectionType():String

See also

flashx.textLayout.edit.SelectionType

subManager

property

subManager:ISelectionManager

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The ISelectionManager object used to for cell selections nested within the TextFlow managed by this ISelectionManager.

Implementation
public function get subManager():ISelectionManager
public function set subManager(value:ISelectionManager):void

superManager

property

superManager:ISelectionManager

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The ISelectionManager object used to manage the parent TextFlow of this ISelectionManager (i.e. for cell ISelectionManagers).

Implementation
public function get superManager():ISelectionManager
public function set superManager(value:ISelectionManager):void

textFlow

property

textFlow:TextFlow

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The TextFlow object managed by this selection manager.

A selection manager manages a single text flow. A selection manager can also be assigned to a text flow by setting the interactionManager property of the TextFlow object.

Implementation
public function get textFlow():TextFlow
public function set textFlow(value:TextFlow):void

unfocusedCellSelectionFormat

property

unfocusedCellSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw cell selections when they are not in a focused container, but are in the active window.

Implementation
public function get unfocusedCellSelectionFormat():SelectionFormat
public function set unfocusedCellSelectionFormat(value:SelectionFormat):void

unfocusedSelectionFormat

property

unfocusedSelectionFormat:SelectionFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.

Implementation
public function get unfocusedSelectionFormat():SelectionFormat
public function set unfocusedSelectionFormat(value:SelectionFormat):void

windowActive

property

windowActive:Boolean [read-only]

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates whether the window associated with the text flow is active.

The windowActive property is true if the window displaying with the text flow is the active window.

Implementation
public function get windowActive():Boolean

Method Detail

clearSelection

()

method

public function clearSelection():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Clears the selection shapes.

deselect

()

method

public function deselect():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Removes any selection from the text flow

flushPendingOperations

()

method

public function flushPendingOperations():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Executes any pending FlowOperations.

The execution of some editing operations, such as text insertion, is delayed until the next enterFrame event. Calling flushPendingOperations() causes any deferred operations to be executed immediately.

getCellRange

()

method

public function getCellRange():CellRange

Returns

CellRange

getCommonCharacterFormat

()

method

public function getCommonCharacterFormat(range:TextRange = null):TextLayoutFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Gets the character format attributes that are common to all characters in the specified text range or current selection.

Format attributes that do not have the same value for all characters in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns

TextLayoutFormat — The common character style settings

getCommonContainerFormat

()

method

public function getCommonContainerFormat(range:TextRange = null):TextLayoutFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Gets the container format attributes that are common to all containers in the specified text range or current selection.

Format attributes that do not have the same value for all containers in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns

TextLayoutFormat — The common container style settings

getCommonParagraphFormat

()

method

public function getCommonParagraphFormat(range:TextRange = null):TextLayoutFormat

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.

Format attributes that do not have the same value for all paragraphs in the specified element range or selection are set to null in the returned TextLayoutFormat instance.

Parameters

range:TextRange (default = null) — The optional range of text for which common attributes are requested. If null, the current selection is used.

Returns

TextLayoutFormat — The common paragraph style settings

getSelectionState

()

method

public function getSelectionState():SelectionState

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Gets the SelectionState object of the current selection.

Returns

SelectionState

See also

flashx.textLayout.edit.SelectionState

hasAnySelection

()

method

public function hasAnySelection():Boolean

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates whether there is a text or cell selection.

Returns true if there is either a range selection or a point selection. By default, when a selection manager is first set up, there is no selection (the start and end are -1).

Returns

Boolean

hasCellRangeSelection

()

method

public function hasCellRangeSelection():Boolean

Returns

Boolean

hasSelection

()

method

public function hasSelection():Boolean

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates whether there is a text selection.

Returns true if there is either a range selection or a point selection. By default, when a selection manager is first set up, there is no selection (the start and end are -1).

Returns

Boolean

isRangeSelection

()

method

public function isRangeSelection():Boolean

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Indicates whether the selection covers a range of text.

Returns true if there is a selection that extends past a single position.

Returns

Boolean

notifyInsertOrDelete

()

method

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

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Updates the selection manager when text is inserted or deleted.

Operations must call notifyInsertOrDelete when changing the text in the text flow. The selection manager adjusts index-based position indicators accordingly. If you create a new Operation class that changes text in a text flow directly (not using another operation) your operation must call this function to keep the selection up to date.

Parameters

	`absolutePosition:int` — The point in the text where the change was made.

	`length:int` — A positive or negative number indicating how many characters were inserted or deleted.

refreshSelection

()

method

public function refreshSelection():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Redisplays the selection shapes.

Note: You do not need to call this method directly. It is called automatically.

selectAll

()

method

public function selectAll():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Selects the entire flow.

selectCellRange

()

method

public function selectCellRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates):void

Parameters

	`anchorCoords:CellCoordinates`

	`activeCoords:CellCoordinates`

selectFirstPosition

()

method

public function selectFirstPosition():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Selects the first position in the entire flow.

selectLastPosition

()

method

public function selectLastPosition():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Selects the last position in the entire flow.

selectRange

()

method

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

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Selects a range of text.

If a negative number is passed as either of the parameters, then any existing selection is removed.

Parameters

	`anchorPosition:int` — The anchor point for the new selection, as an absolute position in the TextFlow

	`activePosition:int` — The active end of the new selection, as an absolute position in the TextFlow

setCellRange

()

method

public function setCellRange(range:CellRange):void

Parameters

range:CellRange

setFocus

()

method

public function setFocus():void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Gives the focus to the first container in the selection.

setSelectionState

()

method

public function setSelectionState(state:SelectionState):void

Language Version :

ActionScript 3.0

Runtime Versions :

Flash Player 10, AIR 1.5

Sets the SelectionState object of the current selection.

Parameters

state:SelectionState

See also

flashx.textLayout.edit.SelectionState

Wed Nov 15 2017, 09:50 AM +01:00

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
ISelectionManager	Properties \| Methods

Package	flashx.textLayout.edit
Interface	public interface ISelectionManager extends IInteractionEventHandler
Implementors	SelectionManager