flashx.textLayout.editSelectionManager The SelectionManager class manages text selection in a text flow.flashx.textLayout.edit:ISelectionManagerObject The SelectionManager class manages text selection in a text flow.

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,LTRTB,RTLTL,LTRRL,RTLnonectrlalt|ctrl+altnonectrlalt|ctrl+altnonectrlalt|ctrl+altnonectrlalt|ctrl+altleftarrowpreviousCharacterpreviousWordpreviousWordnextCharacternextWordnextWordnextLineendOfDocumentendOfParagraphnextLineendOfDocumentendOfParagraphuparrowpreviousLinestartOfDocumentstartOfParagraphpreviousLinestartOfDocumentstartOfParagraphpreviousCharacterpreviousWordpreviousWordnextCharacternextWordnextWordrightarrownextCharacternextWordnextWordpreviousCharacterpreviousWordpreviousWordpreviousLinestartOfDocumentstartOfParagraphpreviousLinestartOfDocumentstartOfParagraphdownarrownextLineendOfDocumentendOfParagraphnextLineendOfDocumentendOfParagraphnextCharacternextWordnextWordpreviousCharacterpreviousWordpreviousWordhomestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLinestartOfLinestartOfDocumentstartOfLineendendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLineendOfLineendOfDocumentendOfLinepagedownnextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagenextPagepageuppreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPagepreviousPage

Key:

none = no modifier
ctrl, shift, alt = modifiers
alt-key and ctrl+alt-key are the same on all platforms (on some platforms alt-key does not get to the Text Layout Framework (TLF)
shift key modifes to extend the active end of the selection in the specified manner
TB (top-to-bottom),RL (right-to-left) are textFlow level blockProgression settings
LTR (left-to-right),RTL (right-to-left) are textFlow level direction settings
next and prev in logical order in the textFlow - the effect in RTL text is that the selection moves in the physical direction

EditManagerflashx.elements.TextFlow

SelectionManager Creates a SelectionManager object. Creates a SelectionManager object.

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

activateHandler event deactivateHandler event doOperation Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them.opflashx.textLayout.operations:FlowOperation Perform a SelectionManager operation - these may never modify the flow but clients still are able to cancel them. editHandler event flushPendingOperations focusChangeHandler event focusInHandler event focusOutHandler event getCommonCharacterFormat flashx.textLayout.formats:TextLayoutFormatThe common character style settings rangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. getCommonContainerFormat flashx.textLayout.formats:TextLayoutFormatThe common container style settings rangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. getCommonParagraphFormat flashx.textLayout.formats:TextLayoutFormatThe common paragraph style settings rangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. getSelectionState flashx.textLayout.edit:SelectionState

flashx.textLayout.edit.SelectionState

hasSelection imeStartCompositionHandler event isRangeSelection keyDownHandler event keyFocusChangeHandler event keyUpHandler event menuSelectHandler event mouseDoubleClickHandler event mouseDownHandler event mouseMoveHandler event mouseOutHandler event mouseOverHandler event mouseUpHandler event mouseWheelHandler event notifyInsertOrDelete absolutePositionThe point in the text where the change was made. lengthA positive or negative number indicating how many characters were inserted or deleted. refreshSelection selectAll

flashx.textLayout.compose.IFlowComposer

selectRange anchorPositionactivePosition

flashx.textLayout.compose.IFlowComposer

setFocus setMouseCursor Set the Mouse cursor.cursor New cursor value, MouseCursor.AUTO if mouse is going off text, MouseCursor.IBEAM if mouse is going into text Set the Mouse cursor. setSelectionState selflashx.textLayout.edit:SelectionState

flashx.textLayout.edit.SelectionState

softKeyboardActivatingHandler event textInputHandler event absoluteEnd absoluteStart activePosition anchorPosition currentSelectionFormat flashx.textLayout.edit:SelectionFormat

flashx.textLayout.edit.SelectionFormat

editingMode

flashx.textLayout.edit.EditingMode

focused pointFormat The format that will be applied to inserted text.flashx.textLayout.formats:ITextLayoutFormat 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. textFlow The TextFlow object managed by this selection manager.flashx.textLayout.elements:TextFlow 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.

flashx.textLayout.elements.TextFlow.interactionManager

windowActive focusedSelectionFormat flashx.textLayout.edit:SelectionFormat

flashx.textLayout.edit.SelectionFormat

inactiveSelectionFormat flashx.textLayout.edit:SelectionFormat

flashx.textLayout.edit.SelectionFormat

unfocusedSelectionFormat flashx.textLayout.edit:SelectionFormat

flashx.textLayout.edit.SelectionFormat

TextScrap The TextScrap class represents a fragment of a text flow.Object The TextScrap class represents a fragment of a text flow.

A TextScrap is a holding place for all or part of a TextFlow. A range of text can be copied from a TextFlow into a TextScrap, and pasted from the TextScrap into another TextFlow.

flashx.textLayout.elements.TextFlowflashx.textLayout.edit.SelectionManager

TextScrap Creates a TextScrap object.textFlowflashx.textLayout.elements:TextFlownullif set, the new TextScrap object contains the entire text flow. Otherwise, the TextScrap object is empty. Creates a TextScrap object.

Use the createTextScrap() method to create a TextScrap object from a range of text represented by a TextRange object.

clone Creates a duplicate copy of this TextScrap object.TextScrap A copy of this TextScrap. flashx.textLayout.edit:TextScrap Creates a duplicate copy of this TextScrap object. createTextScrap Creates a TextScrap object from a range of text represented by a TextRange object.flashx.textLayout.edit:TextScraprangeflashx.textLayout.elements:TextRangethe TextRange object representing the range of text to copy. Creates a TextScrap object from a range of text represented by a TextRange object. isPlainText Returns true if the text is plain text (not formatted) Returns true if the text is plain text (not formatted) setPlainText Marks the TextScrap's content as being either plain or formatted plainText Marks the TextScrap's content as being either plain or formatted MERGE_TO_NEXT_ON_PASTEmergeToNextOnPastetextFlow Gets the TextFlow that is currently in the TextScrap.flashx.textLayout.elements:TextFlow Gets the TextFlow that is currently in the TextScrap. ElementRange The ElementRange class represents the range of objects selected within a text flow.Object The ElementRange class represents the range of objects selected within a text flow.

The beginning elements (such as firstLeaf) are always less than or equal to the end elements (in this case, lastLeaf) for each pair of values in an element range.

flashx.textLayout.elements.TextFlow

createElementRange Creates an ElementRange object.flashx.textLayout.edit:ElementRangetextFlowflashx.textLayout.elements:TextFlowthe text flow absoluteStartabsolute text position of the first character in the text range absoluteEndone beyond the absolute text position of the last character in the text range Creates an ElementRange object. getCommonCharacterFormat Gets the character format attributes that are common to all characters in the text range or current selection.The common character style settings flashx.textLayout.formats:TextLayoutFormat Gets the character format attributes that are common to all characters in the text range or current selection.

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

getCommonContainerFormat Gets the container format attributes that are common to all containers in the element range.The common paragraph style settings flashx.textLayout.formats:TextLayoutFormat Gets the container format attributes that are common to all containers in the element range.

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

flashx.textLayout.edit.ISelectionManager.getCommonParagraphFormat

getCommonParagraphFormat Gets the paragraph format attributes that are common to all paragraphs in the element range.The common paragraph style settings flashx.textLayout.formats:TextLayoutFormat Gets the paragraph format attributes that are common to all paragraphs in the element range.

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

flashx.textLayout.edit.ISelectionManager.getCommonParagraphFormat

absoluteEnd The absolute text position of the FlowLeafElement object that contains the end of the range. The absolute text position of the FlowLeafElement object that contains the end of the range. absoluteStart The absolute text position of the FlowLeafElement object that contains the start of the range. The absolute text position of the FlowLeafElement object that contains the start of the range. characterFormat The format attributes of the characters in the range.flashx.textLayout.formats:ITextLayoutFormat The format attributes of the characters in the range.

If the range spans more than one FlowElement object, which means that more than one character format may exist within the range, the format of the first FlowElement object is returned.

containerFormat The format attributes of the container displaying the range.flashx.textLayout.formats:ITextLayoutFormat The format attributes of the container displaying the range.

If the range spans more than one container, the format of the first container is returned.

firstLeaf The FlowLeafElement object that contains the start of the range.flashx.textLayout.elements:FlowLeafElement The FlowLeafElement object that contains the start of the range. firstParagraph The ParagraphElement object that contains the start of the range.flashx.textLayout.elements:ParagraphElement The ParagraphElement object that contains the start of the range. lastLeaf The FlowLeafElement object that contains the end of the range.flashx.textLayout.elements:FlowLeafElement The FlowLeafElement object that contains the end of the range. lastParagraph The ParagraphElement object that contains the end of the range.flashx.textLayout.elements:ParagraphElement The ParagraphElement object that contains the end of the range. paragraphFormat The format attributes of the paragraph containing the range.flashx.textLayout.formats:ITextLayoutFormat The format attributes of the paragraph containing the range.

If the range spans more than one paragraph, the format of the first paragraph is returned.

textFlow The TextFlow object that contains the range.flashx.textLayout.elements:TextFlow The TextFlow object that contains the range. SelectionState The SelectionState class represents a selection in a text flow.flashx.textLayout.elements:TextRange The SelectionState class represents a selection in a text flow.

A selection range has an anchor point, representing the point at which the selection of text began, and an active point, representing the point to which the selection is extended. The active point can be before or after the anchor point in the text. If a selection is modified (for example, by a user shift-clicking with the mouse), the active point changes while the anchor point always remains in the same position.

flashx.textLayout.edit.ISelectionManager.getSelectionState()flashx.textLayout.elements.TextFlowflashx.textLayout.elements.TextRange

SelectionState Creates a SelectionState object.rootflashx.textLayout.elements:TextFlowThe TextFlow associated with the selection. anchorPositionThe anchor index of the selection. activePositionThe active index of the selection. formatflashx.textLayout.formats:ITextLayoutFormatnullThe TextLayoutFormat to be applied on next character typed when a point selection Creates a SelectionState object.

Note: Do not construct a SelectionState object in order to create a selection. To create a selection in a text flow, call the setSelection() method of the relevant ISelectionManager instance (which is the SelectionManager or EditManager object assigned to the interactionManager property of the text flow).

flashx.textLayout.edit.ISelectionManager.getSelectionState()flashx.textLayout.edit.SelectionManagerflashx.textLayout.edit.EditManager

updateRange Updates the selection range with new anchor or active position values.true if selection is changed newAnchorPositionthe anchor index of the selection. newActivePositionthe active index of the selection. Updates the selection range with new anchor or active position values.

The pointFormat styles are cleared if the selection is changed.

pointFormat The format attributes applied to inserted text.flashx.textLayout.formats:ITextLayoutFormat The format attributes applied to inserted text.

Note: The pointFormat object does not include inherited styles. To get all the applicable style definitions, use the getCommonCharacterFormat() method of the ISelectionManager class.

ISelectionManager.getCommonCharacterFormat()

IEditManager IEditManager defines the interface for handling edit operations of a text flow.flashx.textLayout.edit:ISelectionManager IEditManager defines the interface for handling edit operations of a text flow.

To enable text flow editing, assign an IEditManager instance to the interactionManager property of the TextFlow object. The edit manager handles changes to the text (such as insertions, deletions, and format changes). Changes are reversible if the edit manager has an undo manager. The edit manager triggers the recomposition and display of the text flow, as necessary.

EditManagerflashx.textLayout.elements.TextFlowflashx.undo.UndoManager

applyContainerFormat Applies container styles to any containers in the selection.formatflashx.textLayout.formats:ITextLayoutFormat The format to apply to the containers in the range operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Applies container styles to any containers in the selection.

Any style properties in the format object that are null are left unchanged.

applyFormatToElement Applies styles to the specified element.targetElementflashx.textLayout.elements:FlowElementThe element to which the styles are applied. formatflashx.textLayout.formats:ITextLayoutFormat The format containing the styles to apply. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new formatting. relativeEnd-1An offset from the beginning of the element at which to split the element when applying the new formatting. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Applies styles to the specified element.

Any style properties in the format object that are null are left unchanged. Only styles that are relevant to the specified element are applied.

applyFormat Changes the formats of the specified (or current) selection.leafFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to leaf elements such as spans and inline graphics. paragraphFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to paragraph elements. containerFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to the containers. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Changes the formats of the specified (or current) selection.

Executes an undoable operation that applies the new formats. Only style attributes set for the TextLayoutFormat objects are applied. Undefined attributes in the format objects are not changed.

applyLeafFormat Changes the format applied to the leaf elements in the specified (or current) selection.formatflashx.textLayout.formats:ITextLayoutFormat The format to apply. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Changes the format applied to the leaf elements in the specified (or current) selection.

Executes an undoable operation that applies the new format to leaf elements such as SpanElement and InlineGraphicElement objects. Only style attributes set for the TextLayoutFormat objects are applied. Undefined attributes in the format object are changed.

applyLink Transforms a selection into a link, or a link into normal text.The LinkElement that was created. flashx.textLayout.elements:LinkElementhrefThe uri referenced by the link. targetnullThe target browser window of the link. extendToLinkBoundaryfalseSpecifies whether to consolidate selection with any overlapping existing links, and then apply the change. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Transforms a selection into a link, or a link into normal text.

Executes an undoable operation that creates or removes the link.

If a target parameter is specified, it must be one of the following values:

"_self"
"_blank"
"_parent"
"_top"

In browser-hosted runtimes, a target of "_self" replaces the current html page. So, if the SWF content containing the link is in a page within a frame or frameset, the linked content loads within that frame. If the page is at the top level, the linked content opens to replace the original page. A target of "_blank" opens a new browser window with no name. A target of "_parent" replaces the parent of the html page containing the SWF content. A target of "_top" replaces the top-level page in the current browser window.

In other runtimes, such as Adobe AIR, the link opens in the user's default browser and the target parameter is ignored.

The extendToLinkBoundary parameter determines how the edit manager treats a selection that intersects with one or more existing links. If the parameter is true, then the operation is applied as a unit to the selection and the whole text of the existing links. Thus, a single link is created that spans from the beginning of the first link intersected to the end of the last link intersected. In contrast, if extendToLinkBoundary were false in this situation, the existing partially selected links would be split into two links.

flashx.textLayout.elements.LinkElement

applyParagraphFormat Applies paragraph styles to any paragraphs in the selection.formatflashx.textLayout.formats:ITextLayoutFormatThe format to apply to the selected paragraphs. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Applies paragraph styles to any paragraphs in the selection.

Any style properties in the format object that are null are left unchanged.

applyTCY Transforms text into a TCY run, or a TCY run into non-TCY text.The TCYElement that was created. flashx.textLayout.elements:TCYElementtcyOnSet to true to apply TCY to a text range, false to remove TCY. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Transforms text into a TCY run, or a TCY run into non-TCY text.

TCY, or tate-chu-yoko, causes text to draw horizontally within a vertical line, and is used to make small blocks of non-Japanese text or numbers, such as dates, more readable in vertical text.

flashx.textLayout.elements.TCYElement

beginCompositeOperation Begins a new group of operations. Begins a new group of operations.

All operations executed after the call to beginCompositeOperation(), and before the matching call to endCompositeOperation() are executed and grouped together as a single operation that can be undone as a unit.

A beginCompositeOperation/endCompositeOperation block can be nested inside another beginCompositeOperation/endCompositeOperation block.

flashx.textLayout.edit.IEditManager.endCompositeOperation

changeElementID Changes the ID of an element.newIDThe new ID value. targetElementflashx.textLayout.elements:FlowElementThe element to modify. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new ID. relativeEnd-1An offset from the beginning of the element at which to split the element when assigning the new ID. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the selection to restore when undoing this operation; if null, the operation saves the current selection. Changes the ID of an element.

If the relativeStart or relativeEnd parameters are set (to anything other than the default values), then the element is split. The parts of the element outside this range retain the original ID. Setting both the relativeStart and relativeEnd parameters creates elements with duplicate IDs.

changeStyleName Changes the styleName of an element or part of an element.newNameThe name of the new style. targetElementflashx.textLayout.elements:FlowElementSpecifies the element to change. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new style. relativeEnd-1An offset from the end of the element at which to split the element when assigning the new style. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the selection to restore when undoing this operation; if null, the operation saves the current selection. Changes the styleName of an element or part of an element.

If the relativeStart or relativeEnd parameters are set (to anything other than the default values), then the element is split. The parts of the element outside this range retain the original style.

changeTypeName Changes the typeName of an element or part of an element.newNameThe name of the new type. targetElementflashx.textLayout.elements:FlowElementSpecifies the element to change. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new style relativeEnd-1An offset from the end of the element at which to split the element when assigning the new style operationStateflashx.textLayout.edit:SelectionStatenull Specifies the selection to restore when undoing this operation; if null, the operation saves the current selection. Changes the typeName of an element or part of an element.

If the relativeStart or relativeEnd parameters are set (to anything other than the default values), then the element is split. The parts of the element outside this range retain the original style.

clearFormatOnElement Undefines styles to the specified element.targetElementflashx.textLayout.elements:FlowElementThe element to which the styles are applied. formatflashx.textLayout.formats:ITextLayoutFormat The format containing the styles to undefine. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Undefines styles to the specified element.

Any style properties in the format object that are undefined are left unchanged. Any styles that are defined in the specififed format are undefined on the specified element.

clearFormat Undefines formats of the specified (or current) selection.leafFormatflashx.textLayout.formats:ITextLayoutFormat The format whose set values indicate properties to undefine to LeafFlowElement objects in the selected range. paragraphFormatflashx.textLayout.formats:ITextLayoutFormatThe format whose set values indicate properties to undefine to ParagraphElement objects in the selected range. containerFormatflashx.textLayout.formats:ITextLayoutFormatThe format whose set values indicate properties to undefine to ContainerController objects in the selected range. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Undefines formats of the specified (or current) selection.

Executes an undoable operation that undefines the specified formats. Only style attributes set for the TextLayoutFormat objects are applied. Undefined attributes in the format objects are not changed.

createDiv Creates a new DivElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range.The new DivElement that was created. flashx.textLayout.elements:DivElementparentflashx.textLayout.elements:FlowGroupElementnull Specifies a parent element for the new DivElement. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnull Formatting attributes to apply to the new DivElement. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Creates a new DivElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range. If the start and end points are the same, a new DivElement is created at that position with a single child paragraph. createList Creates a new ListElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range.The new ListElement that was created. flashx.textLayout.elements:ListElementparentflashx.textLayout.elements:FlowGroupElementnullOptionally specifies a parent element for the new ListElement. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnullFormatting attributes to apply to the new ListElement. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Creates a new ListElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range. Each paragraph within the range will become a ListItemElement in the new ListElement. If the start and end points are the same, a new ListElement is created at that position with a single ListItemElement child. createSubParagraphGroup Creates a new SubParagraphGroupElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range.The new SubParagraphGroupElement that was created. flashx.textLayout.elements:SubParagraphGroupElementparentflashx.textLayout.elements:FlowGroupElementnullSpecifies a parent element for the new SubParagraphGroupElement element. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnull Formatting attributes to apply to the new SubParagraphGroupElement operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Creates a new SubParagraphGroupElement that contains the entire range specified in the operationState at the lowest common parent element that contains both the start and end points of the range. If the start and end points are the same, nothing is done. cutTextScrap Deletes the selected area and returns the deleted area in a TextScrap object.The TextScrap that was cut. flashx.textLayout.edit:TextScrapoperationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes the selected area and returns the deleted area in a TextScrap object.

The resulting TextScrap can be posted to the system clipboard or used in a subsequent pasteTextOperation() operation.

flashx.textLayout.edit.IEditManager.pasteTextScrapflashx.textLayout.edit.TextClipboard.setContents

deleteNextCharacter Deletes a range of text, or, if a point selection is given, deletes the next character.operationStateflashx.textLayout.edit:SelectionStatenull specifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes a range of text, or, if a point selection is given, deletes the next character. deleteNextWord Deletes the next word.operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes the next word.

If a range is selected, the first word of the range is deleted.

deletePreviousCharacter Deletes a range of text, or, if a point selection is given, deletes the previous character.operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes a range of text, or, if a point selection is given, deletes the previous character. deletePreviousWord Deletes the previous word.operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes the previous word.

If a range is selected, the first word of the range is deleted.

deleteText Deletes a range of text.operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Deletes a range of text. doOperation Executes a FlowOperation.operationflashx.textLayout.operations:FlowOperationa FlowOperation object Executes a FlowOperation.

The doOperation() method is called by IEditManager functions that update the text flow. You do not typically need to call this function directly unless you create your own custom operations.

This function proceeds in the following steps:

Flush any pending operations before performing this operation.
Send a cancelable flowOperationBegin event. If canceled this method returns immediately.
Execute the operation. The operation returns true or false. False indicates that no changes were made.
Push the operation onto the undo stack.
Clear the redo stack.
Update the display.
Send a cancelable flowOperationEnd event.

Exception handling: If the operation throws an exception, it is caught and the error is attached to the flowOperationEnd event. If the event is not canceled the error is rethrown.

endCompositeOperation Ends a group of operations. Ends a group of operations.

All operations executed since the last call to beginCompositeOperation() are grouped as a CompositeOperation that is then completed. This CompositeOperation object is added to the undo stack or, if this composite operation is nested inside another composite operation, added to the parent operation.

flashx.textLayout.edit.IEditManager.beginCompositeOperation

insertInlineGraphic Inserts an image.flashx.textLayout.elements:InlineGraphicElementsource Can be either a String interpreted as a uri, a Class interpreted as the class of an Embed DisplayObject, a DisplayObject instance or a URLRequest. width The width of the image to insert (number, percent, or 'auto'). height The height of the image to insert (number, percent, or 'auto'). optionsnullNone supported. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Inserts an image.

The source of the image can be a string containing a URI, URLRequest object, a Class object representing an embedded asset, or a DisplayObject instance.

The width and height values can be the number of pixels, a percent, or the string, 'auto', in which case the actual dimension of the graphic is used.

Set the float to one of the constants defined in the Float class to specify whether the image should be displayed to the left or right of any text or inline with the text.

flashx.textLayout.elements.InlineGraphicElement

insertText Inserts text.text The string to insert. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text in the flow to which this operation applies; if null, the operation applies to the current selection. Inserts text.

Inserts the text at a position or range in the text. If the location supplied in the operationState parameter is a range (or the parameter is null and the current selection is a range), then the text currently in the range is replaced by the inserted text.

modifyInlineGraphic Modifies an existing inline graphic.source Can be either a String interpreted as a uri, a Class interpreted as the class of an Embed DisplayObject, a DisplayObject instance or a URLRequest. width The new width for the image (number or percent). height The new height for the image (number or percent). optionsnullNone supported. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Modifies an existing inline graphic.

Set unchanging properties to the values in the original graphic. (Modifying an existing graphic object is typically more efficient than deleting and recreating one.)

flashx.textLayout.elements.InlineGraphicElement

moveChildren Move a set of FlowElements from one FlowGroupElement to another.sourceflashx.textLayout.elements:FlowGroupElement The orginal parent of the elements to be moved. sourceIndex The child index within the source of the first element to be moved. numChildren The number of children being moved. destinationflashx.textLayout.elements:FlowGroupElement The new parent of elements after move. destinationIndex The child index within the destination to where elements are moved to. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies, and to which selection returns to upon undo. If null, the operation applies to the current selection. If there is no current selection, this parameter must be non-null. Move a set of FlowElements from one FlowGroupElement to another. The desinationElement must be a legal parent type for the children being moved, or an exception is thrown. overwriteText Overwrites the selected text.textThe string to insert. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the text to which this operation applies; if null, the operation applies to the current selection. Overwrites the selected text.

If the selection is a point selection, the first character is overwritten by the new text.

pasteTextScrap Pastes the TextScrap into the selected area.scrapToPasteflashx.textLayout.edit:TextScrap The TextScrap to paste. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Pastes the TextScrap into the selected area.

If a range of text is specified, the text in the range is deleted.

flashx.textLayout.edit.IEditManager.cutTextScrapflashx.textLayout.edit.TextClipboard.getContentsflashx.textLayout.edit.TextScrap

redo Reperforms the previous undone operation. Reperforms the previous undone operation.

Note: If the IUndoManager associated with this IEditManager is also associated with another IEditManager, then it is possible that the redo operation associated with the other IEditManager is the one redone. This can happen if the FlowOperation of another IEditManager is on top of the redo stack.

This function does nothing if undo is not turned on.

flashx.undo.IUndoManager.redo()

splitElement Splits the target element at the location specified, creating a new element after the current one.The new paragraph that was created. flashx.textLayout.elements:FlowGroupElementtargetflashx.textLayout.elements:FlowGroupElement The element to be split. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Splits the target element at the location specified, creating a new element after the current one. If the operationState is a range, the text within the range is deleted. The new element is created after the text position specified by operationState. Note that splitting a SubParagraphGroupElement will have no effect because they will automatically remerge with the adejacent elements.

An example where you might want to use this is if you have a list, and you want to divide it into two lists.

splitParagraph Splits the paragraph at the current position, creating a new paragraph after the current one.The new paragraph that was created. flashx.textLayout.elements:ParagraphElementoperationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. Splits the paragraph at the current position, creating a new paragraph after the current one.

If a range of text is specified, the text in the range is deleted.

undo Reverses the previous operation. Reverses the previous operation.

Note: If the IUndoManager associated with this IEditManager is also associated with another IEditManager, then it is possible that the undo operation associated with the other IEditManager is the one undone. This can happen if the FlowOperation of another IEditManager is on top of the undo stack.

This function does nothing if undo is not turned on.

flashx.undo.IUndoManager.undo()

updateAllControllers Updates the display after an operation has modified it. Updates the display after an operation has modified it. Normally this is handled automatically, but call this method if delayUpdates is on, and the display should be updated before the next enter_frame event. allowDelayedOperations Controls whether operations can be queued up for later execution. Controls whether operations can be queued up for later execution.

Execution of some operations might be delayed as a performance optimization. For example, it is convenient to be able to combine multiple keystrokes into a single insert operation. If allowDelayedOperations is true, then operations may be queued up. If false, all operations are executed immediately. By default, it is true.

flashx.edit.ISelectionManager.flushPendingOperations

delayUpdates By default, calls into IEditManager handle updates synchronously, so the requested change is made and the text recomposed and added to the display list within the IEditManager method. By default, calls into IEditManager handle updates synchronously, so the requested change is made and the text recomposed and added to the display list within the IEditManager method. To get a delayed redraw, set delayUpdates to true. This causes the IEditManager to only update the model, and recompose and redraw on the next enter_frame event. undoManager The UndoManager object assigned to this EditManager instance, if there is one.flashx.undo:IUndoManager The UndoManager object assigned to this EditManager instance, if there is one.

An undo manager handles undo and redo operations.

ISelectionManager The ISelectionManager interface defines the interface for handling text selection.flashx.textLayout.edit:IInteractionEventHandler The ISelectionManager interface defines the interface for handling text selection.

A SelectionManager keeps track of the selected text range and handles events for a TextFlow.

A selection can be either a point selection or a range selection. A point selection is the insertion point and is indicated visually by drawing a cursor. A range selection includes the text between an anchor point and an active point.

flashx.textLayout.edit.SelectionManagerflashx.textLayout.edit.TextScrapflashx.textLayout.elements.TextFlow

flushPendingOperations Executes any pending FlowOperations. 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.

getCommonCharacterFormat Gets the character format attributes that are common to all characters in the specified text range or current selection.The common character style settings flashx.textLayout.formats:TextLayoutFormatrangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. 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.

getCommonContainerFormat Gets the container format attributes that are common to all containers in the specified text range or current selection.The common container style settings flashx.textLayout.formats:TextLayoutFormatrangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. 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.

getCommonParagraphFormat Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.The common paragraph style settings flashx.textLayout.formats:TextLayoutFormatrangeflashx.textLayout.elements:TextRangenullThe optional range of text for which common attributes are requested. If null, the current selection is used. 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.

getSelectionState Gets the SelectionState object of the current selection.flashx.textLayout.edit:SelectionState Gets the SelectionState object of the current selection.

flashx.textLayout.edit.SelectionState

hasSelection Indicates whether there is a selection. 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).

isRangeSelection Indicates whether the selection covers a range of text. Indicates whether the selection covers a range of text.

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

notifyInsertOrDelete Updates the selection manager when text is inserted or deleted.absolutePositionThe point in the text where the change was made. lengthA positive or negative number indicating how many characters were inserted or deleted. 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.

refreshSelection Redisplays the selection shapes. Redisplays the selection shapes.

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

selectAll Selects the entire flow. Selects the entire flow. selectRange Selects a range of text.anchorPositionThe anchor point for the new selection, as an absolute position in the TextFlow activePositionThe active end of the new selection, as an absolute position in the TextFlow Selects a range of text.

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

setFocus Gives the focus to the first container in the selection. Gives the focus to the first container in the selection. setSelectionState Sets the SelectionState object of the current selection.stateflashx.textLayout.edit:SelectionState Sets the SelectionState object of the current selection.

flashx.textLayout.edit.SelectionState

absoluteEnd The text position of the end of the selection, as an offset from the start of the text flow. 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.

absoluteStart The text position of the start of the selection, as an offset from the start of 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.

activePosition The active point of the selection. 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.

anchorPosition The anchor point 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.

currentSelectionFormat The current SelectionFormat object.flashx.textLayout.edit:SelectionFormat 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.

editingMode The editing mode. 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.

flashx.textLayout.EditingMode

focusedSelectionFormat The SelectionFormat object used to draw the selection in a focused container.flashx.textLayout.edit:SelectionFormat The SelectionFormat object used to draw the selection in a focused container. focused Indicates whether a container in the text flow has the focus. 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.

inactiveSelectionFormat The SelectionFormat object used to draw the selection when it is not in the active window.flashx.textLayout.edit:SelectionFormat The SelectionFormat object used to draw the selection when it is not in the active window. textFlow The TextFlow object managed by this selection manager.flashx.textLayout.elements:TextFlow 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.

flashx.textLayout.elements.TextFlow.interactionManager

unfocusedSelectionFormat The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.flashx.textLayout.edit:SelectionFormat The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window. windowActive Indicates whether the window associated with the text flow is active. 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.

EditManager The EditManager class manages editing changes to a TextFlow.flashx.textLayout.edit:IEditManagerflashx.textLayout.edit:SelectionManager The EditManager class manages editing changes to a TextFlow.

To enable text flow editing, assign an EditManager object to the interactionManager property of the TextFlow object. The edit manager handles changes to the text (such as insertions, deletions, and format changes). Changes are reversible if the edit manager has an undo manager. The edit manager triggers the recomposition and display of the text flow, as necessary.

The EditManager class supports the following keyboard shortcuts:

KeysResultctrl-zundoctrl-yredoctrl-backspacedeletePreviousWordctrl-deletedeleteNextWordalt+deletedeleteNextWordctrl+alt-deletedeleteNextWordctrl-shift-hypheninsert discretionary hyphenctrl+backspacedeletePreviousWordalt+backspacedeletePreviousWordctrl+alt-backspacedeletePreviousWordINSERTtoggles overWriteModebackspacedeletePreviousCharacterENTERif textFlow.configuration.manageEnterKey in a list it creates a new list item, otherwise creates a new paragraphshift-ENTERif textFlow.configuration.manageEnterKey creates a new paragraphTABif textFlow.configuration.manageTabKey in a list it creates nested list, otherwise inserts a TAB or overwrites next character with a TABshift-TABif textFlow.configuration.manageTabKey in the first item of a list it moves the item out of the list (promotes it)

Note: The following keys do not work on Windows: alt-backspace, alt-delete, ctrl+alt-backspace, and ctrl+alt-delete. These keys do not generate an event for the runtime.

flashx.textLayout.elements.TextFlowflashx.undo.UndoManager

EditManager Creates an EditManager object.undoManagerflashx.undo:IUndoManagernullThe UndoManager for the application Creates an EditManager object.

Assign an EditManager object to the interactionManager property of a text flow to enable editing of that text flow.

To enable support for undoing and redoing changes, pass an IUndoManager instance to the EditManager constructor. You can use the flashx.undo.UndoManager class or create a custom IUndoManager instance. Use a custom IUndoManager instance to integrate Text Layout Framework changes with an existing undo manager that is not an instance of the UndoManager class. To create a custom IUndoManager instance, ensure that the class you use to define the undo manager implements the IUndoManager interface.

flashx.textLayout.elements.TextFlow.interactionManagerflashx.undo.IUndoManager

applyContainerFormat containerFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to the containers in the range operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyFormatToElement targetElementflashx.textLayout.elements:FlowElementThe element to which the styles are applied. formatflashx.textLayout.formats:ITextLayoutFormat The format containing the styles to apply. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new formatting. relativeEnd-1An offset from the beginning of the element at which to split the element when applying the new formatting. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyFormat leafFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to leaf elements such as spans and inline graphics. paragraphFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to paragraph elements. containerFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply to the containers. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyLeafFormat characterFormatflashx.textLayout.formats:ITextLayoutFormat The format to apply. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyLink flashx.textLayout.elements:LinkElementThe LinkElement that was created. hrefThe uri referenced by the link. targetStringnullThe target browser window of the link. extendToLinkBoundaryfalseSpecifies whether to consolidate selection with any overlapping existing links, and then apply the change. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyParagraphFormat paragraphFormatflashx.textLayout.formats:ITextLayoutFormatThe format to apply to the selected paragraphs. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. applyTCY flashx.textLayout.elements:TCYElementThe TCYElement that was created. tcyOnSet to true to apply TCY to a text range, false to remove TCY. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. beginCompositeOperation changeElementID newIDThe new ID value. targetElementflashx.textLayout.elements:FlowElementThe element to modify. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new ID. relativeEnd-1An offset from the beginning of the element at which to split the element when assigning the new ID. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the selection to restore when undoing this operation; if null, the operation saves the current selection. changeStyleName newNameThe name of the new style. targetElementflashx.textLayout.elements:FlowElementSpecifies the element to change. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new style. relativeEnd-1An offset from the end of the element at which to split the element when assigning the new style. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the selection to restore when undoing this operation; if null, the operation saves the current selection. changeTypeName newNameThe name of the new type. targetElementflashx.textLayout.elements:FlowElementSpecifies the element to change. relativeStart0An offset from the beginning of the element at which to split the element when assigning the new style relativeEnd-1An offset from the end of the element at which to split the element when assigning the new style operationStateflashx.textLayout.edit:SelectionStatenull Specifies the selection to restore when undoing this operation; if null, the operation saves the current selection. clearFormatOnElement targetElementflashx.textLayout.elements:FlowElementThe element to which the styles are applied. formatflashx.textLayout.formats:ITextLayoutFormat The format containing the styles to undefine. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. clearFormat leafFormatflashx.textLayout.formats:ITextLayoutFormat The format whose set values indicate properties to undefine to LeafFlowElement objects in the selected range. paragraphFormatflashx.textLayout.formats:ITextLayoutFormatThe format whose set values indicate properties to undefine to ParagraphElement objects in the selected range. containerFormatflashx.textLayout.formats:ITextLayoutFormatThe format whose set values indicate properties to undefine to ContainerController objects in the selected range. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. createDiv flashx.textLayout.elements:DivElementThe new DivElement that was created. parentflashx.textLayout.elements:FlowGroupElementnull Specifies a parent element for the new DivElement. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnull Formatting attributes to apply to the new DivElement. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. createList flashx.textLayout.elements:ListElementThe new ListElement that was created. parentflashx.textLayout.elements:FlowGroupElementnullOptionally specifies a parent element for the new ListElement. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnullFormatting attributes to apply to the new ListElement. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. createSubParagraphGroup flashx.textLayout.elements:SubParagraphGroupElementThe new SubParagraphGroupElement that was created. parentflashx.textLayout.elements:FlowGroupElementnullSpecifies a parent element for the new SubParagraphGroupElement element. If null the new parent will be lowest level that contains the SelectionState. formatflashx.textLayout.formats:ITextLayoutFormatnull Formatting attributes to apply to the new SubParagraphGroupElement operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. cutTextScrap flashx.textLayout.edit:TextScrapThe TextScrap that was cut. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection.

flashx.textLayout.edit.TextScrap

deleteNextCharacter operationStateflashx.textLayout.edit:SelectionStatenull specifies the text to which this operation applies; if null, the operation applies to the current selection. deleteNextWord operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the text to which this operation applies; if null, the operation applies to the current selection. deletePreviousCharacter operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. deletePreviousWord operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. deleteText operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. doOperation operationflashx.textLayout.operations:FlowOperationa FlowOperation object endCompositeOperation insertInlineGraphic flashx.textLayout.elements:InlineGraphicElementsource Can be either a String interpreted as a uri, a Class interpreted as the class of an Embed DisplayObject, a DisplayObject instance or a URLRequest. width The width of the image to insert (number, percent, or 'auto'). height The height of the image to insert (number, percent, or 'auto'). optionsnullNone supported. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection.

flash.text.engine.TextRotation

insertText text The string to insert. origOperationStateflashx.textLayout.edit:SelectionStatenull Specifies the text in the flow to which this operation applies; if null, the operation applies to the current selection. modifyInlineGraphic source Can be either a String interpreted as a uri, a Class interpreted as the class of an Embed DisplayObject, a DisplayObject instance or a URLRequest. width The new width for the image (number or percent). height The new height for the image (number or percent). optionsnullNone supported. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. moveChildren sourceflashx.textLayout.elements:FlowGroupElement The orginal parent of the elements to be moved. sourceIndex The child index within the source of the first element to be moved. numChildren The number of children being moved. destinationflashx.textLayout.elements:FlowGroupElement The new parent of elements after move. destinationIndex The child index within the destination to where elements are moved to. selectionStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies, and to which selection returns to upon undo. If null, the operation applies to the current selection. If there is no current selection, this parameter must be non-null. overwriteText textThe string to insert. operationStateflashx.textLayout.edit:SelectionStatenullSpecifies the text to which this operation applies; if null, the operation applies to the current selection. pasteTextScrap scrapToPasteflashx.textLayout.edit:TextScrap The TextScrap to paste. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection.

flashx.textLayout.edit.TextScrap

redo

flashx.undo.IUndoManager.redo()

splitElement flashx.textLayout.elements:FlowGroupElementThe new paragraph that was created. targetflashx.textLayout.elements:FlowGroupElement The element to be split. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. splitParagraph flashx.textLayout.elements:ParagraphElementThe new paragraph that was created. operationStateflashx.textLayout.edit:SelectionStatenull Specifies the text to which this operation applies; if null, the operation applies to the current selection. undo

flashx.undo.IUndoManager.undo()

updateAllControllers overwriteMode Indicates whether overwrite mode is on or off.false Indicates whether overwrite mode is on or off.

If true, then a keystroke overwrites the character following the cursor. If false, then a keystroke is inserted at the cursor location.

allowDelayedOperations delayUpdates undoManager The IUndoManager assigned to this edit manager.flashx.undo:IUndoManager The IUndoManager assigned to this edit manager.

To allow edits to be undone (and redone), pass an IUndoManager instance to the EditManager constructor. The undo manager maintains a stack of operations that have been executed, and it can undo or redo individual operations.

Note: If the TextFlow is modified directly (not via calls to the EditManager, but directly via calls to the managed FlowElement objects), then the EditManager clears the undo stack to prevent the stack from getting out of sync with the current state.

IInteractionEventHandler The IInteractionEventHandler interface defines the event handler functions that are handled by a Text Layout Framework selection or edit manager. The IInteractionEventHandler interface defines the event handler functions that are handled by a Text Layout Framework selection or edit manager. activateHandler Processes an activate event.event Processes an activate event. deactivateHandler Processes a deactivate event.event Processes a deactivate event. editHandler Processes an edit event.event Processes an edit event.

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

focusChangeHandler Processes a focusChange event.event Processes a focusChange event. focusInHandler Processes a focusIn event.event Processes a focusIn event. focusOutHandler Processes a focusOut event.event Processes a focusOut event. imeStartCompositionHandler Processes an imeStartComposition event event Processes an imeStartComposition event keyDownHandler Processes a keyDown event.event Processes a keyDown event. keyFocusChangeHandler Processes a keyFocusChange event.event Processes a keyFocusChange event. keyUpHandler Processes a keyUp event.event Processes a keyUp event. menuSelectHandler Processes a menuSelect event.event Processes a menuSelect event. mouseDoubleClickHandler Processes a mouseDoubleClick event.event Processes a mouseDoubleClick event. mouseDownHandler Processes a mouseDown event.event Processes a mouseDown event. mouseMoveHandler Processes a mouseMove event.event Processes a mouseMove event. mouseOutHandler Processes a mouseOut event.event Processes a mouseOut event. mouseOverHandler Processes a mouseOver event.event Processes a mouseOver event. mouseUpHandler Processes a mouseUp event.event Processes a mouseUp event. mouseWheelHandler Processes a mouseWheel event.event Processes a mouseWheel event. softKeyboardActivatingHandler Processes an softKeyboardActivating event event Processes an softKeyboardActivating event textInputHandler Processes a TextEvent.event Processes a TextEvent. SelectionFormat The SelectionFormat class defines the properties of a selection highlight.Object The SelectionFormat class defines the properties of a selection highlight.

flashx.textLayout.edit.ISelectionManagerflashx.textLayout.edit.SelectionManager

SelectionFormat Creates a SelectionFormat object with the specified properties.rangeColor0xffffffThe color for drawing the highlight. rangeAlpha1.0The transparency value for drawing the highlight. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default). rangeBlendModedifferenceThe blend mode for drawing the highlight. Use constants defined in the BlendMode class to set this parameter. pointColor0xffffffThe color for the drawing cursor. pointAlpha1.0The transparency value for drawing the cursor. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default). pointBlendModedifferenceThe blend mode for drawing the cursor. Use constants defined in the BlendMode class to set this parameter. pointBlinkRate500The rate at which the cursor blinks, in milliseconds. Creates a SelectionFormat object with the specified properties.

A SelectionFormat created with the default values will use black for the highlight colors, 1.0 for the alphas, and BlendMode.DIFFERENCE for the blending modes. The cursor blink rate is 500 milliseconds.

Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.

Non-zero blink rate is only used when an EditManager is attached to the TextFlow.

flash.display.BlendModepointAlpharangeAlpha

equals Determines whether this SelectionFormat object has the same property values as another SelectionFormat object.true, if the property values are identical; false, otherwise. selectionFormatflashx.textLayout.edit:SelectionFormatthe SelectionFormat to compare against. Determines whether this SelectionFormat object has the same property values as another SelectionFormat object. pointAlpha The alpha for drawing the cursor. The alpha for drawing the cursor. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).

Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.

rangeAlpha

pointBlendMode The blend mode for drawing the cursor. The blend mode for drawing the cursor.

flash.display.BlendMode

pointBlinkRate The rate at which the cursor blinks, in milliseconds. The rate at which the cursor blinks, in milliseconds. pointColor The color for drawing the cursor. The color for drawing the cursor. rangeAlpha The alpha for drawing the highlight of a range selection. The alpha for drawing the highlight of a range selection. Valid values are between 0 (completely transparent) and 1 (completely opaque, which is the default).

Setting the pointAlpha and rangeAlpha properties to zero disables selection highlighting.

pointAlpha

rangeBlendMode The blending mode for drawing the highlight of a range selection. The blending mode for drawing the highlight of a range selection.

flash.display.BlendMode

rangeColor The color for drawing the highlight of a range selection. The color for drawing the highlight of a range selection. TextClipboard The TextClipboard class copies and pastes TextScrap objects to and from the system clipboard.Object The TextClipboard class copies and pastes TextScrap objects to and from the system clipboard.

When you copy a TextScrap to the TextClipboard, the information is copied to the system clipboard in two clipboard formats. One format is an XML string expressing the copied TextScrap object in Text Layout Markup syntax. This clipboard object uses the format name: "TEXT_LAYOUT_MARKUP". The second format is a plain-text string, which uses the standard Clipboard.TEXT_FORMAT name.

The methods of the TextClipboard class are static functions, you do not need to create an instance of TextClipboard.

flash.desktop.Clipboard

getContents Gets any text on the system clipboard as a TextScrap object.flashx.textLayout.edit:TextScrap Gets any text on the system clipboard as a TextScrap object.

If the "TEXT_LAYOUT_MARKUP" format is available, this method converts the formatted string into a TextScrap and returns it. Otherwise, if the Clipboard.TEXT_Format is available, this method converts the plain-text string into a TextScrap. If neither clipboard format is available, this method returns null.

Flash Player requires that the getContents() method be called in a paste event handler. In AIR, this restriction only applies to content outside of the application security sandbox.

flash.events.Event.PASTE

setContents Puts a TextScrap onto the system clipboard.textScrapflashx.textLayout.edit:TextScrapThe TextScrap to paste into the clipboard. Puts a TextScrap onto the system clipboard.

The TextScrap is placed onto the system clipboard as both a Text Layout Markup representation and a plain text representation.

Flash Player requires a user event (such as a key press or mouse click) before calling setContents(). In AIR, this restriction only applies to content outside of the application security sandbox.

flash.events.Event.COPYflash.events.Event.CUT

EditingMode The EditingMode class defines constants used with EditManager class to represent the read, select, and edit permissions of a document.Object The EditingMode class defines constants used with EditManager class to represent the read, select, and edit permissions of a document.

flashx.textLayout.edit.EditManager

READ_ONLY The document is read-only.readOnly The document is read-only.

Neither selection nor editing is allowed.

READ_SELECT The text in the document can be selected and copied, but not edited.readSelect The text in the document can be selected and copied, but not edited. READ_WRITE The document can be edited.readWrite The document can be edited.