CompositionItem Class Reference

The JavaScript class for getting the composition information of a node. Obtain one from the compositionOrder global object. More...

Properties
String	node
	The name of this node ( see node interface ). More...
bool	isNodeRoot
	True when this node is a root (it has no parent). More...
bool	isNodeNormal
	True when this node is a normal node and has a parent. More...
bool	isNodeBroken
	True when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition. More...
bool	isNodeSubnodeRoot
	Parent less node that is within a child group. More...
unsigned numChildren	READ
	Number of children listed in the composition attached to node. More...
unsigned depth	READ
	Depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has. More...

Detailed Description

The JavaScript class for getting the composition information of a node. Obtain one from the compositionOrder global object.

Represent a single entry in the composition order. The composition is an array of composition items. Each item contains all the information for rebuilding the composition.

Property Documentation

isNodeBroken

bool CompositionItem::isNodeBroken

read

True when this node has a parent but the parent is not present in the composition. Some modules, such as composite module, are never listed in the composition, however, they can be the parent of some other modules that will be listed in the composition.

isNodeNormal

bool CompositionItem::isNodeNormal

read

True when this node is a normal node and has a parent.

isNodeRoot

bool CompositionItem::isNodeRoot

read

True when this node is a root (it has no parent).

isNodeSubnodeRoot

bool CompositionItem::isNodeSubnodeRoot

read

Parent less node that is within a child group.

node

String CompositionItem::node

read

The name of this node ( see node interface ).

READ [1/2]

unsigned numChildren CompositionItem::READ

Number of children listed in the composition attached to node.

READ [2/2]

unsigned depth CompositionItem::READ

Depth level of this node. Depths starts at zero for parent less node and increases for every level of parent this node has.