Class YAHOO.ext.grid.LoadableDataModel

Object
   |
   +--YAHOO.ext.grid.AbstractDataModel
         |
         +--YAHOO.ext.grid.DefaultDataModel
               |
               +--YAHOO.ext.grid.LoadableDataModel

Direct Known Subclasses:

YAHOO.ext.grid.XMLDataModel, YAHOO.ext.grid.JSONDataModel

class YAHOO.ext.grid.LoadableDataModel

extends YAHOO.ext.grid.DefaultDataModel

This class extends DefaultDataModel and adds the core functionality to load data remotely.


Defined in LoadableDataModel.js

Field Detail

baseParams

Object baseParams

An object of key/value pairs to be passed as parameters when loading pages/sorting

loadedPage

Number loadedPage

The active page

onLoad

YAHOO.util.CustomEvent onLoad

Fires when a successful load is completed - fireDirect sig: (this)

onLoadException

YAHOO.util.CustomEvent onLoadException

Fires when a load fails - fireDirect sig: (this, errorMsg, responseObj)

pageSize

Number pageSize

The number of records per page

pageUrl

String pageUrl

The script/page to call to provide paged/sorted data

paramMap

Object paramMap

Maps named params to url parameters - Override to specify your own param names

remoteSort

Boolean remoteSort

True to use remote sorting, initPaging automatically sets this to true

JSON

<static> Object JSON

TEXT

<static> Object TEXT

XML

<static> Object XML

YAHOO.ext.grid.LoadableDataModel

YAHOO.ext.grid.LoadableDataModel(<String> dataType)

Parameters:
dataType - YAHOO.ext.grid.LoadableDataModel.XML, YAHOO.ext.grid.LoadableDataModel.TEXT or YAHOO.ext.grid.JSON

addPostprocessor

void addPostprocessor(columnIndex, fn)

Adds a postprocessor function to format data before updating the underlying data source (ie. convert date to string before updating XML document).

addPreprocessor

void addPreprocessor(columnIndex, fn)

Adds a preprocessor function to parse data before it is added to the Model - ie. Date.parse to parse dates.

fireLoadEvent

void fireLoadEvent()

fireLoadException

void fireLoadException(e, responseObj)

getPageSize

Number getPageSize()

Returns the number of records per page

getPostprocessor

Object getPostprocessor(columnIndex)

Gets the postprocessor function for the specified column.

getPreprocessor

Object getPreprocessor(columnIndex)

Gets the preprocessor function for the specified column.

getTotalPages

Number getTotalPages()

Returns the total number of pages available

getTotalRowCount

Number getTotalRowCount()

Returns the total number of records available, override if needed

initPaging

void initPaging(url, pageSize, baseParams)

Initializes paging for this model.

isPaged

Boolean isPaged()

Returns true if this model uses paging

load

void 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 - The url from which the data can be loaded
params - (optional) The parameters to pass as either a url encoded string "param1=1&param2=2" or as an object {param1: 1, param2: 2}
callback - (optional) Callback when load is complete - called with signature (this, rowCountLoaded)
insertIndex - (optional) if present, loaded data is inserted at the specified index instead of overwriting existing data

loadData

void loadData(data, callback, keepExisting, insertIndex)

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.

loadPage

void loadPage(pageNum, callback, keepExisting)

removePostprocessor

void removePostprocessor(columnIndex)

Removes a postprocessor function.

removePreprocessor

void removePreprocessor(columnIndex)

Removes a preprocessor function.

sort

void sort(columnModel, columnIndex, direction, suppressEvent)

Overridden sort method to use remote sorting if turned on