BiTree2Row

This class is used as the data for rows in the BiTree2 component

This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiTree2Row .

Constructor

new BiTree2Row ( oData )

Parameters

Name	Type	Optional	Default	Descripton
oData	Object[]			Optional array of objects describing the data for the cells

Properties

Name	Type	get	set	Descripton
cells	BiGrid2Cell[]			The cells in the row
expanded	Boolean			Whether the row is expanded
parent	BiTree2Row			The parent tree row
rows	BiTree2Row[]			The rows that are children to the current row
tree	BiTree2			The BiTree2 the row is part of

Methods

Name	Description
addCell	Adds a cell to the row
addRow	Adds a row to the tree
getCell	Returns the cell for the given column
getData	Returns the data at the given column
removeAll	This removes and disposes all the rows
removeCell	Removes a cell from the row
removeRow	Removes a row item from the tree
setData	Sets the data for the cell at the given column

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

addCell

Adds a cell to the row

Syntax

object.addCell ( oChild,oBefore )

Parameters

Name	Type	Optional	Default	Descripton
oChild	BiTree2Cell			The cell to add
oBefore	BiTree2Cell			Optional cell to insert the new cell before

Return Type

void

addRow

Adds a row to the tree

Syntax

object.addRow ( oChild,oBefore )

Parameters

Name	Type	Optional	Default	Descripton
oChild	BiTree2Row			The row to add to the tree
oBefore	BiTree2Row			Optional argument telling what row to insert before

Return Type

void

getCell

Returns the cell for the given column

Syntax

object.getCell ( nCol )

Parameters

Name	Type	Optional	Default	Descripton
nCol	Number			The column index for the cell to get

Return Type

BiTree2Cell

getData

Returns the data at the given column

Syntax

object.getData ( nCol )

Parameters

Name	Type	Optional	Default	Descripton
nCol	Number			The column index for the data

Return Type

Object

removeAll

This removes and disposes all the rows

Syntax

object.removeAll ( )

Parameters

No arguments.

Return Type

void

removeCell

Removes a cell from the row

Syntax

object.removeCell ( oChild )

Parameters

Name	Type	Optional	Default	Descripton
oChild	BiTree2Cell			The cell to remove

Return Type

BiTree2Cell

removeRow

Removes a row item from the tree

Syntax

object.removeRow ( oChild )

Parameters

Name	Type	Optional	Default	Descripton
oChild	BiTree2Row			The row to remove

Return Type

void

setData

Sets the data for the cell at the given column

Syntax

object.setData ( nCol,oData )

Parameters

Name	Type	Optional	Default	Descripton
nCol	Number			The column index for the data
oData	Object			The data associated with the cell at the given column

Return Type

Object