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

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

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

The MoveChildrenOperation class allows moving a set of siblings out of its immediate parent chain, and the operation removes any empty ancestor chain left behind.

See also

flashx.textLayout.elements.FlowElement
flashx.textLayout.edit.EditManager
flashx.textLayout.events.FlowOperationEvent

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
|  | destination : FlowGroupElement Specifies the new parent of the items. | MoveChildrenOperation
|  | destinationIndex : int Specifies the new child index of the first element. | MoveChildrenOperation
|  | endGeneration : uint [read-only] The text flow generation after the operation. | FlowOperation
|  | numChildren : int Specifies the index of the first item to move. | MoveChildrenOperation
|  | originalSelectionState : SelectionState The selection state at the start of the operation. | FlowTextOperation
|  | source : FlowGroupElement Specifies the parent of the item(s) to move. | MoveChildrenOperation
|  | sourceIndex : int Specifies the number of children to move. | MoveChildrenOperation
|  | 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
--- | --- | ---
|  | MoveChildrenOperation(operationState:SelectionState, source:FlowGroupElement, sourceIndex:int, numChildren:int, destination:FlowGroupElement, destinationIndex:int) Creates a MoveChildrenOperation object. | MoveChildrenOperation
|  | 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

destination | property

`destination:FlowGroupElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the new parent of the items.

Implementation
`public function get destination():FlowGroupElement`
`public function set destination(value:FlowGroupElement):void`

destinationIndex | property |

`destinationIndex:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the new child index of the first element.

Implementation
`public function get destinationIndex():int`
`public function set destinationIndex(value:int):void`

numChildren | property |

`numChildren:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the index of the first item to move.

Implementation
`public function get numChildren():int`
`public function set numChildren(value:int):void`

source | property |

`source:FlowGroupElement`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the parent of the item(s) to move.

Implementation
`public function get source():FlowGroupElement`
`public function set source(value:FlowGroupElement):void`

sourceIndex | property |

`sourceIndex:int`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the number of children to move.

Implementation
`public function get sourceIndex():int`
`public function set sourceIndex(value:int):void`
Constructor Detail

MoveChildrenOperation | () | Constructor

`public function MoveChildrenOperation(operationState:SelectionState, source:FlowGroupElement, sourceIndex:int, numChildren:int, destination:FlowGroupElement, destinationIndex:int)`

Language Version : | ActionScript 3.0

Runtime Versions : | Flash Player 10, AIR 1.5

Creates a MoveChildrenOperation object.

This operation moves a consecutive number of children of source into the destination context. Also, if moving the children leaves the source element with no children, then source will be removed. The removal is done recursively such that if source's parent becomes empty from the removal of source, it too will be deleted, and on up the parent chain.

Parameters

| `operationState:SelectionState` — Specifies the SelectionState of this operation
| `source:FlowGroupElement` — Specifies the parent of the item(s) to move.
| `sourceIndex:int` — Specifies the index of the first item to move.
| `numChildren:int` — Specifies the number of children to move.
| `destination:FlowGroupElement` — Specifies the new parent of the items.
| `destinationIndex:int` — Specifies the new child index of the first element.

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