BiAbstractGridRow

The base class for the rows and nodes in a grid or a tree.

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

Constructor

new BiAbstractGridRow ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
backColor	String			The background color name
created	Boolean			This is true when the grid row has been drawn and has a visual representation. For this to be true the tree must have been created and drawn.
foreColor	String			The foreground color name
height	Number			Returns the height of the grid row (for a tree node this does not include children).
icon	BiImage / BiUri / String			The image to use as icon on the row. The icon supports both BiImage (or other objects with getIconHtml) as well as a string/uri for backwards compat and more lightweight
selected	Boolean			Whether the grid row is selected or not.
top	Number			Returns the top position relative to the grid.

Methods

Name	Description
matchesString	Tests whether the beginning of the text of the first cell of the row starts with the given string. This match is case insensitive.
matchesStringExact	Tests whether the text of the first cell of the row matches the given string. This match is case insensitive.
scrollIntoView	Scrolls the grid component viewport so that the row becomes visible inside the viewport if possible. The argument can be used to tell what edge of the viewport the node should be aligned to. For a row only vertical scrolling is taken into account.
scrollIntoViewY	Scrolls the grid component viewport vertically so that the row becomes visible inside the viewport if possible. The argument can be used to tell what edge of the viewport the node should be aligned to.
update	Updates the row. This allows the grid to redraw only the current row of the grid. This is useful when only a few items have changed and therefore the whole data of the grid does not need to be redrawn.

Events

None.

Static Methods

None.

Static Fields

None.

Remarks

Method Details

matchesString

Tests whether the beginning of the text of the first cell of the row starts with the given string. This match is case insensitive.

Syntax

object.matchesString
 (
 sText
 [
 ,nCellIndex
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sText	String			The text to search for
nCellIndex	Number			The cell index to use instead of the first which is default.

Return Type

Boolean

matchesStringExact

Tests whether the text of the first cell of the row matches the given string. This match is case insensitive.

Syntax

object.matchesStringExact
 (
 sText
 [
 ,nCellIndex
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
sText	String			The text to search for
nCellIndex	Number			The cell index to use instead of the first which is default.

Return Type

Boolean

scrollIntoView

Scrolls the grid component viewport so that the row becomes visible inside the viewport if possible. The argument can be used to tell what edge of the viewport the node should be aligned to. For a row only vertical scrolling is taken into account.

Syntax

object.scrollIntoView
 (
 
 [
 bTopLeft
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
bTopLeft	Boolean		null	This describes the value to align the node to relative to the viewport of the grid. null - Scroll as little as possible to make the row visible in the grid viewport. true - try to align the row with the upper left edge of the grid viewport. false - try to align the row with the lower right edge of the grid viewport.

Return Type

void

scrollIntoViewY

Scrolls the grid component viewport vertically so that the row becomes visible inside the viewport if possible. The argument can be used to tell what edge of the viewport the node should be aligned to.

Syntax

object.scrollIntoViewY
 (
 
 [
 bTop
 ]
 
 )
 

Parameters

Name	Type	Optional	Default	Descripton
bTop	Boolean		null	This describes the value to align the row to relative to the viewport of the grid. null - Scroll as little as possible to make the row visible in the parent viewport. true - try to align the row with the upper edge of the grid viewport. false - try to align the row with the lower edge of the grid viewport. *

Return Type

void

update

Updates the row. This allows the grid to redraw only the current row of the grid. This is useful when only a few items have changed and therefore the whole data of the grid does not need to be redrawn.

Syntax

object.update
 (
 
 )
 

Parameters

No arguments.

Return Type

void