ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flashx.textLayout.operations 

MoveChildrenOperation  - AS3

Packageflashx.textLayout.operations
Classpublic class MoveChildrenOperation
InheritanceMoveChildrenOperation Inheritance FlowTextOperation Inheritance FlowOperation Inheritance 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.

Related API Elements



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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  destination : FlowGroupElement
Specifies the new parent of the items.
MoveChildrenOperation
  destinationIndex : int
Specifies the new child index of the first element.
MoveChildrenOperation
 InheritedendGeneration : uint
[read-only] The text flow generation after the operation.
FlowOperation
  numChildren : int
Specifies the index of the first item to move.
MoveChildrenOperation
 InheritedoriginalSelectionState : 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
 InheritedtextFlow : flashx.textLayout.elements:TextFlow
The TextFlow object to which this operation is applied.
FlowOperation
 InheriteduserData : *
Arbitrary data associated with an element.
FlowOperation
Public Methods
 MethodDefined By
  
MoveChildrenOperation(operationState:SelectionState, source:FlowGroupElement, sourceIndex:int, numChildren:int, destination:FlowGroupElement, destinationIndex:int)
Creates a MoveChildrenOperation object.
MoveChildrenOperation
 Inherited
Test if this operation be placed on the undo stack.
FlowOperation
 Inherited
Executes the operation.
FlowOperation
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
[override] Re-executes the operation.
FlowTextOperation
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Reverses the operation.
FlowOperation
 Inherited
Returns the primitive value of the specified object.
Object
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.