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

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

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The ChangeElementIDOperation class encapsulates an element ID change.

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
		newID : String The ID assigned by this operation.	ApplyElementIDOperation
		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
		ApplyElementIDOperation(operationState:SelectionState, targetElement:FlowElement, newID:String, relativeStart:int = 0, relativeEnd:int = -1) Creates a ChangeElementIDOperation object.	ApplyElementIDOperation
		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

newID

property

newID:String

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

The ID assigned by this operation.

Implementation
public function get newID():String
public function set newID(value:String):void

Constructor Detail

ApplyElementIDOperation

()

Constructor

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

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 10, AIR 1.5

Creates a ChangeElementIDOperation object.

If the relativeStart or relativeEnd parameters are set, then the existing element is split into two elements, one using the existing ID and the other using the new ID. If both parameters are set, then the existing element is split into three elements. The first and last elements of the set are both assigned the original ID.

Parameters

	`operationState:SelectionState` — Specifies the selection state before the operation

	`targetElement:FlowElement` — Specifies the element to change

	`newID:String` — The ID to assign

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

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