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 

ApplyTCYOperation  - AS3

Packageflashx.textLayout.operations
Classpublic class ApplyTCYOperation
InheritanceApplyTCYOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The ApplyTCYOperation class encapsulates a TCY transformation.

Related API Elements



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
  newTCYElement : flashx.textLayout.elements:TCYElement
[read-only] The TCYElement that was created by doOperation.
ApplyTCYOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
  tcyOn : Boolean
Indicates whether the operation applies or removes TCY formatting.
ApplyTCYOperation
 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
  
Creates an ApplyTCYOperation object.
ApplyTCYOperation
 Inherited
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
Executes the operation.
FlowOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Reverses the operation.
FlowOperation
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

newTCYElement

property
newTCYElement:flashx.textLayout.elements:TCYElement  [read-only]

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

The TCYElement that was created by doOperation.



Implementation
    public function get newTCYElement():flashx.textLayout.elements:TCYElement

tcyOn

property 
tcyOn:Boolean

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

Indicates whether the operation applies or removes TCY formatting.

If true, then the operation transforms the range into a TCY element. If false, then the operation removes TCY formatting from the first TCY element in the range.



Implementation
    public function get tcyOn():Boolean
    public function set tcyOn(value:Boolean):void

Related API Elements

Constructor Detail

ApplyTCYOperation

()Constructor
public function ApplyTCYOperation(operationState:SelectionState, tcyOn:Boolean)

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

Creates an ApplyTCYOperation object.

Parameters
operationState:SelectionState — Describes the range of text to which the operation is applied.
 
tcyOn:Boolean — Specifies whether to apply TCY (true), or remove TCY (false).