SelectionManager  - AS3

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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

Related API Elements

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.

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.

Related API Elements

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

Related API Elements

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

Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them.

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

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

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

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

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

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

Gets the SelectionState object of the current selection.

Related API Elements

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

Processes an imeStartComposition event

Parameters

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

Related API Elements

Parameters

Related API Elements

Gives the focus to the first container in the selection.

 textFlow.interactionManager.setFocus();

Set the Mouse cursor.

Parameters

Sets the SelectionState object of the current selection.

Parameters

Related API Elements

Processes an softKeyboardActivating event

Parameters

Processes a TextEvent.

Parameters

This example shows the use of the SelectionManager class.

It sets up a TextFlow, and a listener for selection changes, then updates based on the selection changes.

package flashx.textLayout.edit.examples {
    import flash.display.Sprite;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.conversion.TextConverter;
    import flashx.textLayout.edit.SelectionManager;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.ITextLayoutFormat;
    import flashx.textLayout.events.SelectionEvent;

    public class SelectionManager_example extends Sprite
    {
        private var textFlow:TextFlow;
        
        public function SelectionManager_example()
        {
            //define TextFlow, and make it read-select
            textFlow = TextConverter.importToFlow("This is sample text for the SelectionManager example.",
                TextConverter.PLAIN_TEXT_FORMAT);
            textFlow.interactionManager = new SelectionManager();
            
            //compose TextFlow to display
            textFlow.flowComposer.addController(new ContainerController(this,600,600));
            textFlow.flowComposer.updateAllControllers();
            
            //add event handlers to the TextFlow to detect when selection changes
            textFlow.addEventListener(SelectionEvent.SELECTION_CHANGE, selectionChanged);
        }

        private function selectionChanged(selectionEvent:SelectionEvent):void
        {
            var format:ITextLayoutFormat = textFlow.interactionManager.getCommonCharacterFormat();
            // do something here - perhaps update the application's UI based on the formatting
            // attributes applied in the current selected text range
        }
        
    }        
}