Packageflashx.textLayout.edit
Interfacepublic interface IEditManager extends ISelectionManager, IInteractionEventHandler
Implementors EditManager

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

See also

EditManager
flashx.textLayout.elements.TextFlow
flashx.undo.UndoManager


Public Properties
 PropertyDefined By
 InheritedabsoluteEnd : int
[read-only] The text position of the end of the selection, as an offset from the start of the text flow.
ISelectionManager
 InheritedabsoluteStart : int
[read-only] The text position of the start of the selection, as an offset from the start of the text flow.
ISelectionManager
 InheritedactiveCellPosition : CellCoordinates
Active end of the current cell selection, as coordinates within the table.
ISelectionManager
 InheritedactivePosition : int
[read-only] The active point of the selection.
ISelectionManager
  allowDelayedOperations : Boolean
Controls whether operations can be queued up for later execution.
IEditManager
 InheritedanchorCellPosition : CellCoordinates
Anchor point of the current cell selection, as coordinates within the table.
ISelectionManager
 InheritedanchorPosition : int
[read-only] The anchor point of the selection.
ISelectionManager
 InheritedcurrentCellSelectionFormat : SelectionFormat
[read-only] The current Cell SelectionFormat object.
ISelectionManager
 InheritedcurrentSelectionFormat : SelectionFormat
[read-only] The current SelectionFormat object.
ISelectionManager
 InheritedcurrentTable : TableElement
ISelectionManager
  delayUpdates : Boolean
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.
IEditManager
 InheritededitingMode : String
[read-only] The editing mode.
ISelectionManager
 Inheritedfocused : Boolean
[read-only] Indicates whether a container in the text flow has the focus.
ISelectionManager
 InheritedfocusedCellSelectionFormat : SelectionFormat
The SelectionFormat object used to draw cell selections in a focused container.
ISelectionManager
 InheritedfocusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection in a focused container.
ISelectionManager
 InheritedinactiveCellSelectionFormat : SelectionFormat
The SelectionFormat object used to draw cell selections when they are not in the active window.
ISelectionManager
 InheritedinactiveSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in the active window.
ISelectionManager
 InheritedselectionType : String
[read-only] Indicates the type of selection.
ISelectionManager
 InheritedsubManager : ISelectionManager
The ISelectionManager object used to for cell selections nested within the TextFlow managed by this ISelectionManager.
ISelectionManager
 InheritedsuperManager : ISelectionManager
The ISelectionManager object used to manage the parent TextFlow of this ISelectionManager (i.e.
ISelectionManager
 InheritedtextFlow : TextFlow
The TextFlow object managed by this selection manager.
ISelectionManager
  undoManager : IUndoManager
[read-only] The UndoManager object assigned to this EditManager instance, if there is one.
IEditManager
 InheritedunfocusedCellSelectionFormat : SelectionFormat
The SelectionFormat object used to draw cell selections when they are not in a focused container, but are in the active window.
ISelectionManager
 InheritedunfocusedSelectionFormat : SelectionFormat
The SelectionFormat object used to draw the selection when it is not in a focused container, but is in the active window.
ISelectionManager
 InheritedwindowActive : Boolean
[read-only] Indicates whether the window associated with the text flow is active.
ISelectionManager
Public Methods
 MethodDefined By
 Inherited
activateHandler(event:Event):void
Processes an activate event.
IInteractionEventHandler
  
applyContainerFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void
Applies container styles to any containers in the selection.
IEditManager
  
applyFormat(leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat, operationState:SelectionState = null):void
Changes the formats of the specified (or current) selection.
IEditManager
  
applyFormatToElement(targetElement:FlowElement, format:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void
Applies styles to the specified element.
IEditManager
  
applyLeafFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void
Changes the format applied to the leaf elements in the specified (or current) selection.
IEditManager
  
applyLink(href:String, target:String = null, extendToLinkBoundary:Boolean = false, operationState:SelectionState = null):LinkElement
Transforms a selection into a link, or a link into normal text.
IEditManager
  
applyParagraphFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void
Applies paragraph styles to any paragraphs in the selection.
IEditManager
  
applyTCY(tcyOn:Boolean, operationState:SelectionState = null):TCYElement
Transforms text into a TCY run, or a TCY run into non-TCY text.
IEditManager
  
Begins a new group of operations.
IEditManager
  
changeElementID(newID:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void
Changes the ID of an element.
IEditManager
  
changeStyleName(newName:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void
Deprecated Since 2.0: Please Use applyFormatToElement
Changes the styleName of an element or part of an element.
IEditManager
  
changeTypeName(newName:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void
Changes the typeName of an element or part of an element.
IEditManager
  
clearFormat(leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat, operationState:SelectionState = null):void
Undefines formats of the specified (or current) selection.
IEditManager
  
clearFormatOnElement(targetElement:FlowElement, format:ITextLayoutFormat, operationState:SelectionState = null):void
Undefines styles to the specified element.
IEditManager
 Inherited
Clears the selection shapes.
ISelectionManager
  
createDiv(parent:FlowGroupElement = null, format:ITextLayoutFormat = null, operationState:SelectionState = null):DivElement
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.
IEditManager
  
createList(parent:FlowGroupElement = null, format:ITextLayoutFormat = null, operationState:SelectionState = null):ListElement
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.
IEditManager
  
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.
IEditManager
  
cutTextScrap(operationState:SelectionState = null):TextScrap
Deletes the selected area and returns the deleted area in a TextScrap object.
IEditManager
 Inherited
deactivateHandler(event:Event):void
Processes a deactivate event.
IInteractionEventHandler
  
deleteNextCharacter(operationState:SelectionState = null):void
Deletes a range of text, or, if a point selection is given, deletes the next character.
IEditManager
  
deleteNextWord(operationState:SelectionState = null):void
Deletes the next word.
IEditManager
  
deletePreviousCharacter(operationState:SelectionState = null):void
Deletes a range of text, or, if a point selection is given, deletes the previous character.
IEditManager
  
deletePreviousWord(operationState:SelectionState = null):void
Deletes the previous word.
IEditManager
  
deleteText(operationState:SelectionState = null):void
Deletes a range of text.
IEditManager
 Inherited
deselect():void
Removes any selection from the text flow
ISelectionManager
  
doOperation(operation:FlowOperation):void
Executes a FlowOperation.
IEditManager
 Inherited
editHandler(event:Event):void
Processes an edit event.
IInteractionEventHandler
  
Ends a group of operations.
IEditManager
 Inherited
Executes any pending FlowOperations.
ISelectionManager
 Inherited
focusChangeHandler(event:FocusEvent):void
Processes a focusChange event.
IInteractionEventHandler
 Inherited
focusInHandler(event:FocusEvent):void
Processes a focusIn event.
IInteractionEventHandler
 Inherited
focusOutHandler(event:FocusEvent):void
Processes a focusOut event.
IInteractionEventHandler
 Inherited
ISelectionManager
 Inherited
Gets the character format attributes that are common to all characters in the specified text range or current selection.
ISelectionManager
 Inherited
Gets the container format attributes that are common to all containers in the specified text range or current selection.
ISelectionManager
 Inherited
Gets the paragraph format attributes that are common to all paragraphs in the specified text range or current selection.
ISelectionManager
 Inherited
Gets the SelectionState object of the current selection.
ISelectionManager
 Inherited
hasAnySelection():Boolean
Indicates whether there is a text or cell selection.
ISelectionManager
 Inherited
ISelectionManager
 Inherited
hasSelection():Boolean
Indicates whether there is a text selection.
ISelectionManager
 Inherited
imeStartCompositionHandler(event:IMEEvent):void
Processes an imeStartComposition event
IInteractionEventHandler
  
insertInlineGraphic(source:Object, width:Object, height:Object, options:Object = null, operationState:SelectionState = null):InlineGraphicElement
Inserts an image.
IEditManager
  
insertTableElement(table:TableElement, operationState:SelectionState = null):void
IEditManager
  
insertText(text:String, operationState:SelectionState = null):void
Inserts text.
IEditManager
 Inherited
Indicates whether the selection covers a range of text.
ISelectionManager
 Inherited
keyDownHandler(event:KeyboardEvent):void
Processes a keyDown event.
IInteractionEventHandler
 Inherited
keyFocusChangeHandler(event:FocusEvent):void
Processes a keyFocusChange event.
IInteractionEventHandler
 Inherited
keyUpHandler(event:KeyboardEvent):void
Processes a keyUp event.
IInteractionEventHandler
 Inherited
menuSelectHandler(event:ContextMenuEvent):void
Processes a menuSelect event.
IInteractionEventHandler
  
modifyInlineGraphic(source:Object, width:Object, height:Object, options:Object = null, operationState:SelectionState = null):void
Modifies an existing inline graphic.
IEditManager
 Inherited
mouseDoubleClickHandler(event:MouseEvent):void
Processes a mouseDoubleClick event.
IInteractionEventHandler
 Inherited
mouseDownHandler(event:MouseEvent):void
Processes a mouseDown event.
IInteractionEventHandler
 Inherited
mouseMoveHandler(event:MouseEvent):void
Processes a mouseMove event.
IInteractionEventHandler
 Inherited
mouseOutHandler(event:MouseEvent):void
Processes a mouseOut event.
IInteractionEventHandler
 Inherited
mouseOverHandler(event:MouseEvent):void
Processes a mouseOver event.
IInteractionEventHandler
 Inherited
mouseUpHandler(event:MouseEvent):void
Processes a mouseUp event.
IInteractionEventHandler
 Inherited
mouseWheelHandler(event:MouseEvent):void
Processes a mouseWheel event.
IInteractionEventHandler
  
moveChildren(source:FlowGroupElement, sourceIndex:int, numChildren:int, destination:FlowGroupElement, destinationIndex:int, operationState:SelectionState = null):void
Move a set of FlowElements from one FlowGroupElement to another.
IEditManager
 Inherited
notifyInsertOrDelete(absolutePosition:int, length:int):void
Updates the selection manager when text is inserted or deleted.
ISelectionManager
  
overwriteText(text:String, operationState:SelectionState = null):void
Overwrites the selected text.
IEditManager
  
pasteTextScrap(scrapToPaste:TextScrap, operationState:SelectionState = null):void
Pastes the TextScrap into the selected area.
IEditManager
  
redo():void
Reperforms the previous undone operation.
IEditManager
 Inherited
Redisplays the selection shapes.
ISelectionManager
 Inherited
selectAll():void
Selects the entire flow.
ISelectionManager
 Inherited
selectCellRange(anchorCoords:CellCoordinates, activeCoords:CellCoordinates):void
ISelectionManager
 Inherited
Selects the first position in the entire flow.
ISelectionManager
 Inherited
Selects the last position in the entire flow.
ISelectionManager
 Inherited
selectRange(anchorPosition:int, activePosition:int):void
Selects a range of text.
ISelectionManager
 Inherited
ISelectionManager
 Inherited
setFocus():void
Gives the focus to the first container in the selection.
ISelectionManager
 Inherited
Sets the SelectionState object of the current selection.
ISelectionManager
 Inherited
Processes an softKeyboardActivating event
IInteractionEventHandler
  
Splits the target element at the location specified, creating a new element after the current one.
IEditManager
  
Splits the paragraph at the current position, creating a new paragraph after the current one.
IEditManager
 Inherited
textInputHandler(event:TextEvent):void
Processes a TextEvent.
IInteractionEventHandler
  
undo():void
Reverses the previous operation.
IEditManager
  
Updates the display after an operation has modified it.
IEditManager
Property Detail
allowDelayedOperationsproperty
allowDelayedOperations:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.2, AIR 2.0

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.


Implementation
    public function get allowDelayedOperations():Boolean
    public function set allowDelayedOperations(value:Boolean):void

See also

flashx.edit.ISelectionManager.flushPendingOperations
delayUpdatesproperty 
delayUpdates:Boolean

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.2, AIR 2.0

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.


Implementation
    public function get delayUpdates():Boolean
    public function set delayUpdates(value:Boolean):void
undoManagerproperty 
undoManager:IUndoManager  [read-only]

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

The UndoManager object assigned to this EditManager instance, if there is one.

An undo manager handles undo and redo operations.


Implementation
    public function get undoManager():IUndoManager
Method Detail
applyContainerFormat()method
public function applyContainerFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Applies container styles to any containers in the selection.

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

Parameters

format:ITextLayoutFormat — The format to apply to the containers in the range
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

applyFormat()method 
public function applyFormat(leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

leafFormat:ITextLayoutFormat — The format to apply to leaf elements such as spans and inline graphics.
 
paragraphFormat:ITextLayoutFormat — The format to apply to paragraph elements.
 
containerFormat:ITextLayoutFormat — The format to apply to the containers.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

applyFormatToElement()method 
public function applyFormatToElement(targetElement:FlowElement, format:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

targetElement:FlowElement — The element to which the styles are applied.
 
format:ITextLayoutFormat — The format containing the styles to apply.
 
relativeStart:int (default = 0) — An offset from the beginning of the element at which to split the element when assigning the new formatting.
 
relativeEnd:int (default = -1) — An offset from the beginning of the element at which to split the element when applying the new formatting.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

applyLeafFormat()method 
public function applyLeafFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

format:ITextLayoutFormat — The format to apply.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

applyLink()method 
public function applyLink(href:String, target:String = null, extendToLinkBoundary:Boolean = false, operationState:SelectionState = null):LinkElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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:

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.

Parameters

href:String — The uri referenced by the link.
 
target:String (default = null) — The target browser window of the link.
 
extendToLinkBoundary:Boolean (default = false) — Specifies whether to consolidate selection with any overlapping existing links, and then apply the change.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
LinkElement — The LinkElement that was created.

See also

applyParagraphFormat()method 
public function applyParagraphFormat(format:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Applies paragraph styles to any paragraphs in the selection.

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

Parameters

format:ITextLayoutFormat — The format to apply to the selected paragraphs.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

applyTCY()method 
public function applyTCY(tcyOn:Boolean, operationState:SelectionState = null):TCYElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

tcyOn:Boolean — Set to true to apply TCY to a text range, false to remove TCY.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
TCYElement — The TCYElement that was created.

See also

beginCompositeOperation()method 
public function beginCompositeOperation():void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

See also

flashx.textLayout.edit.IEditManager.endCompositeOperation
changeElementID()method 
public function changeElementID(newID:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

newID:String — The new ID value.
 
targetElement:FlowElement — The element to modify.
 
relativeStart:int (default = 0) — An offset from the beginning of the element at which to split the element when assigning the new ID.
 
relativeEnd:int (default = -1) — An offset from the beginning of the element at which to split the element when assigning the new ID.
 
operationState:SelectionState (default = null) — Specifies the selection to restore when undoing this operation; if null, the operation saves the current selection.

changeStyleName()method 
public function changeStyleName(newName:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void
Deprecated Since 2.0: Please Use applyFormatToElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

newName:String — The name of the new style.
 
targetElement:FlowElement — Specifies the element to change.
 
relativeStart:int (default = 0) — An offset from the beginning of the element at which to split the element when assigning the new style.
 
relativeEnd:int (default = -1) — An offset from the end of the element at which to split the element when assigning the new style.
 
operationState:SelectionState (default = null) — Specifies the selection to restore when undoing this operation; if null, the operation saves the current selection.

changeTypeName()method 
public function changeTypeName(newName:String, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

newName:String — The name of the new type.
 
targetElement:FlowElement — Specifies the element to change.
 
relativeStart:int (default = 0) — An offset from the beginning of the element at which to split the element when assigning the new style
 
relativeEnd:int (default = -1) — An offset from the end of the element at which to split the element when assigning the new style
 
operationState:SelectionState (default = null) — Specifies the selection to restore when undoing this operation; if null, the operation saves the current selection.

clearFormat()method 
public function clearFormat(leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

leafFormat:ITextLayoutFormat — The format whose set values indicate properties to undefine to LeafFlowElement objects in the selected range.
 
paragraphFormat:ITextLayoutFormat — The format whose set values indicate properties to undefine to ParagraphElement objects in the selected range.
 
containerFormat:ITextLayoutFormat — The format whose set values indicate properties to undefine to ContainerController objects in the selected range.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

clearFormatOnElement()method 
public function clearFormatOnElement(targetElement:FlowElement, format:ITextLayoutFormat, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

targetElement:FlowElement — The element to which the styles are applied.
 
format:ITextLayoutFormat — The format containing the styles to undefine.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

createDiv()method 
public function createDiv(parent:FlowGroupElement = null, format:ITextLayoutFormat = null, operationState:SelectionState = null):DivElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

parent:FlowGroupElement (default = null) — Specifies a parent element for the new DivElement. If null the new parent will be lowest level that contains the SelectionState.
 
format:ITextLayoutFormat (default = null) — Formatting attributes to apply to the new DivElement.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
DivElement — The new DivElement that was created.
createList()method 
public function createList(parent:FlowGroupElement = null, format:ITextLayoutFormat = null, operationState:SelectionState = null):ListElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

parent:FlowGroupElement (default = null) — Optionally specifies a parent element for the new ListElement. If null the new parent will be lowest level that contains the SelectionState.
 
format:ITextLayoutFormat (default = null) — Formatting attributes to apply to the new ListElement.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
ListElement — The new ListElement that was created.
createSubParagraphGroup()method 
public function createSubParagraphGroup(parent:FlowGroupElement = null, format:ITextLayoutFormat = null, operationState:SelectionState = null):SubParagraphGroupElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

parent:FlowGroupElement (default = null) — Specifies a parent element for the new SubParagraphGroupElement element. If null the new parent will be lowest level that contains the SelectionState.
 
format:ITextLayoutFormat (default = null) — Formatting attributes to apply to the new SubParagraphGroupElement
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
SubParagraphGroupElement — The new SubParagraphGroupElement that was created.
cutTextScrap()method 
public function cutTextScrap(operationState:SelectionState = null):TextScrap

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
TextScrap — The TextScrap that was cut.

See also

flashx.textLayout.edit.IEditManager.pasteTextScrap
flashx.textLayout.edit.TextClipboard.setContents
deleteNextCharacter()method 
public function deleteNextCharacter(operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Deletes a range of text, or, if a point selection is given, deletes the next character.

Parameters

operationState:SelectionState (default = null) — specifies the text to which this operation applies; if null, the operation applies to the current selection.

deleteNextWord()method 
public function deleteNextWord(operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Deletes the next word.

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

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

deletePreviousCharacter()method 
public function deletePreviousCharacter(operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Deletes a range of text, or, if a point selection is given, deletes the previous character.

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

deletePreviousWord()method 
public function deletePreviousWord(operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Deletes the previous word.

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

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

deleteText()method 
public function deleteText(operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Deletes a range of text.

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

doOperation()method 
public function doOperation(operation:FlowOperation):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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:

  1. Flush any pending operations before performing this operation.
  2. Send a cancelable flowOperationBegin event. If canceled this method returns immediately.
  3. Execute the operation. The operation returns true or false. False indicates that no changes were made.
  4. Push the operation onto the undo stack.
  5. Clear the redo stack.
  6. Update the display.
  7. 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.

Parameters

operation:FlowOperation — a FlowOperation object

endCompositeOperation()method 
public function endCompositeOperation():void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

See also

flashx.textLayout.edit.IEditManager.beginCompositeOperation
insertInlineGraphic()method 
public function insertInlineGraphic(source:Object, width:Object, height:Object, options:Object = null, operationState:SelectionState = null):InlineGraphicElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

source:Object — 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:Object — The width of the image to insert (number, percent, or 'auto').
 
height:Object — The height of the image to insert (number, percent, or 'auto').
 
options:Object (default = null) — None supported.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
InlineGraphicElement

See also

insertTableElement()method 
public function insertTableElement(table:TableElement, operationState:SelectionState = null):void

Parameters

table:TableElement
 
operationState:SelectionState (default = null)

insertText()method 
public function insertText(text:String, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

text:String — The string to insert.
 
operationState:SelectionState (default = null) — Specifies the text in the flow to which this operation applies; if null, the operation applies to the current selection.

modifyInlineGraphic()method 
public function modifyInlineGraphic(source:Object, width:Object, height:Object, options:Object = null, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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

Parameters

source:Object — 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:Object — The new width for the image (number or percent).
 
height:Object — The new height for the image (number or percent).
 
options:Object (default = null) — None supported.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

See also

moveChildren()method 
public function moveChildren(source:FlowGroupElement, sourceIndex:int, numChildren:int, destination:FlowGroupElement, destinationIndex:int, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

source:FlowGroupElement — The orginal parent of the elements to be moved.
 
sourceIndex:int — The child index within the source of the first element to be moved.
 
numChildren:int — The number of children being moved.
 
destination:FlowGroupElement — The new parent of elements after move.
 
destinationIndex:int — The child index within the destination to where elements are moved to.
 
operationState:SelectionState (default = null) — 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()method 
public function overwriteText(text:String, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Overwrites the selected text.

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

Parameters

text:String — The string to insert.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

pasteTextScrap()method 
public function pasteTextScrap(scrapToPaste:TextScrap, operationState:SelectionState = null):void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

Pastes the TextScrap into the selected area.

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

Parameters

scrapToPaste:TextScrap — The TextScrap to paste.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

See also

flashx.textLayout.edit.IEditManager.cutTextScrap
flashx.textLayout.edit.TextClipboard.getContents
flashx.textLayout.edit.TextScrap
redo()method 
public function redo():void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

See also

splitElement()method 
public function splitElement(target:FlowGroupElement, operationState:SelectionState = null):FlowGroupElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

target:FlowGroupElement — The element to be split.
 
operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
FlowGroupElement — The new paragraph that was created.
splitParagraph()method 
public function splitParagraph(operationState:SelectionState = null):ParagraphElement

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

Parameters

operationState:SelectionState (default = null) — Specifies the text to which this operation applies; if null, the operation applies to the current selection.

Returns
ParagraphElement — The new paragraph that was created.
undo()method 
public function undo():void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10, AIR 1.5

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.

See also

updateAllControllers()method 
public function updateAllControllers():void

Language Version : ActionScript 3.0
Runtime Versions : Flash Player 10.2, AIR 2.0

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.