Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ApplyTCYOperation

Package | flashx.textLayout.operations
Class | public class ApplyTCYOperation
Inheritance | ApplyTCYOperation FlowTextOperation FlowOperation Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ApplyTCYOperation class encapsulates a TCY transformation.

See also

flashx.textLayout.elements.TCYElement
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
|  | endGeneration : uint [read-only] The text flow generation after the operation. | FlowOperation
|  | newTCYElement : TCYElement [read-only] The TCYElement that was created by doOperation. | ApplyTCYOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | tcyOn : Boolean Indicates whether the operation applies or removes TCY formatting. | ApplyTCYOperation
|  | textFlow : 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
--- | --- | ---
|  | ApplyTCYOperation(operationState:SelectionState, tcyOn:Boolean) Creates an ApplyTCYOperation object. | ApplyTCYOperation
|  | canUndo():Boolean Test if this operation be placed on the undo stack. | FlowOperation
|  | doOperation():Boolean Executes the operation. | FlowOperation
|  | redo():SelectionState [override] Re-executes the operation. | FlowTextOperation
|  | undo():SelectionState Reverses the operation. | FlowOperation

Property Detail

newTCYElement | property

`newTCYElement: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():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`

See also

flashx.textLayout.elements.TCYElement
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`).

Sun Mar 5 2017, 03:42 PM +11:00