Class Index | File Index

Classes

Class Rico.TableColumn


Extends Rico.TableColumnBase.

Defined in: <ricoLiveGrid.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Rico.TableColumn(liveGrid, colIdx, hdrInfo, tabIdx)
Implements a LiveGrid column.
Field Summary
Field Attributes Field Name and Description
<static>  
Rico.TableColumn.DEFAULT
<static>  
Rico.TableColumn.DOLLAR
<static>  
Rico.TableColumn.EURO
<static>  
Rico.TableColumn.MINWIDTH
<static>  
Rico.TableColumn.PERCENT
<static>  
Rico.TableColumn.QTY
<static> <constant>  
Rico.TableColumn.SORT_ASC
<static> <constant>  
Rico.TableColumn.SORT_DESC
<static> <constant>  
Rico.TableColumn.SYSTEMFILTER
<static> <constant>  
Rico.TableColumn.UNFILTERED
<static> <constant>  
Rico.TableColumn.UNSORTED
<static> <constant>  
Rico.TableColumn.USERFILTER
Method Summary
Method Attributes Method Name and Description
 
addFilterNE()
 
canFilter()
 
displayValue(windowRow)
 
filterChange(e)
 
filterClear(e, txtbox)
 
filterKeypress(e)
 
fixHeaders(prefix, iconsfirst)
 
format_date(v)
 
format_datetime(v)
 
format_number(v)
 
format_showTags(v)
 
format_text(v)
 
format_UTCasLocalTime(v)
 
getBufferAttr(windowRow)
 
getBufferCell(windowRow)
 
getFilterQueryParm()
 
getFilterText()
 
getSortDirection()
 
getValue(windowRow)
 
isFiltered()
 
isSortable()
 
isSorted()
 
setColumnSort(direction)
Sorts the column in the specified direction
 
setFilter(relop, filter, type, removeFilterFunc)
 
setFilterEQ()
 
setFilterGE()
 
setFilterKW()
 
setFilterLE()
 
setFilterNE()
 
setSorted(direction)
Flags that this column is sorted, but doesn't actually carry out the sort
 
setSystemFilter(relop, filter)
 
setUnfiltered(skipHandler)
removes the filter from this column
 
setUnsorted()
Flags that this column is not sorted
 
setUserFilter(relop)
 
setValue(windowRow, newval)
 
sortAsc()
Sorts the column in ascending order
 
sortDesc()
Sorts the column in descending order
 
toggleSort()
toggle the sort sequence for this column
Methods borrowed from class Rico.TableColumnBase:
baseInit, canHideShow, cell, chooseColumn, clearCell, clearColumn, colClassName, dataTable, getDisplayName, getFormattedValue, handleMouseDown, handleMouseMove, handleMouseOut, handleMouseUp, hideColumn, hideshow, insertResizer, numRows, pluginMouseEvents, setColWidth, setDisplay, setImage, showColumn, unplugMouseEvents
Class Detail
Rico.TableColumn(liveGrid, colIdx, hdrInfo, tabIdx)
Implements a LiveGrid column. Also contains static properties used by SimpleGrid columns.
Parameters:
liveGrid
colIdx
hdrInfo
tabIdx
Field Detail
<static> Rico.TableColumn.DEFAULT

Defined in: <ricoGridCommon.js>.
<static> Rico.TableColumn.DOLLAR

Defined in: <ricoGridCommon.js>.
<static> Rico.TableColumn.EURO

Defined in: <ricoGridCommon.js>.
<static> Rico.TableColumn.MINWIDTH

Defined in: <ricoGridCommon.js>.
<static> Rico.TableColumn.PERCENT

Defined in: <ricoGridCommon.js>.
<static> Rico.TableColumn.QTY

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.SORT_ASC

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.SORT_DESC

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.SYSTEMFILTER

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.UNFILTERED

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.UNSORTED

Defined in: <ricoGridCommon.js>.
<static> <constant> Rico.TableColumn.USERFILTER

Defined in: <ricoGridCommon.js>.
Method Detail
addFilterNE()
canFilter()
Returns:
true if this column is allowed to be filtered
displayValue(windowRow)
Parameters:
windowRow
filterChange(e)
Parameters:
e
filterClear(e, txtbox)
Parameters:
e
txtbox
filterKeypress(e)
Parameters:
e
fixHeaders(prefix, iconsfirst)
Parameters:
prefix
iconsfirst
format_date(v)
Parameters:
v
format_datetime(v)
Parameters:
v
format_number(v)
Parameters:
v
format_showTags(v)
Parameters:
v
format_text(v)
Parameters:
v
format_UTCasLocalTime(v)
Parameters:
v
getBufferAttr(windowRow)
Parameters:
windowRow
getBufferCell(windowRow)
Parameters:
windowRow
getFilterQueryParm()
Returns:
returns the query string representation of the filter
getFilterText()
Returns:
a textual representation of how this column is filtered
getSortDirection()
Returns:
Rico.TableColumn.UNSORTED, .SORT_ASC, or .SORT_DESC
getValue(windowRow)
Parameters:
windowRow
isFiltered()
isSortable()
Returns:
true if this column is allowed to be sorted
isSorted()
Returns:
true if this column is currently sorted
setColumnSort(direction)
Sorts the column in the specified direction
Parameters:
direction
must be one of Rico.TableColumn.UNSORTED, .SORT_ASC, or .SORT_DESC
setFilter(relop, filter, type, removeFilterFunc)
Parameters:
relop
filter
type
removeFilterFunc
setFilterEQ()
setFilterGE()
setFilterKW()
setFilterLE()
setFilterNE()
setSorted(direction)
Flags that this column is sorted, but doesn't actually carry out the sort
Parameters:
direction
must be one of Rico.TableColumn.UNSORTED, .SORT_ASC, or .SORT_DESC
setSystemFilter(relop, filter)
Parameters:
relop
filter
setUnfiltered(skipHandler)
removes the filter from this column
Parameters:
skipHandler
setUnsorted()
Flags that this column is not sorted
setUserFilter(relop)
Parameters:
relop
setValue(windowRow, newval)
Parameters:
windowRow
newval
sortAsc()
Sorts the column in ascending order
sortDesc()
Sorts the column in descending order
toggleSort()
toggle the sort sequence for this column
Documentation generated by JsDoc Toolkit 2.1.0 on Fri Mar 27 2009 23:48:25 GMT-0500 (CDT)