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.

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.

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.

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.

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.

See also

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.

See also

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.

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

See also

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

See also

The format that will be applied to inserted text.

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.

See also

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

See also

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.

Creates a SelectionManager object.

Assign a SelectionManager object to the interactionManager property of a text flow to enable text selection.

Processes an activate event.

Parameters

Processes a deactivate event.

Parameters

Processes an edit event.

Edit events are dispatched for cut, copy, paste, and selectAll commands.

Parameters

Processes a focusChange event.

Parameters

Processes a focusIn event.

Parameters

Processes a focusOut event.

Parameters

Gets the character format attributes that are common to all characters in the current selection.

Format attributes that do not have the same value for all characters in the selection are set to null in the returned ITextLayoutFormat instance.

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

Gets the container format attributes that are common to all containers in the current selection.

Format attributes that do not have the same value for all containers in the selection are set to null in the returned ITextLayoutFormat instance.

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

Gets the paragraph format attributes that are common to all paragraphs in the current selection.

Format attributes that do not have the same value for all paragraphs in the selection are set to null in the returned ITextLayoutFormat instance.

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

Gets the SelectionState object of the current selection.

See also

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

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).

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

Indicates whether the selection covers a range of text.

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

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

Processes a keyDown event.

Parameters

Processes a keyUp event.

Parameters

Processes a menuSelect event.

Parameters

Processes a mouseDoubleClick event.

Parameters

Processes a mouseDown event.

Parameters

Processes a mouseMove event.

Parameters

Processes a mouseOut event.

Parameters

Processes a mouseOver event.

Parameters

Processes a mouseUp event.

Parameters

Processes a mouseWheel event.

Parameters

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

 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 );
}

Redisplays the selection shapes.

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

See also

Parameters

See also

Gives the focus to the first container in the selection.

 textFlow.interactionManager.setFocus();

Processes a TextEvent.

Parameters

This example shows the use of the SelectionManager class.

It sets up a Div element that contains a paragraph with text. The Div is added to a TextFlow object (tf), which is composed to a display object container. A new SelectionManager is assigned as the TextFlow's interactionManager.

Three existing button objects (selectable, copytoclip, and pastefromclip) are assumed to be on the stage in this example. Event listeners assigned to these buttons are used to manipulate the SelectionManager.

package {
    import flash.display.Sprite;
    import flashx.textLayout.edit.TextClipboard;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.edit.SelectionManager;
    import flashx.textLayout.elements.DivElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.container.ContainerController;
    import flash.events.MouseEvent;

    public class SelectionManager_ex extends Sprite
    {
        private var tf:TextFlow;
        private var sm:SelectionManager;
        
        public function SelectionManager_ex()
        {
            //define TextFlow and manager objects
            tf = new TextFlow();
            sm = new SelectionManager();
            tf.interactionManager = sm;
            
            //define elements to contain text
            var d:DivElement = new DivElement();
            var p:ParagraphElement = new ParagraphElement();
            var s:SpanElement = new SpanElement();
            s.text ="This is sample text for the SelectionManager example.";
            
            //add these elements to the TextFlow
            p.addChild(s);
            d.addChild(p);
            tf.addChild(d);    
            
            //compose TextFlow to display
            tf.flowComposer.addController(new ContainerController(this,600,600));
            tf.flowComposer.updateAllContainers();
            
            //add event handlers to existing button objects on the stage
            selectable.addEventListener(MouseEvent.CLICK, updateToBeSelectable);
            copytoclip.addEventListener(MouseEvent.CLICK, copySelToClipboard);
            pastefromclip.addEventListener(MouseEvent.CLICK, pasteFromClipboard);            
        }
        private function updateToBeSelectable(me:MouseEvent):void{
            undo.enabled = true;
            tf.interactionManager = sm;
        }
        private function copySelToClipboard(me:MouseEvent):void{
            if(sm.hasSelection()) {
                var ts:TextScrap = sm.createTextScrap;
                sm.setContents(ts);
            }
        }
        private function pasteFromClipboard(me:MouseEvent):void{
            var ts:TextScrap = TextClipboard.getContents();
            sm.pasteTextScrap(ts);
        }

        
    }        
}