| 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 |
See also
| 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 | |
| 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 | |
| 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 : TextFlow
The TextFlow object to which this operation is applied. | FlowOperation | |
| userData : *
Arbitrary data associated with an element. | FlowOperation | |
| 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 | |
| [override]
Re-executes the operation. | FlowTextOperation | |
|
Reverses the operation. | FlowOperation | |
| newID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesnewID:String| Language Version : | ActionScript 3.0 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The ID assigned by this operation.
public function get newID():String public function set newID(value:String):void| 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.
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) | |
relativeEnd:int (default = -1) |