Packageflashx.textLayout.operations
Classpublic class ClearFormatOnElementOperation
InheritanceClearFormatOnElementOperation Inheritance FlowElementOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The ClearFormatOnElementOperation class encapsulates a style change to an element.

This operation undefines one or more formats to a flow element.

See also

flashx.textLayout.edit.EditManager
flashx.textLayout.formats.TextLayoutFormat
flashx.textLayout.events.FlowOperationEvent
ApplyFormatToElementOperation


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
  format : ITextLayoutFormat
The character formats applied in this operation.
ClearFormatOnElementOperation
 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
  
ClearFormatOnElementOperation(operationState:SelectionState, targetElement:FlowElement, format:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1)
Creates an ClearFormatOnElementOperation object.
ClearFormatOnElementOperation
 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
formatproperty
format:ITextLayoutFormat

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

The character formats applied in this operation.

If null no character formats are changed.


Implementation
    public function get format():ITextLayoutFormat
    public function set format(value:ITextLayoutFormat):void
Constructor Detail
ClearFormatOnElementOperation()Constructor
public function ClearFormatOnElementOperation(operationState:SelectionState, targetElement:FlowElement, format:ITextLayoutFormat, relativeStart:int = 0, relativeEnd:int = -1)

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

Creates an ClearFormatOnElementOperation object.

Parameters
operationState:SelectionState — Specifies the text flow containing the element to which this operation is applied.
 
targetElement:FlowElement — specifies the element to which this operation is applied.
 
format:ITextLayoutFormat — The formats to apply in this operation.
 
relativeStart:int (default = 0)
 
relativeEnd:int (default = -1)