(Beta)
| 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 |
Related API Elements
flashx.textLayout.elements.FlowElement
flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent
flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent
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 | |
| 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
| Method | Defined By | ||
|---|---|---|---|
ApplyElementIDOperation(operationState:SelectionState, targetElement:FlowElement, newID:String, relativeStart:int = 0, relativeEnd:int = -1)
Creates a ChangeElementIDOperation object. | ApplyElementIDOperation | ||
|
Test if this operation be placed on the undo stack. | FlowOperation | |
|
Executes the operation. | FlowOperation | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
| [override]
Re-executes the operation. | FlowTextOperation | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Reverses the operation. | FlowOperation | |
|
Returns the primitive value of the specified object. | Object | |
Property Detail
newID | property |
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.
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) |
Wed Nov 21 2018, 06:34 AM -08:00