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

Package	flashx.textLayout.operations
Class	public class FlowElementOperation
Inheritance	FlowElementOperation FlowTextOperation FlowOperation Object
Subclasses	ApplyElementIDOperation, ApplyElementStyleNameOperation, ApplyElementUserStyleOperation, ApplyFormatToElementOperation, ClearFormatOnElementOperation

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The FlowElementOperation class is the base class for operations that transform a FlowElement.

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
		relativeEnd : int An offset from the start of the targetElement.	FlowElementOperation
		relativeStart : int An offset from the beginning of the targetElement.	FlowElementOperation
		targetElement : FlowElement Specifies the element this operation modifies.	FlowElementOperation
		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
		FlowElementOperation(operationState:SelectionState, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1) Creates a FlowElementOperation object.	FlowElementOperation
		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

relativeEnd

property

relativeEnd:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

An offset from the start of the targetElement.

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

relativeStart

property

relativeStart:int

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

An offset from the beginning of the targetElement.

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

targetElement

property

targetElement:FlowElement

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Specifies the element this operation modifies.

Implementation
public function get targetElement():FlowElement
public function set targetElement(value:FlowElement):void

Constructor Detail

FlowElementOperation

()

Constructor

public function FlowElementOperation(operationState:SelectionState, targetElement:FlowElement, relativeStart:int = 0, relativeEnd:int = -1)

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Creates a FlowElementOperation object.

Parameters

	`operationState:SelectionState` — Specifies the TextFlow object this operation acts upon.

	`targetElement:FlowElement` — Specifies the element this operation modifies.

	`relativeStart:int` (default = `0`) — An offset from the beginning of the `targetElement`.

	`relativeEnd:int` (default = `-1`) — An offset from the end of the `targetElement`.