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

Package	flashx.textLayout.operations
Class	public class FlowTextOperation
Inheritance	FlowTextOperation FlowOperation Object
Subclasses	ApplyFormatOperation, ApplyLinkOperation, ApplyTCYOperation, ClearFormatOperation, CopyOperation, CutOperation, DeleteTextOperation, FlowElementOperation, InsertInlineGraphicOperation, InsertTextOperation, ModifyInlineGraphicOperation, PasteOperation, SplitParagraphOperation

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The FlowTextOperation is the base class for operations that transform a range of text.

See also

flashx.textLayout.edit.EditManager

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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		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
		FlowTextOperation(operationState:SelectionState) Creates the FlowTextOperation object.	FlowTextOperation
		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.	FlowTextOperation
		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

absoluteEnd

property

absoluteEnd:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The absolute end point of the range of text to which this operation is applied.

Implementation
public function get absoluteEnd():int
public function set absoluteEnd(value:int):void

absoluteStart

property

absoluteStart:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The absolute start point of the range of text to which this operation is applied.

Implementation
public function get absoluteStart():int
public function set absoluteStart(value:int):void

originalSelectionState

property

originalSelectionState:SelectionState

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The selection state at the start of the operation.

Implementation
public function get originalSelectionState():SelectionState
public function set originalSelectionState(value:SelectionState):void

Constructor Detail

FlowTextOperation

()

Constructor

public function FlowTextOperation(operationState:SelectionState)

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Creates the FlowTextOperation object.

Parameters

operationState:SelectionState — Specifies the relevant selection. If relevant to the operation, the operationState describes the text range to which this operation applies. Otherwise, operationState is used to save the current selection state so that it can be restored when the operation is undone.

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.

This method must be overridden in derived classes. The base class method does nothing. You should not call redo() directly. The edit manager calls the method when it re-executes the operation.

Returns

SelectionState — The SelectionState object passed to the operation when it was performed. This SelectionState object can be the current selection or a selection created specifically for the operation.