Packageflashx.textLayout.operations
Classpublic class ClearFormatOperation
InheritanceClearFormatOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance Object

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

The ClearFormatOperation class encapsulates a way to undefine formats.

An UndefineFormatOperation undefines properties set in the leaf format to the text in the specified range (no change is made if the specified range is a single point). It undefines properties set in the paragraph format to any paragraphs at least partially within the range (or a single paragraph if the range is a single point). And it undefines properties set in the container format to any containers at least partially within the range (or a single container if the range is a single point).

See also

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
  containerFormat : ITextLayoutFormat
The format properties to undefine on the containers in the range.
ClearFormatOperation
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  leafFormat : ITextLayoutFormat
The format properties to undefine on the leaf elements in the range.
ClearFormatOperation
 InheritedoriginalSelectionState : SelectionState
The selection state at the start of the operation.
FlowTextOperation
  paragraphFormat : ITextLayoutFormat
The format properties to undefine on the paragraphs in the range.
ClearFormatOperation
 InheritedtextFlow : TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
ClearFormatOperation(operationState:SelectionState, leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat = null)
Creates an ClearFormatOperation object.
ClearFormatOperation
 Inherited
canUndo():Boolean
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
doOperation():Boolean
Executes the operation.
FlowOperation
  
redo():SelectionState
[override]
ClearFormatOperation
 Inherited
undo():SelectionState
Reverses the operation.
FlowOperation
Property Detail
containerFormatproperty
containerFormat:ITextLayoutFormat

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

The format properties to undefine on the containers in the range.

The formats of any containers at least partially within the range are updated. If the range of this operation is a point, then a single container is updated. If containerFormat is null, then no container formats are changed.


Implementation
    public function get containerFormat():ITextLayoutFormat
    public function set containerFormat(value:ITextLayoutFormat):void
leafFormatproperty 
leafFormat:ITextLayoutFormat

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

The format properties to undefine on the leaf elements in the range.

If the range of this operation is a point, or if leafFormat is null, then no leaf element formats are changed.


Implementation
    public function get leafFormat():ITextLayoutFormat
    public function set leafFormat(value:ITextLayoutFormat):void
paragraphFormatproperty 
paragraphFormat:ITextLayoutFormat

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

The format properties to undefine on the paragraphs in the range.

The formats of any paragraphs at least partially within the range are updated. If the range of this operation is a point, then a single paragraph is updated. If paragraphFormat is null, then no paragraph formats are changed.


Implementation
    public function get paragraphFormat():ITextLayoutFormat
    public function set paragraphFormat(value:ITextLayoutFormat):void
Constructor Detail
ClearFormatOperation()Constructor
public function ClearFormatOperation(operationState:SelectionState, leafFormat:ITextLayoutFormat, paragraphFormat:ITextLayoutFormat, containerFormat:ITextLayoutFormat = null)

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

Creates an ClearFormatOperation object.

Parameters
operationState:SelectionState — Defines the text range to which the format is applied.
 
leafFormat:ITextLayoutFormat — The format whose set values indicate properties to undefine to LeafFlowElement objects in the selected range.
 
paragraphFormat:ITextLayoutFormat — The format whose set values indicate properties to undefine to ParagraphElement objects in the selected range.
 
containerFormat:ITextLayoutFormat (default = null) — The format whose set values indicate properties to undefine to ContainerController objects in the selected range.
Method Detail
redo()method
override public function redo():SelectionState

Returns
SelectionState



The Apache Software Foundation

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