Class Rico.GridCommon

Define methods that are common to both SimpleGrid and LiveGrid
Defined in: <ricoGridCommon.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	Rico.GridCommon()

Method Summary
Method Attributes	Method Name and Description
	addHeadingRow()
	attachMenu(elem)
	attachMenuEvents()
	availHt() Returns the screen height available for a grid
	baseInit()
	baseSizeDivs() Common code used to size & position divs in both SimpleGrid & LiveGrid
	blankRow(r)
	borderWidth(elem) Returns the sum of the left & right border widths of an element
	cancelMenu()
	cell(r, c) Returns a div for the cell at the specified row and column index.
	chooseColumns(e)
	clearDblClick()
	createColumnArray(columnType) create column array
	createDiv(elemName, elemParent) Create a div and give it a standardized id and class name.
	createDivs() Create div structure
	exportFinish(exportType) Support function for printVisible().
	exportStart() Support function for printVisible()
	exportStyle(elem) Support function for printVisible()
	firstVisible()
	getColumnInfo(hdrSrc) gather info from original headings
	getCookie() Gets the value of the grid cookie and interprets the contents.
	handleContextMenu(e) implement right-click for browsers that don't support contextmenu event (e.g.
	handleDblClick(e) implement double-click for browsers that don't support a double-click event (e.g.
	hideMsg()
	initFilterImage(filterRowNum)
	listInvisible()
	pluginScroll()
	printVisible(exportType) Copies all rows (SimpleGrid) or visible rows (LiveGrid) to a new window as a simple html table.
	setCookie() Sets the grid cookie.
	setFilterImage(expandFlag)
	setHorizontalScroll()
	setOtherHdrCellWidths()
	showAll() Show all columns
	showMsg(msg)
	slideFilterDown()
	slideFilterUp()
	toggleFilterRow()
	unplugScroll()

Class Detail

Rico.GridCommon()

Method Detail

addHeadingRow()

attachMenu(elem)

Parameters:
elem

attachMenuEvents()

availHt()

Returns the screen height available for a grid

baseInit()

baseSizeDivs()

Common code used to size & position divs in both SimpleGrid & LiveGrid

blankRow(r)

Parameters:
r

borderWidth(elem)

Returns the sum of the left & right border widths of an element

Parameters:
elem

cancelMenu()

cell(r, c)

Returns a div for the cell at the specified row and column index. In SimpleGrid, r can refer to any row in the grid. In LiveGrid, r refers to a visible row (row 0 is the first visible row).

Parameters:
r
c

chooseColumns(e)

Parameters:
e

clearDblClick()

createColumnArray(columnType)

create column array

Parameters:
columnType

createDiv(elemName, elemParent)

Create a div and give it a standardized id and class name. If the div already exists, then just assign the class name.

Parameters:
elemName
elemParent

createDivs()

Create div structure

exportFinish(exportType)

Support function for printVisible(). exportType is optional and defaults 'plain'; 'owc' can be used for IE users with Office Web Components.

Parameters:
exportType

exportStart()

Support function for printVisible()

exportStyle(elem)

Support function for printVisible()

Parameters:
elem

firstVisible()

Returns:: index of left-most visibile column, or -1 if there are no visible columns

getColumnInfo(hdrSrc)

gather info from original headings

Parameters:
hdrSrc

getCookie()

Gets the value of the grid cookie and interprets the contents. All information for a particular grid is stored in a single cookie. This may include column widths, column hide/show status, current sort, and any column filters.

handleContextMenu(e)

implement right-click for browsers that don't support contextmenu event (e.g. Opera, Konqueror) use control-click instead

Parameters:
e

handleDblClick(e)

implement double-click for browsers that don't support a double-click event (e.g. Safari)

Parameters:
e

hideMsg()

initFilterImage(filterRowNum)

Parameters:
filterRowNum

listInvisible()

Returns:: array of column objects which have invisible status

pluginScroll()

printVisible(exportType)

Copies all rows (SimpleGrid) or visible rows (LiveGrid) to a new window as a simple html table.

Parameters:
exportType

setCookie()

Sets the grid cookie. All information for a particular grid is stored in a single cookie. This may include column widths, column hide/show status, current sort, and any column filters.

setFilterImage(expandFlag)

Parameters:
expandFlag

setHorizontalScroll()

setOtherHdrCellWidths()

showAll()

Show all columns

showMsg(msg)

Parameters:
msg

slideFilterDown()

slideFilterUp()

toggleFilterRow()

unplugScroll()

Rico 2.1

Classes

Class Rico.GridCommon