| Package | flashx.textLayout.edit |
| Class | public class SelectionManager |
| Inheritance | SelectionManager  Object |
| Implements | ISelectionManager |
| Subclasses | EditManager |
| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The selection manager keeps track of the selected text range, manages its formatting,
and can handle events affecting the selection. To allow a user to make selections in
a text flow, assign a SelectionManager object to the interactionManager
property of the flow. (To allow editing, assign an instance of the EditManager class,
which extends SelectionManager.)
The following table describes how the SelectionManager class handles keyboard shortcuts:
| TB,LTR | TB,RTL | TL,LTR | RL,RTL | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| none | ctrl | alt|ctrl+alt | none | ctrl | alt|ctrl+alt | none | ctrl | alt|ctrl+alt | none | ctrl | alt|ctrl+alt | |
| leftarrow | previousCharacter | previousWord | previousWord | nextCharacter | nextWord | nextWord | nextLine | endOfDocument | endOfParagraph | nextLine | endOfDocument | endOfParagraph |
| uparrow | previousLine | startOfDocument | startOfParagraph | previousLine | startOfDocument | startOfParagraph | previousCharacter | previousWord | previousWord | nextCharacter | nextWord | nextWord |
| rightarrow | nextCharacter | nextWord | nextWord | previousCharacter | previousWord | previousWord | previousLine | startOfDocument | startOfParagraph | previousLine | startOfDocument | startOfParagraph |
| downarrow | nextLine | endOfDocument | endOfParagraph | nextLine | endOfDocument | endOfParagraph | nextCharacter | nextWord | nextWord | previousCharacter | previousWord | previousWord |
| home | startOfLine | startOfDocument | startOfLine | startOfLine | startOfDocument | startOfLine | startOfLine | startOfDocument | startOfLine | startOfLine | startOfDocument | startOfLine |
| end | endOfLine | endOfDocument | endOfLine | endOfLine | endOfDocument | endOfLine | endOfLine | endOfDocument | endOfLine | endOfLine | endOfDocument | endOfLine |
| pagedown | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage | nextPage |
| pageup | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage | previousPage |
Key:
blockProgression settingsdirection settingsSee also
| 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. | SelectionManager | ||
| absoluteStart : int [read-only]
The text position of the start of the selection, as an offset from the start of the text flow. | SelectionManager | ||
| activePosition : int [read-only]
The active point of the selection. | SelectionManager | ||
| anchorPosition : int [read-only]
The anchor point of the selection. | SelectionManager | ||
| currentSelectionFormat : SelectionFormat [read-only]
The current SelectionFormat object. | SelectionManager | ||
| editingMode : String [read-only]
The editing mode. | SelectionManager | ||
| focused : Boolean [read-only]
Indicates whether a container in the text flow has the focus. | SelectionManager | ||
| focusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection in a focused container. | SelectionManager | ||
| inactiveSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in the active window. | SelectionManager | ||
| textFlow : TextFlow
The TextFlow object managed by this selection manager. | SelectionManager | ||
| unfocusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in a focused container, but is in
the active window. | SelectionManager | ||
| windowActive : Boolean [read-only]
Indicates whether the window associated with the text flow is active. | SelectionManager | ||
| Property | Defined By | ||
|---|---|---|---|
| pointFormat : ITextLayoutFormat [read-only]
The format that will be applied to inserted text. | SelectionManager | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a SelectionManager object. | SelectionManager | ||
activateHandler(event:Event):void
Processes an activate event. | SelectionManager | ||
deactivateHandler(event:Event):void
Processes a deactivate event. | SelectionManager | ||
doOperation(op:FlowOperation):void Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them. | SelectionManager | ||
editHandler(event:Event):void
Processes an edit event. | SelectionManager | ||
flushPendingOperations():void | SelectionManager | ||
focusChangeHandler(event:FocusEvent):void
Processes a focusChange event. | SelectionManager | ||
focusInHandler(event:FocusEvent):void
Processes a focusIn event. | SelectionManager | ||
focusOutHandler(event:FocusEvent):void
Processes a focusOut event. | SelectionManager | ||
Gets the character format attributes that are common to all characters in the specified text range or current selection. | SelectionManager | ||
Gets the container format attributes that are common to all containers in the specified text range or current selection. | SelectionManager | ||
Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection. | SelectionManager | ||
Gets the SelectionState object of the current selection. | SelectionManager | ||
hasSelection():Boolean
Indicates whether there is a selection. | SelectionManager | ||
imeStartCompositionHandler(event:IMEEvent):void
Processes an imeStartComposition event
| SelectionManager | ||
isRangeSelection():Boolean
Indicates whether the selection covers a range of text. | SelectionManager | ||
keyDownHandler(event:KeyboardEvent):void
Processes a keyDown event. | SelectionManager | ||
keyFocusChangeHandler(event:FocusEvent):void
Processes a keyFocusChange event. | SelectionManager | ||
keyUpHandler(event:KeyboardEvent):void
Processes a keyUp event. | SelectionManager | ||
menuSelectHandler(event:ContextMenuEvent):void
Processes a menuSelect event. | SelectionManager | ||
mouseDoubleClickHandler(event:MouseEvent):void
Processes a mouseDoubleClick event. | SelectionManager | ||
mouseDownHandler(event:MouseEvent):void
Processes a mouseDown event. | SelectionManager | ||
mouseMoveHandler(event:MouseEvent):void
Processes a mouseMove event. | SelectionManager | ||
mouseOutHandler(event:MouseEvent):void
Processes a mouseOut event. | SelectionManager | ||
mouseOverHandler(event:MouseEvent):void
Processes a mouseOver event. | SelectionManager | ||
mouseUpHandler(event:MouseEvent):void
Processes a mouseUp event. | SelectionManager | ||
mouseWheelHandler(event:MouseEvent):void
Processes a mouseWheel event. | SelectionManager | ||
notifyInsertOrDelete(absolutePosition:int, length:int):void
Updates the selection manager when text is inserted or deleted. | SelectionManager | ||
refreshSelection():void
Redisplays the selection shapes. | SelectionManager | ||
selectAll():void | SelectionManager | ||
selectRange(anchorPosition:int, activePosition:int):void | SelectionManager | ||
setFocus():void
Gives the focus to the first container in the selection. | SelectionManager | ||
setSelectionState(sel:SelectionState):void
Sets the SelectionState object of the current selection. | SelectionManager | ||
softKeyboardActivatingHandler(event:Event):void
Processes an softKeyboardActivating event
| SelectionManager | ||
textInputHandler(event:TextEvent):void
Processes a TextEvent. | SelectionManager | ||
| Method | Defined By | ||
|---|---|---|---|
setMouseCursor(cursor:String):void
Set the Mouse cursor. | SelectionManager | ||
| 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.
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.
public function get absoluteStart():int| 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.
public function get activePosition():int| anchorPosition | property |
anchorPosition:int [read-only] 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.
public function get anchorPosition():int| 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.
public function get currentSelectionFormat():SelectionFormatSee also
| 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.
public function get editingMode():StringSee also
| 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.
public function get focused():Boolean| 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.
public function get focusedSelectionFormat():SelectionFormat public function set focusedSelectionFormat(value:SelectionFormat):voidSee also
| 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.
public function get inactiveSelectionFormat():SelectionFormat public function set inactiveSelectionFormat(value:SelectionFormat):voidSee also
| pointFormat | property |
pointFormat:ITextLayoutFormat [read-only] The format that will be applied to inserted text. TBD: pointFormat needs to be extended to remember user styles and "undefine" of formats from calls to IEditManager.undefineFormat with leafFormat values on a point selection.
protected function get pointFormat():ITextLayoutFormat| 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.
public function get textFlow():TextFlow public function set textFlow(value:TextFlow):voidSee also
| 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.
public function get unfocusedSelectionFormat():SelectionFormat public function set unfocusedSelectionFormat(value:SelectionFormat):voidSee also
| 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.
public function get windowActive():Boolean| SelectionManager | () | Constructor |
public function SelectionManager()| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a SelectionManager object.
Assign a SelectionManager object to the interactionManager property of
a text flow to enable text selection.
| activateHandler | () | method |
public function activateHandler(event:Event):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes an activate event.
Parameters
event:Event |
| deactivateHandler | () | method |
public function deactivateHandler(event:Event):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a deactivate event.
Parameters
event:Event |
| doOperation | () | method |
public function doOperation(op:FlowOperation):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them.
Parameters
op:FlowOperation |
| editHandler | () | method |
public function editHandler(event:Event):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes an edit event.
Edit events are dispatched for cut, copy, paste, and selectAll commands.
Parameters
event:Event |
| flushPendingOperations | () | method |
public function flushPendingOperations():void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
| focusChangeHandler | () | method |
public function focusChangeHandler(event:FocusEvent):voidProcesses a focusChange event.
Parameters
event:FocusEvent |
| focusInHandler | () | method |
public function focusInHandler(event:FocusEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a focusIn event.
Parameters
event:FocusEvent |
| focusOutHandler | () | method |
public function focusOutHandler(event:FocusEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a focusOut event.
Parameters
event:FocusEvent |
| 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) |
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) |
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) |
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.
ReturnsSelectionState |
See also
| hasSelection | () | method |
public function hasSelection():Boolean| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Indicates whether there is a 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).
Boolean |
| imeStartCompositionHandler | () | method |
public function imeStartCompositionHandler(event:IMEEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes an imeStartComposition event
Parameters
event:IMEEvent |
| 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.
Boolean |
| keyDownHandler | () | method |
public function keyDownHandler(event:KeyboardEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a keyDown event.
Parameters
event:KeyboardEvent |
| keyFocusChangeHandler | () | method |
public function keyFocusChangeHandler(event:FocusEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a keyFocusChange event.
Parameters
event:FocusEvent |
| keyUpHandler | () | method |
public function keyUpHandler(event:KeyboardEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a keyUp event.
Parameters
event:KeyboardEvent |
| menuSelectHandler | () | method |
public function menuSelectHandler(event:ContextMenuEvent):voidProcesses a menuSelect event.
Parameters
event:ContextMenuEvent |
| mouseDoubleClickHandler | () | method |
public function mouseDoubleClickHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseDoubleClick event.
Parameters
event:MouseEvent |
| mouseDownHandler | () | method |
public function mouseDownHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseDown event.
Parameters
event:MouseEvent |
| mouseMoveHandler | () | method |
public function mouseMoveHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseMove event.
Parameters
event:MouseEvent |
| mouseOutHandler | () | method |
public function mouseOutHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseOut event.
Parameters
event:MouseEvent |
| mouseOverHandler | () | method |
public function mouseOverHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseOver event.
Parameters
event:MouseEvent |
| mouseUpHandler | () | method |
public function mouseUpHandler(event:MouseEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a mouseUp event.
Parameters
event:MouseEvent |
| mouseWheelHandler | () | method |
public function mouseWheelHandler(event:MouseEvent):voidProcesses a mouseWheel event.
Parameters
event:MouseEvent |
| 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 |
See also
| selectRange | () | method |
public function selectRange(anchorPosition:int, activePosition:int):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Parameters
anchorPosition:int | |
activePosition:int |
See also
| 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.
| setMouseCursor | () | method |
protected function setMouseCursor(cursor:String):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.0 |
Set the Mouse cursor.
Parameters
cursor:String — New cursor value, MouseCursor.AUTO if mouse is going off text, MouseCursor.IBEAM if mouse is going into text
|
| setSelectionState | () | method |
public function setSelectionState(sel:SelectionState):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Sets the SelectionState object of the current selection.
Parameters
sel:SelectionState |
See also
| softKeyboardActivatingHandler | () | method |
public function softKeyboardActivatingHandler(event:Event):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10.2, AIR 1.5 |
Processes an softKeyboardActivating event
Parameters
event:Event |
| textInputHandler | () | method |
public function textInputHandler(event:TextEvent):void| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Processes a TextEvent.
Parameters
event:TextEvent |