Packageflashx.textLayout.operations
Classpublic class InsertTextOperation
InheritanceInsertTextOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The InsertTextOperation class encapsulates a text insertion operation.

See also

flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent


Public Properties
 PropertyDefined By
 InheritedabsoluteEnd : int
The absolute end point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedabsoluteStart : int
The absolute start point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedbeginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
  characterFormat : ITextLayoutFormat
The character format applied to the inserted text.
InsertTextOperation
  deleteSelectionState : SelectionState
The text deleted by this operation, if any.
InsertTextOperation
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
  text : String
The text inserted by this operation.
InsertTextOperation
 InheritedtextFlow : TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
InsertTextOperation(operationState:SelectionState, text:String, deleteSelectionState:SelectionState = null)
Creates an InsertTextOperation object.
InsertTextOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
  
[override] Re-executes the operation after it has been undone.
InsertTextOperation
 Inherited
Reverses the operation.
FlowOperation
Property Detail
characterFormatproperty
characterFormat:ITextLayoutFormat

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

The character format applied to the inserted text.


Implementation
    public function get characterFormat():ITextLayoutFormat
    public function set characterFormat(value:ITextLayoutFormat):void
deleteSelectionStateproperty 
deleteSelectionState:SelectionState

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

The text deleted by this operation, if any.

null if no text is deleted.


Implementation
    public function get deleteSelectionState():SelectionState
    public function set deleteSelectionState(value:SelectionState):void
textproperty 
text:String

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

The text inserted by this operation.


Implementation
    public function get text():String
    public function set text(value:String):void
Constructor Detail
InsertTextOperation()Constructor
public function InsertTextOperation(operationState:SelectionState, text:String, deleteSelectionState:SelectionState = null)

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

Creates an InsertTextOperation object.

Parameters
operationState:SelectionState — Describes the insertion point or range of text.
 
text:String — The string to insert.
 
deleteSelectionState:SelectionState (default = null) — Describes the range of text to delete before doing insertion, if different than the range described by operationState.
Method Detail
redo()method
override public function redo():SelectionState

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

Re-executes the operation after it has been undone.

This function is called by the edit manager, when necessary.

Returns
SelectionState