Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
ApplyElementStyleNameOperation

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The ApplyElementStyleNameOperation class encapsulates a style name change.

See also

flashx.textLayout.elements.FlowElement.styleName
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
|  | newStyleName : String The style name assigned by this operation. | ApplyElementStyleNameOperation
|  | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ApplyElementStyleNameOperation(operationState:SelectionState, targetElement:FlowElement, newStyleName:String, relativeStart:int = 0, relativeEnd:int = -1) Creates a ApplyElementStyleNameOperation object. | ApplyElementStyleNameOperation
|  | 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

newStyleName | property

`newStyleName:String`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The style name assigned by this operation.

Implementation
`public function get newStyleName():String`
`public function set newStyleName(value:String):void`
Constructor Detail

ApplyElementStyleNameOperation | () | Constructor

`public function ApplyElementStyleNameOperation(operationState:SelectionState, targetElement:FlowElement, newStyleName:String, relativeStart:int = 0, relativeEnd:int = -1)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates a ApplyElementStyleNameOperation object.

If the `relativeStart` and `relativeEnd` parameters are set, then the existing element is split into multiple elements, the selected portion using the new style name and the rest using the existing style name.

Parameters

| `operationState:SelectionState` — Describes the current selection.
| `targetElement:FlowElement` — Specifies the element to change.
| `newStyleName:String` — The style name 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.

Wed Nov 15 2017, 09:50 AM +01:00