BiTreeView

This class is the base for BiGrid2 and BiTree2. It can be used directly with a data model.

This class extends BiTreeViewBase and therefore all methods and fields available for BiTreeViewBase are also available for BiTreeView .

Constructor

new BiTreeView ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
scrollLeftExact	Number			This returns the exact scroll position. scrollLeft on the other hand returns the scroll position where the first visible row starts at
scrollTopExact	Number			This returns the exact scroll position. scrollTop on the other hand returns the scroll position where the first visible row starts at
showBrokenCellTextAsToolTip	Boolean			If this is property is set to true, tooltip will show whenever a broken cell is hovered. Default value is false.

Methods

Name	Description
getCellInfo	Returns a BiTreeViewCellInfo object based on the mouse coordinates
getExpandIconHtml	this returns the HTML code for the expand icon
getHeaderHtmlCode	This returns the HTML code for header of the tree view
getHtmlCode	This returns the HTML code for the body of the tree view
getRowHeaderHtmlCode	This returns the HTML code for the row headers.
invalidateRow	Marks the row as invalid. This will try to redraw only the invalidated rows instead of redrawing the entire viewport (in some cases).
updateCell	Updates (redraws) the given cell
updateContentSize	This is called when the size of the content has changed. This happens for example when a row is added/removed and when subtrees are collapsed/expanded
updateRow	This redraws a row
updateRowHeaderCell	This updates the row header cell for the given row
updateSize	This updates the sizes of different parts of the sub controls

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

getCellInfo

Returns a BiTreeViewCellInfo object based on the mouse coordinates

Syntax

object.getCellInfo ( nOffsetX,nOffsetY )

Parameters

Name	Type	Optional	Default	Descripton
nOffsetX	Number			The left postion relative to the tree view
nOffsetY	Number			The top postion relative to the tree view

Return Type

BiTreeViewCellInfo

getExpandIconHtml

this returns the HTML code for the expand icon

Syntax

object.getExpandIconHtml ( x,y )

Parameters

Name	Type	Optional	Default	Descripton
x	Number			the column index
y	Number			the row index

Return Type

String

getHeaderHtmlCode

This returns the HTML code for header of the tree view

Syntax

object.getHeaderHtmlCode ( nScrollLeft,nWidth )

Parameters

Name	Type	Optional	Default	Descripton
nScrollLeft	Number			The distance from the left to start painting at
nWidth	Number			The width of the viewport

Return Type

String

getHtmlCode

This returns the HTML code for the body of the tree view

Syntax

object.getHtmlCode ( nScrollLeft,nScrollTop,nWidth,nHeight )

Parameters

Name	Type	Optional	Default	Descripton
nScrollLeft	Number			The distance from the left to start painting at
nScrollTop	Number			The distance from the top to start painting at
nWidth	Number			The width of the viewport
nHeight	Number			The height of the viewport

Return Type

String

getRowHeaderHtmlCode

This returns the HTML code for the row headers.

Syntax

object.getRowHeaderHtmlCode ( nScrollTop,nHeight )

Parameters

Name	Type	Optional	Default	Descripton
nScrollTop	Number			The distance from the top to start painting at
nHeight	Number			The height of the viewport

Return Type

String

invalidateRow

Marks the row as invalid. This will try to redraw only the invalidated rows instead of redrawing the entire viewport (in some cases).

Syntax

object.invalidateRow ( y )

Parameters

Name	Type	Optional	Default	Descripton
y	Number			The index of the row to invalidate

Return Type

void

updateCell

Updates (redraws) the given cell

Syntax

object.updateCell ( x,y )

Parameters

Name	Type	Optional	Default	Descripton
x	Number			The column of the cell
y	Number			The row of the cell

Return Type

void

updateContentSize

This is called when the size of the content has changed. This happens for example when a row is added/removed and when subtrees are collapsed/expanded

Syntax

object.updateContentSize ( )

Parameters

No arguments.

Return Type

void

updateRow

This redraws a row

Syntax

object.updateRow ( y )

Parameters

Name	Type	Optional	Default	Descripton
y	Number			The row index for the row to update

Return Type

void

updateRowHeaderCell

This updates the row header cell for the given row

Syntax

object.updateRowHeaderCell ( y )

Parameters

Name	Type	Optional	Default	Descripton
y	Number			The index of the row header to update

Return Type

void

updateSize

This updates the sizes of different parts of the sub controls

Syntax

object.updateSize ( )

Parameters

No arguments.

Return Type

void