BiOlapGridStateManager

A simple class that is used internally with the BiOlapGrid 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 BiOlapGridStateManager .

Constructor

new BiOlapGridStateManager ( )

Parameters

No parameters.

Properties

NameTypegetsetDescripton
activeBiOlapGridCellInfocheckedcheckedThe active cell info
dragBiOlapGridCellInfocheckedThe cell info for the cell where the user started the drag on
dragOverBiOlapGridCellInfocheckedThis is used to allow specific feedback during drag and drop. This returns the cell info for the cell that the user is dragging over
hoverBiOlapGridCellInfocheckedThe hover cell info

Methods

NameDescription
setDragSets the drag state
setDragOverSets the drag over state
setHoverSets the hover state
updateStateUpdates the internal state given the argument

Events

NameTypeBubblesDescripton
dropoverchangedBiOlapStateEventThis event is fired when the user is doing drag and drop and the cell that the user is over changes.
hoverchangedBiOlapStateEventWhen the user hovers over a different part of the OLAP grid

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

setDrag

Sets the drag state

Syntax

object.setDrag ( oCellInfo,e )

Parameters

NameTypeOptionalDefaultDescripton
oCellInfoBiOlapGridCellInfoInformation about the cell
eBiMouseEventThe mouse event causing this change

Return Type

void

setDragOver

Sets the drag over state

Syntax

object.setDragOver ( oCellInfo,e )

Parameters

NameTypeOptionalDefaultDescripton
oCellInfoBiOlapGridCellInfoInformation about the cell
eBiMouseEventThe mouse event causing this change

Return Type

void

setHover

Sets the hover state

Syntax

object.setHover ( oCellInfo,e )

Parameters

NameTypeOptionalDefaultDescripton
oCellInfoBiOlapGridCellInfoInformation about the cell
eBiMouseEventThe mouse event causing this change

Return Type

void

updateState

Updates the internal state given the argument

Syntax

object.updateState ( sType,oCellInfo,e )

Parameters

NameTypeOptionalDefaultDescripton
sTypeStringThe event type that caused this to be called
oCellInfoBiOlapGridCellInfoInformation about the cell
eBiMouseEventThe mouse event causing this change

Return Type

void