Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flashx.textLayout.operations 
ApplyElementUserStyleOperation 
Packageflashx.textLayout.operations
Classpublic class ApplyElementUserStyleOperation
InheritanceApplyElementUserStyleOperation Inheritance FlowElementOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The ApplyElementUserStyleOperation class encapsulates a change in a style value of an element.

See also



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
  newValue : *
The new style value.
ApplyElementUserStyleOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrelativeEnd : int
An offset from the start of the targetElement.
FlowElementOperation
 InheritedrelativeStart : int
An offset from the beginning of the targetElement.
FlowElementOperation
  styleName : String
The name of the style changed.
ApplyElementUserStyleOperation
 InheritedtargetElement : FlowElement
Specifies the element this operation modifies.
FlowElementOperation
 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
  
ApplyElementUserStyleOperation(operationState:SelectionState, targetElement:FlowElement, styleName:String, value:*, relativeStart:int = 0, relativeEnd:int = -1)
Creates a ApplyElementUserStyleOperation object.
ApplyElementUserStyleOperation
 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

newValue

property
newValue:*

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

The new style value.



Implementation
    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.



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

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.

Parameters
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.