Packageflashx.textLayout.operations
Classpublic class ApplyElementStyleNameOperation
InheritanceApplyElementStyleNameOperation Inheritance FlowElementOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance 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
 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
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  newStyleName : String
The style name assigned by this operation.
ApplyElementStyleNameOperation
 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 : TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
ApplyElementStyleNameOperation(operationState:SelectionState, targetElement:FlowElement, newStyleName:String, relativeStart:int = 0, relativeEnd:int = -1)
Creates a ApplyElementStyleNameOperation object.
ApplyElementStyleNameOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Reverses the operation.
FlowOperation
Property Detail
newStyleNameproperty
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.