Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CreateSubParagraphGroupOperation

Package | flashx.textLayout.operations
Class | public class CreateSubParagraphGroupOperation
Inheritance | CreateSubParagraphGroupOperation FlowTextOperation FlowOperation Object

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The CreateSPGEOperation class encapsulates creating a SubPargraphGroupElement

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| 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
|  | format : ITextLayoutFormat Format to be applied to the new SubParagraphGroupElement | CreateSubParagraphGroupOperation
|  | newSubParagraphGroupElement : SubParagraphGroupElement [read-only] The new SubParagraphGroupElement. | CreateSubParagraphGroupOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | parent : FlowGroupElement Specifies the element this operation modifies. | CreateSubParagraphGroupOperation
|  | textFlow : TextFlow The TextFlow object to which this operation is applied. | FlowOperation
|  | userData : * Arbitrary data associated with an element. | FlowOperation

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | CreateSubParagraphGroupOperation(operationState:SelectionState, parent:FlowGroupElement = null, format:ITextLayoutFormat = null) Constructor. | CreateSubParagraphGroupOperation
|  | canUndo():Boolean Test if this operation be placed on the undo stack. | FlowOperation
|  | doOperation():Boolean Executes the operation. | FlowOperation
|  | redo():SelectionState [override] Re-executes the operation. | FlowTextOperation
|  | undo():SelectionState Reverses the operation. | FlowOperation

Property Detail

format | property

`format:ITextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Format to be applied to the new SubParagraphGroupElement

Implementation
`public function get format():ITextLayoutFormat`
`public function set format(value:ITextLayoutFormat):void`

newSubParagraphGroupElement | property |

`newSubParagraphGroupElement:SubParagraphGroupElement` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The new SubParagraphGroupElement.

Implementation
`public function get newSubParagraphGroupElement():SubParagraphGroupElement`

parent | property |

`parent:FlowGroupElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the element this operation modifies.

Implementation
`public function get parent():FlowGroupElement`
`public function set parent(value:FlowGroupElement):void`
Constructor Detail

CreateSubParagraphGroupOperation | () | Constructor

`public function CreateSubParagraphGroupOperation(operationState:SelectionState, parent:FlowGroupElement = null, format:ITextLayoutFormat = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor. This operation creates a single SubParagraphGroupElement in the first paragraph of the selection range. That paragraph must have at least one character selected the paragraph terminator does not count towards that selection. Specifying the spgeParent creates an SubParagraphGroupElement int he part of the selection range included by that spgeParent.

Parameters

| `operationState:SelectionState` — selection over which to apply the operation.
| `parent:FlowGroupElement` (default = `null`)`` — optional parent for the spge element. If not specified one is chosen based on the selection
| `format:ITextLayoutFormat` (default = `null`)`` — optional format to set in the new spge element.

Sun Mar 5 2017, 03:42 PM +11:00