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.

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.

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.

See also

Applies container styles to any containers in the selection.

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

Parameters

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

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

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

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.

Parameters

Applies paragraph styles to any paragraphs in the selection.

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

Parameters

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

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.

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

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

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

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

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

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

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

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

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

See also

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

Parameters

Deletes the next word.

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

Parameters

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

Parameters

Deletes the previous word.

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

Parameters

Deletes a range of text.

Parameters

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

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.

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

See also

Parameters

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

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

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

Overwrites the selected text.

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

Parameters

Pastes the TextScrap into the selected area.

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

Parameters

See also

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

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

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

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