BiTreeViewStateManager

A simple class that is used internally with the BiTreeView to keep track of active and hover cell

This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiTreeViewStateManager .

Constructor

new BiTreeViewStateManager ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
activeX	Number			The active column
activeY	Number			The active row
dragOverX	Number			This is used to allow specific feedback during drag and drop. This is true if the dragging is over the column
dragOverY	Number			This is used to allow specific feedback during drag and drop. This is true if the dragging is over the row
dragX	Number			The column index that the user started the dragging on
dragY	Number			The row index that the user started the dragging on
hoverX	Number			The hover column
hoverY	Number			The hover row

Methods

Name	Description
getActive	Returns whether the cell at the given column is active
getDragOver	Returns whether the cell at the given column is dragged over
getHeaderActive	Returns whether the header is active
getHover	Returns whether the mouse hovers over the given cell
setActive	Sets the currently active cell
setDragOver	Sets the cell which is currently dragged over
setHover	Sets the currently hovered cell
updateState	Updates the internal state given the argument

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

Method Details

getActive

Returns whether the cell at the given column is active

Syntax

object.getActive
 (
 x,y
 )
 

Parameters

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

Return Type

Boolean

getDragOver

Returns whether the cell at the given column is dragged over

Syntax

object.getDragOver
 (
 x,y
 )
 

Parameters

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

Return Type

Boolean

getHeaderActive

Returns whether the header is active

Syntax

object.getHeaderActive
 (
 x
 )
 

Parameters

Name	Type	Optional	Default	Descripton
x	Number			The column index of the header to check

Return Type

Boolean

getHover

Returns whether the mouse hovers over the given cell

Syntax

object.getHover
 (
 x,y
 )
 

Parameters

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

Return Type

Boolean

setActive

Sets the currently active cell

Syntax

object.setActive
 (
 x,y
 )
 

Parameters

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

Return Type

void

setDragOver

Sets the cell which is currently dragged over

Syntax

object.setDragOver
 (
 x,y
 )
 

Parameters

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

Return Type

void

setHover

Sets the currently hovered cell

Syntax

object.setHover
 (
 x,y
 )
 

Parameters

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

Return Type

void

updateState

Updates the internal state given the argument

Syntax

object.updateState
 (
 sType,x,y
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sType	String			The event type that caused this to be called
x	Number			The column index
y	Number			The row index

Return Type

void