flashx.textLayout.operations.InsertTextOperation - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flashx.textLayout.operations
Class	public class InsertTextOperation
Inheritance	InsertTextOperation FlowTextOperation FlowOperation Object

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The InsertTextOperation class encapsulates a text insertion operation.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		absoluteEnd : int The absolute end point of the range of text to which this operation is applied.	FlowTextOperation
		absoluteStart : int The absolute start point of the range of text to which this operation is applied.	FlowTextOperation
		beginGeneration : uint [read-only] The text flow generation before the operation.	FlowOperation
		characterFormat : flashx.textLayout.formats:ITextLayoutFormat The character format applied to the inserted text.	InsertTextOperation
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		deleteSelectionState : SelectionState The text deleted by this operation, if any.	InsertTextOperation
		endGeneration : uint [read-only] The text flow generation after the operation.	FlowOperation
		originalSelectionState : SelectionState The selection state at the start of the operation.	FlowTextOperation
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		text : String The text inserted by this operation.	InsertTextOperation
		textFlow : flashx.textLayout.elements:TextFlow The TextFlow object to which this operation is applied.	FlowOperation
		userData : * Arbitrary data associated with an element.	FlowOperation

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		InsertTextOperation(operationState:SelectionState, text:String, deleteSelectionState:SelectionState = null) Creates an InsertTextOperation object.	InsertTextOperation
		canUndo():Boolean Test if this operation be placed on the undo stack.	FlowOperation
		doOperation():Boolean Executes the operation.	FlowOperation
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		redo():SelectionState [override] Re-executes the operation after it has been undone.	InsertTextOperation
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		undo():SelectionState Reverses the operation.	FlowOperation
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

characterFormat

property

characterFormat:flashx.textLayout.formats: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():flashx.textLayout.formats:ITextLayoutFormat
public function set characterFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

deleteSelectionState

property

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

text

property

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