Package | flashx.textLayout.operations |
Class | public class ApplyElementUserStyleOperation |
Inheritance | ApplyElementUserStyleOperation FlowElementOperation FlowTextOperation FlowOperation Object |
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
See also
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 | ||
newValue : *
The new style value. | ApplyElementUserStyleOperation | ||
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 | ||
styleName : String
The name of the style changed. | ApplyElementUserStyleOperation | ||
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 |
Method | Defined By | ||
---|---|---|---|
ApplyElementUserStyleOperation(operationState:SelectionState, targetElement:FlowElement, styleName:String, value:*, relativeStart:int = 0, relativeEnd:int = -1)
Creates a ApplyElementUserStyleOperation object. | ApplyElementUserStyleOperation | ||
canUndo():Boolean
Test if this operation be placed on the undo stack. | FlowOperation | ||
doOperation():Boolean
Executes the operation. | FlowOperation | ||
[override]
Re-executes the operation. | FlowTextOperation | ||
Reverses the operation. | FlowOperation |
newValue | property |
newValue:*
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The new style value.
public function get newValue():*
public function set newValue(value:any):void
styleName | property |
styleName:String
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
The name of the style changed.
public function get styleName():String
public function set styleName(value:String):void
ApplyElementUserStyleOperation | () | Constructor |
public function ApplyElementUserStyleOperation(operationState:SelectionState, targetElement:FlowElement, styleName:String, value:*, relativeStart:int = 0, relativeEnd:int = -1)
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
Creates a ApplyElementUserStyleOperation 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 value and the rest using the existing style value.
operationState:SelectionState — Describes the range of text to style.
| |
targetElement:FlowElement — Specifies the element to change.
| |
styleName:String — The name of the style to change.
| |
value:* — The new style value.
| |
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.
|