Class Rico.LiveGrid
Extends
Rico.GridCommon.
Buffered LiveGrid component
Defined in: <ricoLiveGrid.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Rico.LiveGrid(tableId, buffer, options)
|
| Field Attributes | Field Name and Description |
|---|---|
|
the buffer object containing the data for this grid
|
|
|
array of Rico.TableColumn objects
|
|
|
the options object passed to the constructor extended with defaults
|
|
|
id string for this grid
|
| Method Attributes | Method Name and Description |
|---|---|
|
adjustRow(rowOffset)
|
|
|
AdjustSelection(cell)
|
|
|
on older systems, this can be fairly slow
|
|
|
attachHighlightEvents(tBody)
|
|
|
autoAppendRows(overage)
|
|
|
autoRemoveRows(overage)
|
|
|
bookmarkHandler(firstrow, lastrow)
|
|
|
clear filters on all columns
|
|
|
clear sort flag on all columns
|
|
|
createDataCells(visibleRows)
|
|
|
Create filter elements in heading
Reads this.columns[].filterUI to determine type of filter element for each column (t=text box, s=select list, c=custom)
|
|
|
createHdr(i, start, limit)
create grid header for table i (if none was provided)
|
|
|
Create one table for frozen columns and one for scrolling columns.
|
|
|
cursorOutline(newIdx)
|
|
|
cursorSetClass(newIdx)
|
|
|
datasetIndex(cell)
|
|
|
defaultRowClass(rownum)
|
|
|
detachHighlightEvents(tBody)
|
|
|
exportBuffer(rows, startPos)
Send all rows to print/export window
|
|
|
FillSelection(newVal, newStyle)
|
|
|
returns number of columns with a user filter set
|
|
|
filterId(colnum)
|
|
|
filterValuesUpdate(colnum, request)
update select list filter with values in AJAX response
|
|
|
findColumnName(name)
|
|
|
handleScroll(e)
|
|
|
handleWheel(e)
|
|
|
highlight(newIdx)
|
|
|
highlightCell(cell)
|
|
|
insertPanelNames(r, start, limit, cellClass)
place panel names on first row of grid header (used by LiveGridForms)
|
|
|
isSelected(cell)
|
|
|
loadHdrSrc(hdrSrc)
move header cells in original table to grid
|
|
|
moveRelative(relOffset)
|
|
|
offsetFromParent(element)
|
|
|
pageDown()
|
|
|
pageUp()
|
|
|
pixeltorow(p)
|
|
|
printAll(exportType)
|
|
|
refreshContents(startPos)
|
|
|
resetContents(resetHt)
|
|
|
rowMouseOver(e)
|
|
|
rowToPixel(rowOffset)
|
|
|
scrollToRow(rowOffset)
|
|
|
scrollUp()
|
|
|
selectCell(cell)
|
|
|
Process mouse down event
|
|
|
selectRow(r)
|
|
|
setDetailFilter(colNumber, filterValue)
set filter on a detail grid that is in a master-detail relationship
|
|
|
setSortUI(columnNameOrNum, sortDirection)
Set initial sort
|
|
|
sizeDivs()
Size div elements
|
|
|
unhighlightCell(cell)
|
|
|
unselectRow(r)
|
|
|
winCellIndex(cell)
|
- Methods borrowed from class Rico.GridCommon:
- addHeadingRow, attachMenu, attachMenuEvents, availHt, baseInit, baseSizeDivs, blankRow, borderWidth, cancelMenu, cell, chooseColumns, clearDblClick, createColumnArray, createDiv, createDivs, exportFinish, exportStart, exportStyle, firstVisible, getColumnInfo, getCookie, handleContextMenu, handleDblClick, hideMsg, initFilterImage, listInvisible, printVisible, setCookie, setFilterImage, setOtherHdrCellWidths, showAll, showMsg, slideFilterDown, slideFilterUp, toggleFilterRow
Field Detail
buffer
the buffer object containing the data for this grid
columns
array of Rico.TableColumn objects
options
the options object passed to the constructor extended with defaults
tableId
id string for this grid
Method Detail
adjustPageSize()
adjustRow(rowOffset)
- Parameters:
- rowOffset
AdjustSelection(cell)
- Parameters:
- cell
appendBlankRow()
on older systems, this can be fairly slow
attachHighlightEvents(tBody)
- Parameters:
- tBody
autoAppendRows(overage)
- Parameters:
- overage
autoRemoveRows(overage)
- Parameters:
- overage
bookmarkHandler(firstrow, lastrow)
- Parameters:
- firstrow
- lastrow
checkForFilterParms()
clearBookmark()
clearFilters()
clear filters on all columns
clearRows()
ClearSelection()
clearSort()
clear sort flag on all columns
closeMenu()
createDataCells(visibleRows)
- Parameters:
- visibleRows
createFilters(r)
Create filter elements in heading
Reads this.columns[].filterUI to determine type of filter element for each column (t=text box, s=select list, c=custom)
- Parameters:
- r
- heading row where filter elements will be placed
createHdr(i, start, limit)
create grid header for table i (if none was provided)
- Parameters:
- i
- start
- limit
createHoverSet()
createTables()
Create one table for frozen columns and one for scrolling columns.
Also create div's to contain them.
- Returns:
- true on success
cursorOutline(newIdx)
- Parameters:
- newIdx
cursorSetClass(newIdx)
- Parameters:
- newIdx
datasetIndex(cell)
- Parameters:
- cell
- Returns:
- index of cell within the dataset
defaultRowClass(rownum)
- Parameters:
- rownum
detachHighlightEvents(tBody)
- Parameters:
- tBody
exportBuffer(rows, startPos)
Send all rows to print/export window
- Parameters:
- rows
- startPos
FillSelection(newVal, newStyle)
- Parameters:
- newVal
- newStyle
filterCount()
returns number of columns with a user filter set
filterHandler()
filterId(colnum)
- Parameters:
- colnum
- column number
- Returns:
- id string for a filter element
filterValuesUpdate(colnum, request)
update select list filter with values in AJAX response
- Parameters:
- colnum
- request
- Returns:
- true on success
findColumnName(name)
- Parameters:
- name
findSortedColumn()
finishResize()
getVisibleSelection()
- Returns:
- array of objects containing row/col indexes (index values are relative to the start of the window)
handleMenuClick(e)
- Parameters:
- e
handleScroll(e)
- Parameters:
- e
handleWheel(e)
- Parameters:
- e
HideSelection()
highlight(newIdx)
- Parameters:
- newIdx
highlightCell(cell)
- Parameters:
- cell
insertPanelNames(r, start, limit, cellClass)
place panel names on first row of grid header (used by LiveGridForms)
- Parameters:
- r
- start
- limit
- cellClass
isSelected(cell)
- Parameters:
- cell
loadHdrSrc(hdrSrc)
move header cells in original table to grid
- Parameters:
- hdrSrc
moveRelative(relOffset)
- Parameters:
- relOffset
offsetFromParent(element)
- Parameters:
- element
pageDown()
pageUp()
pixeltorow(p)
- Parameters:
- p
- Returns:
- row to display at top of scroll div
pluginScroll()
pluginSelect()
pluginWindowResize()
printAll(exportType)
- Parameters:
- exportType
refreshContents(startPos)
- Parameters:
- startPos
RefreshSelection()
remainingHt()
removeRow()
resetContents(resetHt)
- Parameters:
- resetHt
resizeWindow()
rowMouseOver(e)
- Parameters:
- e
rowToPixel(rowOffset)
- Parameters:
- rowOffset
scrollDown()
scrollIdle()
scrollToRow(rowOffset)
- Parameters:
- rowOffset
scrollUp()
selectCell(cell)
- Parameters:
- cell
selectMouseDown(e)
Process mouse down event
- Parameters:
- e
- event object
selectMouseOver(e)
- Parameters:
- e
selectMouseUp(e)
- Parameters:
- e
selectRow(r)
- Parameters:
- r
setDetailFilter(colNumber, filterValue)
set filter on a detail grid that is in a master-detail relationship
- Parameters:
- colNumber
- filterValue
setHorizontalScroll()
setImages()
setSortUI(columnNameOrNum, sortDirection)
Set initial sort
- Parameters:
- columnNameOrNum
- sortDirection
ShowSelection()
sizeDivs()
Size div elements
sortHandler()
topOfLastPage()
unhighlight()
unhighlightCell(cell)
- Parameters:
- cell
unplugHighlightEvents()
unplugScroll()
unplugSelect()
unplugWindowResize()
unselectRow(r)
- Parameters:
- r
updateHeightDiv()
updateSelectOutline()
winCellIndex(cell)
- Parameters:
- cell
- Returns:
- index of cell within the window