ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.operations 

ApplyElementIDOperation  - AS3

Packageflashx.textLayout.operations
Classpublic class ApplyElementIDOperation
InheritanceApplyElementIDOperation Inheritance FlowElementOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: Flash Player 10, AIR 1.5

The ChangeElementIDOperation class encapsulates an element ID change.

Related API Elements

flashx.textLayout.elements.FlowElement
flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent

Public Properties
 PropertyDefined By
 InheritedabsoluteEnd : int
The absolute end point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedabsoluteStart : int
The absolute start point of the range of text to which this operation is applied.
FlowTextOperation
 InheritedbeginGeneration : uint
[read-only] The text flow generation before the operation.
FlowOperation
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  newID : String
The ID assigned by this operation.
ApplyElementIDOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
 InheritedrelativeEnd : int
An offset from the start of the targetElement.
FlowElementOperation
 InheritedrelativeStart : int
An offset from the beginning of the targetElement.
FlowElementOperation
 InheritedtargetElement : FlowElement
Specifies the element this operation modifies.
FlowElementOperation
 InheritedtextFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
ApplyElementIDOperation(operationState:SelectionState, targetElement:FlowElement, newID:String, relativeStart:int = 0, relativeEnd:int = -1)
Creates a ChangeElementIDOperation object.
ApplyElementIDOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
redo():SelectionState
[override] Re-executes the operation.
FlowTextOperation
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
undo():SelectionState
Reverses the operation.
FlowOperation
 Inherited
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.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy