BiTreeViewBase

This is the abstract base class for BiTreeView and BiOlapGrid. It contains the shared methods and implementations of these 2 classes

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

Constructor

new BiTreeViewBase ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
attachedComponentModel	BiAttachedComponentModel			The attached component model is used to handle Bindows components inside the cells of the tree view.
attachedComponents	Object			The attached components in the tree.
dataModel	BiTreeViewDataModel/BiOlapGridDataModel			The data model describes the data to be shown in the tree view and OLAP grid
inlineEditModel	BiInlineEditModel			The inline edit model is used to handle editing of cells in the tree view.
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
selectionModel	BiTreeViewSelectionModel/BiOlapGridSelectionModel			The selection model handling the selected rows and cells
stateManager	BiTreeViewStateManager/BiOlapGridStateManager			The state manager keeps track of where the mouse is currently located inside the tree and grid.
useNativeScrollBars	Boolean			Whether to use native or custom scroll bars. Custom scroll bars are needed/preferred when the tree view/grid has an attached component model or inline edit model. If you want to change this it is better to change it before the component has been created.
viewManager	BiTreeViewViewManager/BiOlapGridViewManager			The view manager handles visual aspects that are not directly related to the data model

Methods

Name	Description
getCellInfoFromMouseEvent	This takes a mouse event object and returns a cell info describing the cell that is related to the mouse event
startEditing	This starts editing a cell in the the tree view
update	This updates the tree view or OLAP grid. This should be called when the data model or the view manager changes.
updateCell	This updates the cell. This redraws the content and updates the styles for the cell.

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

getCellInfoFromMouseEvent

This takes a mouse event object and returns a cell info describing the cell that is related to the mouse event

Syntax

object.getCellInfoFromMouseEvent ( e )

Parameters

Name	Type	Optional	Default	Descripton
e	BiMouseEvent			The event object used in the mouse event

Return Type

BiTreeViewCellInfo/BiOlapGridCellInfo

startEditing

This starts editing a cell in the the tree view

Syntax

object.startEditing ( oCell )

Parameters

Name	Type	Optional	Default	Descripton
oCell	BiTreeViewCellInfo/BiOlapGridCellInfo			The Cell to edit

Return Type

Void

update

This updates the tree view or OLAP grid. This should be called when the data model or the view manager changes.

Syntax

object.update ( )

Parameters

No arguments.

Return Type

void

updateCell

This updates the cell. This redraws the content and updates the styles for the cell.

Syntax

object.updateCell ( x,y )

Parameters

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

Return Type

void