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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The CreateListOperation class encapsulates creating list

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
|  | listFormat : ITextLayoutFormat TextLayoutFormat to be applied to the new ListElement. | CreateListOperation
|  | newListElement : ListElement [read-only] The new ListElement. | CreateListOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | parent : FlowGroupElement Specifies the element this operation adds a new ListElement to. | CreateListOperation
|  | 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
--- | --- | ---
|  | CreateListOperation(operationState:SelectionState, parent:FlowGroupElement = null, listFormat:ITextLayoutFormat = null) Creates an CreateListOperation object. | CreateListOperation
|  | 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

listFormat | property

`listFormat:ITextLayoutFormat`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

TextLayoutFormat to be applied to the new ListElement.

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

newListElement | property |

`newListElement:ListElement` [read-only]

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The new ListElement.

Implementation
`public function get newListElement():ListElement`

parent | property |

`parent:FlowGroupElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the element this operation adds a new ListElement to.

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

CreateListOperation | () | Constructor

`public function CreateListOperation(operationState:SelectionState, parent:FlowGroupElement = null, listFormat:ITextLayoutFormat = null)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates an CreateListOperation object.

Parameters

| `operationState:SelectionState`
| `parent:FlowGroupElement` (default = `null`)``
| `listFormat:ITextLayoutFormat` (default = `null`)``

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