This class extends DefaultDataModel and adds the core functionality to load data remotely.
|
addListener : Object |
AbstractDataModel |
Inherited from Observable |
|
baseParams : Object |
LoadableDataModel |
An object of key/value pairs to be passed as parameters
when loading pages/sorting |
|
delayedListener : Object |
AbstractDataModel |
Inherited from Observable |
|
fireEvent : Object |
AbstractDataModel |
Inherited from Observable |
|
loadedPage : Number |
LoadableDataModel |
The active page |
|
on : Object |
AbstractDataModel |
Inherited from Observable |
|
onCellUpdated : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when a cell is updated - fireDirect sig: (this, rowIndex, columnIndex) |
|
onLoad : YAHOO.util.CustomEvent |
LoadableDataModel |
Deprecated. Fires when a successful load is completed - fireDirect sig: (this) |
|
onLoadException : YAHOO.util.CustomEvent |
LoadableDataModel |
Deprecated. Fires when a load fails - fireDirect sig: (this, errorMsg, responseObj) |
|
onRowsDeleted : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when rows are deleted - fireDirect sig: (this, firstRowIndex, lastRowIndex) |
|
onRowsInserted : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when a rows are inserted - fireDirect sig: (this, firstRowIndex, lastRowIndex) |
|
onRowsSorted : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when a sort has reordered the rows - fireDirect sig: (this, sortColumnIndex,
sortDirection = 'ASC'... |
|
onRowsUpdated : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when a rows are updated - fireDirect sig: (this, firstRowIndex, lastRowIndex) |
|
onTableDataChanged : YAHOO.util.CustomEvent |
AbstractDataModel |
Deprecated. Fires when all data needs to be revalidated - fireDirect sig: (thisd) |
|
pageSize : Number |
LoadableDataModel |
The number of records per page |
|
pageUrl : String |
LoadableDataModel |
The script/page to call to provide paged/sorted data |
|
paramMap : Object |
LoadableDataModel |
Maps named params to url parameters - Override to specify your own param names |
|
remoteSort : Boolean |
LoadableDataModel |
True to use remote sorting, initPaging automatically sets this to true |
|
removeListener : Object |
AbstractDataModel |
Inherited from Observable |
|
LoadableDataModel(String dataType ) |
LoadableDataModel |
|
|
addPostprocessor() : void |
LoadableDataModel |
Adds a postprocessor function to format data before updating the underlying data source (ie. convert date to string b... |
|
addPreprocessor() : void |
LoadableDataModel |
Adds a preprocessor function to parse data before it is added to the Model - ie. Date.parse to parse dates. |
|
addRow(Array cellValues ) : Number |
DefaultDataModel |
Adds a row to the dataset. |
|
applySort() : void |
DefaultDataModel |
Applies the last used sort to the current data. |
|
each() : void |
DefaultDataModel |
Calls passed function with each rows data - if the function returns false it stops. |
|
filter(Object query ) : Number |
DefaultDataModel |
Filter the DataModel rows by the query defined in spec, see query for more details
on the query spec. |
|
fireCellUpdated() : void |
AbstractDataModel |
Notifies listeners that the value of the cell at [row, col] has been updated |
|
fireRowsDeleted() : void |
AbstractDataModel |
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted |
|
fireRowsInserted() : void |
AbstractDataModel |
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted |
|
fireRowsSorted() : void |
AbstractDataModel |
Notifies listeners that rows have been sorted and any indexes may be invalid |
|
fireRowsUpdated() : void |
AbstractDataModel |
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been updated |
|
fireTableDataChanged() : void |
AbstractDataModel |
Notifies listeners that all data for the grid may have changed - use as a last resort. This
also wipes out all selec... |
|
getPageSize() : void |
LoadableDataModel |
Returns the number of records per page |
|
getPostprocessor() : void |
LoadableDataModel |
Gets the postprocessor function for the specified column. |
|
getPreprocessor() : void |
LoadableDataModel |
Gets the preprocessor function for the specified column. |
|
getRow() : Array |
DefaultDataModel |
Returns the column data for the specified row. |
|
getRowCount() : void |
AbstractDataModel |
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See YAHOO.ext.DefaultDa... |
|
getRowId() : void |
AbstractDataModel |
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See YAHOO.ext.DefaultDa... |
|
getRows(Array indexes ) : Array |
DefaultDataModel |
Returns the column data for the specified rows as a
multi-dimensional array: rows[3][0] would give you the value of ... |
|
getSortState() : Object |
AbstractDataModel |
Interface method to supply the view with info regarding the Grid's current sort state - if overridden,
this should re... |
|
getTotalPages() : void |
LoadableDataModel |
Returns the total number of pages available |
|
getTotalRowCount() : void |
LoadableDataModel |
Returns the total number of records available, override if needed |
|
getValueAt() : void |
AbstractDataModel |
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See YAHOO.ext.DefaultDa... |
|
initPaging() : void |
LoadableDataModel |
Initializes paging for this model. |
|
insertRow(Number index , Array cellValues ) : Number |
DefaultDataModel |
Inserts a row a the specified location in the dataset. |
|
isPaged() : void |
LoadableDataModel |
Returns true if this model uses paging |
|
load(Object/String url , [String/Object params ], [Function callback ], [Number insertIndex ]) : void |
LoadableDataModel |
Initiates the loading of the data from the specified URL - Failed load attempts will
fire the onLoadException event. |
|
loadData() : void |
LoadableDataModel |
Empty interface method - Called to process the data returned by the XHR - Classes which extend LoadableDataModel shou... |
|
query(Object spec , Boolean returnUnmatched ) : Array |
DefaultDataModel |
Query the DataModel rows by the filters defined in spec, for example...
// column 1 starts with Jack, column 2 filte... |
|
removePostprocessor() : void |
LoadableDataModel |
Removes a postprocessor function. |
|
removePreprocessor() : void |
LoadableDataModel |
Removes a preprocessor function. |
|
removeRow(Number index ) : void |
DefaultDataModel |
Remove a row. |
|
setValueAt() : void |
AbstractDataModel |
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See YAHOO.ext.DefaultDa... |
|
sort() : void |
LoadableDataModel |
Overridden sort method to use remote sorting if turned on |
This class has no public events.
addListener
public Object addListener
Inherited from Observable
baseParams
public Object baseParams
An object of key/value pairs to be passed as parameters
when loading pages/sorting
This property is defined by LoadableDataModel.
delayedListener
public Object delayedListener
Inherited from Observable
fireEvent
public Object fireEvent
Inherited from Observable
loadedPage
public Number loadedPage
The active page
This property is defined by LoadableDataModel.
on
public Object on
Inherited from Observable
onCellUpdated
public YAHOO.util.CustomEvent onCellUpdated
Deprecated. Fires when a cell is updated - fireDirect sig: (this, rowIndex, columnIndex)
onLoad
public YAHOO.util.CustomEvent onLoad
Deprecated. Fires when a successful load is completed - fireDirect sig: (this)
This property is defined by LoadableDataModel.
onLoadException
public YAHOO.util.CustomEvent onLoadException
Deprecated. Fires when a load fails - fireDirect sig: (this, errorMsg, responseObj)
This property is defined by LoadableDataModel.
onRowsDeleted
public YAHOO.util.CustomEvent onRowsDeleted
Deprecated. Fires when rows are deleted - fireDirect sig: (this, firstRowIndex, lastRowIndex)
onRowsInserted
public YAHOO.util.CustomEvent onRowsInserted
Deprecated. Fires when a rows are inserted - fireDirect sig: (this, firstRowIndex, lastRowIndex)
onRowsSorted
public YAHOO.util.CustomEvent onRowsSorted
Deprecated. Fires when a sort has reordered the rows - fireDirect sig: (this, sortColumnIndex,
sortDirection = 'ASC' or 'DESC')
onRowsUpdated
public YAHOO.util.CustomEvent onRowsUpdated
Deprecated. Fires when a rows are updated - fireDirect sig: (this, firstRowIndex, lastRowIndex)
onTableDataChanged
public YAHOO.util.CustomEvent onTableDataChanged
Deprecated. Fires when all data needs to be revalidated - fireDirect sig: (thisd)
pageSize
public Number pageSize
The number of records per page
This property is defined by LoadableDataModel.
pageUrl
public String pageUrl
The script/page to call to provide paged/sorted data
This property is defined by LoadableDataModel.
paramMap
public Object paramMap
Maps named params to url parameters - Override to specify your own param names
This property is defined by LoadableDataModel.
remoteSort
public Boolean remoteSort
True to use remote sorting, initPaging automatically sets this to true
This property is defined by LoadableDataModel.
removeListener
public Object removeListener
Inherited from Observable
addPostprocessor
public function addPostprocessor()
Adds a postprocessor function to format data before updating the underlying data source (ie. convert date to string before updating XML document).
This method is defined by LoadableDataModel.
addPreprocessor
public function addPreprocessor()
Adds a preprocessor function to parse data before it is added to the Model - ie. Date.parse to parse dates.
This method is defined by LoadableDataModel.
addRow
public function addRow(Array cellValues
)
Adds a row to the dataset.
applySort
public function applySort()
Applies the last used sort to the current data.
each
public function each()
Calls passed function with each rows data - if the function returns false it stops.
filter
public function filter(Object query
)
Filter the DataModel rows by the query defined in spec, see
query for more details
on the query spec.
fireCellUpdated
public function fireCellUpdated()
Notifies listeners that the value of the cell at [row, col] has been updated
fireRowsDeleted
public function fireRowsDeleted()
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been deleted
fireRowsInserted
public function fireRowsInserted()
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been inserted
fireRowsSorted
public function fireRowsSorted()
Notifies listeners that rows have been sorted and any indexes may be invalid
fireRowsUpdated
public function fireRowsUpdated()
Notifies listeners that rows in the range [firstRow, lastRow], inclusive, have been updated
fireTableDataChanged
public function fireTableDataChanged()
Notifies listeners that all data for the grid may have changed - use as a last resort. This
also wipes out all selections a user might have made.
getPageSize
public function getPageSize()
Returns the number of records per page
This method is defined by LoadableDataModel.
getPostprocessor
public function getPostprocessor()
Gets the postprocessor function for the specified column.
This method is defined by LoadableDataModel.
getPreprocessor
public function getPreprocessor()
Gets the preprocessor function for the specified column.
This method is defined by LoadableDataModel.
getRow
public function getRow()
Returns the column data for the specified row.
getRowCount
public function getRowCount()
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See
YAHOO.ext.DefaultDataModel for an example implementation.
getRowId
public function getRowId()
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See
YAHOO.ext.DefaultDataModel for an example implementation.
getRows
public function getRows(Array indexes
)
Returns the column data for the specified rows as a
multi-dimensional array: rows[3][0] would give you the value of row 4, column 0.
Parameters:
indexes
: ArrayThe row indexes to fetch
Returns:
getSortState
public function getSortState()
Interface method to supply the view with info regarding the Grid's current sort state - if overridden,
this should return an object like this {column: this.sortColumn, direction: this.sortDir}.
getTotalPages
public function getTotalPages()
Returns the total number of pages available
This method is defined by LoadableDataModel.
getTotalRowCount
public function getTotalRowCount()
Returns the total number of records available, override if needed
This method is defined by LoadableDataModel.
getValueAt
public function getValueAt()
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See
YAHOO.ext.DefaultDataModel for an example implementation.
initPaging
public function initPaging()
Initializes paging for this model.
This method is defined by LoadableDataModel.
insertRow
public function insertRow(Number index
, Array cellValues
)
Inserts a row a the specified location in the dataset.
isPaged
public function isPaged()
Returns true if this model uses paging
This method is defined by LoadableDataModel.
load
public function load(Object/String url
, [String/Object params
], [Function callback
], [Number insertIndex
])
Initiates the loading of the data from the specified URL - Failed load attempts will
fire the
onLoadException event.
Parameters:
url
: Object/StringThe url from which the data can be loaded
params
: String/Object(optional) The parameters to pass as either a url encoded string "param1=1¶m2=2" or as an object {param1: 1, param2: 2}
callback
: Function(optional) Callback when load is complete - called with signature (this, rowCountLoaded)
insertIndex
: Number(optional) if present, loaded data is inserted at the specified index instead of overwriting existing data
Returns:
This method is defined by LoadableDataModel.
loadData
public function loadData()
Empty interface method - Called to process the data returned by the XHR - Classes which extend LoadableDataModel should implement this method.
See
YAHOO.ext.XMLDataModel for an example implementation.
This method is defined by LoadableDataModel.
query
public function query(Object spec
, Boolean returnUnmatched
)
Query the DataModel rows by the filters defined in spec, for example...
// column 1 starts with Jack, column 2 filtered by myFcn, column 3 equals 'Fred'
dataModel.filter({1: /^Jack.+/i}, 2: myFcn, 3: 'Fred'});
Parameters:
spec
: ObjectThe spec is generally an object literal consisting of column index and filter type. The filter type can be a string/number (exact match), a regular expression to test using String.search() or a function to call. If it's a function, it will be called with the value for the specified column and an array of the all column values for that row: yourFcn(value, columnData). If it returns anything other than true, the row is not a match. If you have modified Object.prototype this method may fail.
returnUnmatched
: BooleanTrue to return rows which don't match the query instead of rows that do match
Returns:
removePostprocessor
public function removePostprocessor()
Removes a postprocessor function.
This method is defined by LoadableDataModel.
removePreprocessor
public function removePreprocessor()
Removes a preprocessor function.
This method is defined by LoadableDataModel.
removeRow
public function removeRow(Number index
)
setValueAt
public function setValueAt()
Empty interface method - Classes which extend AbstractDataModel should implement this method.
See
YAHOO.ext.DefaultDataModel for an example implementation.
sort
public function sort()
Overridden sort method to use remote sorting if turned on
This method is defined by LoadableDataModel.