oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui-ext/docs/YAHOO.ext.grid.LoadableDataModel.html
JT Smith 4f68a0933c added YUI and YUI-ext 
fixed the resizable text area with IE problem
fixed the ad space with IE problem
merged the 7.2.0 and 7.1.4 change logs
2006-11-07 23:15:57 +00:00

1052 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
YAHOO.ext.grid.LoadableDataModel
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.grid.LoadableDataModel";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.grid.LoadableDataModel</H2>
<PRE>Object
|
+--<a href='YAHOO.ext.grid.AbstractDataModel.html'>YAHOO.ext.grid.AbstractDataModel</a>
|
+--<a href='YAHOO.ext.grid.DefaultDataModel.html'>YAHOO.ext.grid.DefaultDataModel</a>
|
+--<b>YAHOO.ext.grid.LoadableDataModel</b>
</PRE>
<DL>
<DT>
<B>Direct Known Subclasses:</B>
<DD>
<a href="YAHOO.ext.grid.XMLDataModel.html">YAHOO.ext.grid.XMLDataModel</a>, <a href="YAHOO.ext.grid.JSONDataModel.html">YAHOO.ext.grid.JSONDataModel</a>
</DD>
</DL>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.grid.LoadableDataModel</B>
<DT>extends <a href='YAHOO.ext.grid.DefaultDataModel.html'>YAHOO.ext.grid.DefaultDataModel</a>
</DL>
<P>
<BR/>This class extends DefaultDataModel and adds the core functionality to load data remotely. <br><br>
<BR/><I>Defined in <a href='overview-summary-LoadableDataModel.js.html'>LoadableDataModel.js</a></I><BR/><BR/>
</P>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">Field Summary</TD></TR>
<!-- This is one instance field summary -->
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#baseParams">baseParams</A></B></CODE>
<BR>
&nbsp;&nbsp;An object of key/value pairs to be passed as parameters
when loading pages/sorting</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#loadedPage">loadedPage</A></B></CODE>
<BR>
&nbsp;&nbsp;The active page</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onLoad">onLoad</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a successful load is completed - fireDirect sig: (this)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onLoadException">onLoadException</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a load fails - fireDirect sig: (this, errorMsg, responseObj)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Number</CODE></FONT></TD>
<TD><CODE><B><A HREF="#pageSize">pageSize</A></B></CODE>
<BR>
&nbsp;&nbsp;The number of records per page</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;String</CODE></FONT></TD>
<TD><CODE><B><A HREF="#pageUrl">pageUrl</A></B></CODE>
<BR>
&nbsp;&nbsp;The script/page to call to provide paged/sorted data</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#paramMap">paramMap</A></B></CODE>
<BR>
&nbsp;&nbsp;Maps named params to url parameters - Override to specify your own param names</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;Boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="#remoteSort">remoteSort</A></B></CODE>
<BR>
&nbsp;&nbsp;True to use remote sorting, initPaging automatically sets this to true</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!JSON">JSON</A></B></CODE>
<BR>
&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!TEXT">TEXT</A></B></CODE>
<BR>
&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&lt;static&gt; &nbsp;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#!s!XML">XML</A></B></CODE>
<BR>
&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
&nbsp;<A NAME=""><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD class="title-cell"><B>Fields inherited from class <A HREF="YAHOO.ext.grid.AbstractDataModel.html">YAHOO.ext.grid.AbstractDataModel</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<a href="YAHOO.ext.grid.AbstractDataModel.html#onCellUpdated">onCellUpdated</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#onTableDataChanged">onTableDataChanged</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#onRowsDeleted">onRowsDeleted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#onRowsInserted">onRowsInserted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#onRowsUpdated">onRowsUpdated</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#onRowsSorted">onRowsSorted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#events">events</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#addListener">addListener</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#removeListener">removeListener</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireEvent">fireEvent</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
Constructor Summary
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD>
<CODE>
<B>
<A HREF="YAHOO.ext.grid.LoadableDataModel.html#YAHOO.ext.grid.LoadableDataModel()">YAHOO.ext.grid.LoadableDataModel</A>
</B>
(&lt;String&gt; dataType)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="2" class="title-cell">
<span style="float:left">Method Summary</span>
<span style="float:right;font-weight:normal;font-size:8pt;">
<i>* Parameter types in italic indicate optional parameters</i>
</span>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addPostprocessor">addPostprocessor</A></B>(columnIndex, fn)
</CODE>
<BR>
&nbsp;&nbsp;
Adds a postprocessor function to format data before updating the underlying data source (ie.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#addPreprocessor">addPreprocessor</A></B>(columnIndex, fn)
</CODE>
<BR>
&nbsp;&nbsp;
Adds a preprocessor function to parse data before it is added to the Model - ie.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#fireLoadEvent">fireLoadEvent</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#fireLoadException">fireLoadException</A></B>(e, responseObj)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getPageSize">getPageSize</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the number of records per page
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getPostprocessor">getPostprocessor</A></B>(columnIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Gets the postprocessor function for the specified column.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Object</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getPreprocessor">getPreprocessor</A></B>(columnIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Gets the preprocessor function for the specified column.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTotalPages">getTotalPages</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the total number of pages available
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTotalRowCount">getTotalRowCount</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the total number of records available, override if needed
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#initPaging">initPaging</A></B>(url, pageSize, baseParams)
</CODE>
<BR>
&nbsp;&nbsp;
Initializes paging for this model.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Boolean</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isPaged">isPaged</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns true if this model uses paging
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#load">load</A></B>(&lt;Object/String&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Number</i>&gt; insertIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Initiates the loading of the data from the specified URL - Failed load attempts will
fire the <a href="#onLoadException">onLoadException</a> event.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#loadData">loadData</A></B>(data, callback, keepExisting, insertIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Empty interface method - Called to process the data returned by the XHR - Classes which extend LoadableDataModel should implement this method.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#loadPage">loadPage</A></B>(pageNum, callback, keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removePostprocessor">removePostprocessor</A></B>(columnIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Removes a postprocessor function.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removePreprocessor">removePreprocessor</A></B>(columnIndex)
</CODE>
<BR>
&nbsp;&nbsp;
Removes a preprocessor function.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#sort">sort</A></B>(columnModel, columnIndex, direction, suppressEvent)
</CODE>
<BR>
&nbsp;&nbsp;
Overridden sort method to use remote sorting if turned on
</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD class="title-cell"><B>Methods inherited from class <a href="YAHOO.ext.grid.DefaultDataModel.html">YAHOO.ext.grid.DefaultDataModel</a></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<!-- Inherited methods -->
<a href="YAHOO.ext.grid.DefaultDataModel.html#getRowCount">getRowCount</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#getRowId">getRowId</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#getRow">getRow</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#getRows">getRows</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#getValueAt">getValueAt</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#setValueAt">setValueAt</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#removeRow">removeRow</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#query">query</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#filter">filter</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#addRow">addRow</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#insertRow">insertRow</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#applySort">applySort</a>, <a href="YAHOO.ext.grid.DefaultDataModel.html#setDefaultSort">setDefaultSort</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD class="title-cell"><B>Methods inherited from class <a href="YAHOO.ext.grid.AbstractDataModel.html">YAHOO.ext.grid.AbstractDataModel</a></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>
<!-- Inherited methods -->
<a href="YAHOO.ext.grid.AbstractDataModel.html#fireCellUpdated">fireCellUpdated</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireTableDataChanged">fireTableDataChanged</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireRowsDeleted">fireRowsDeleted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireRowsInserted">fireRowsInserted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireRowsUpdated">fireRowsUpdated</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#fireRowsSorted">fireRowsSorted</a>, <a href="YAHOO.ext.grid.AbstractDataModel.html#getSortState">getSortState</a>
</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">Field Detail</TD>
</TR>
</TABLE>
<A NAME="baseParams"><!-- --></A>
<H3>baseParams</H3>
<PRE>Object&nbsp;<B>baseParams</B></PRE>
<UL>
An object of key/value pairs to be passed as parameters
when loading pages/sorting
</UL>
<HR>
<A NAME="loadedPage"><!-- --></A>
<H3>loadedPage</H3>
<PRE>Number&nbsp;<B>loadedPage</B></PRE>
<UL>
The active page
</UL>
<HR>
<A NAME="onLoad"><!-- --></A>
<H3>onLoad</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onLoad</B></PRE>
<UL>
Fires when a successful load is completed - fireDirect sig: (this)
</UL>
<HR>
<A NAME="onLoadException"><!-- --></A>
<H3>onLoadException</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onLoadException</B></PRE>
<UL>
Fires when a load fails - fireDirect sig: (this, errorMsg, responseObj)
</UL>
<HR>
<A NAME="pageSize"><!-- --></A>
<H3>pageSize</H3>
<PRE>Number&nbsp;<B>pageSize</B></PRE>
<UL>
The number of records per page
</UL>
<HR>
<A NAME="pageUrl"><!-- --></A>
<H3>pageUrl</H3>
<PRE>String&nbsp;<B>pageUrl</B></PRE>
<UL>
The script/page to call to provide paged/sorted data
</UL>
<HR>
<A NAME="paramMap"><!-- --></A>
<H3>paramMap</H3>
<PRE>Object&nbsp;<B>paramMap</B></PRE>
<UL>
Maps named params to url parameters - Override to specify your own param names
</UL>
<HR>
<A NAME="remoteSort"><!-- --></A>
<H3>remoteSort</H3>
<PRE>Boolean&nbsp;<B>remoteSort</B></PRE>
<UL>
True to use remote sorting, initPaging automatically sets this to true
</UL>
<HR>
<A NAME="!s!JSON"><!-- --></A>
<H3>JSON</H3>
<PRE>&lt;static&gt;&nbsp;Object&nbsp;<B>JSON</B></PRE>
<UL>
</UL>
<HR>
<A NAME="!s!TEXT"><!-- --></A>
<H3>TEXT</H3>
<PRE>&lt;static&gt;&nbsp;Object&nbsp;<B>TEXT</B></PRE>
<UL>
</UL>
<HR>
<A NAME="!s!XML"><!-- --></A>
<H3>XML</H3>
<PRE>&lt;static&gt;&nbsp;Object&nbsp;<B>XML</B></PRE>
<UL>
</UL>
<HR>
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Constructor Detail
</TD>
</TR>
</TABLE>
<A NAME="YAHOO.ext.grid.LoadableDataModel()"><!-- --></A><H3>
YAHOO.ext.grid.LoadableDataModel</H3>
<PRE><B>YAHOO.ext.grid.LoadableDataModel</B>(&lt;String&gt; dataType)</PRE>
<UL>
<B>Parameters:</B>
<UL><CODE>dataType</CODE> - YAHOO.ext.grid.LoadableDataModel.XML, YAHOO.ext.grid.LoadableDataModel.TEXT or YAHOO.ext.grid.JSON
</UL>
</UL>
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN="1" class="title-cell">
Method Detail
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="addPostprocessor"><!-- --></A>
<H3>addPostprocessor</H3>
<PRE>void <B>addPostprocessor</B>(columnIndex, fn)</PRE>
<UL>Adds a postprocessor function to format data before updating the underlying data source (ie. convert date to string before updating XML document).</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="addPreprocessor"><!-- --></A>
<H3>addPreprocessor</H3>
<PRE>void <B>addPreprocessor</B>(columnIndex, fn)</PRE>
<UL>Adds a preprocessor function to parse data before it is added to the Model - ie. Date.parse to parse dates.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="fireLoadEvent"><!-- --></A>
<H3>fireLoadEvent</H3>
<PRE>void <B>fireLoadEvent</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="fireLoadException"><!-- --></A>
<H3>fireLoadException</H3>
<PRE>void <B>fireLoadException</B>(e, responseObj)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getPageSize"><!-- --></A>
<H3>getPageSize</H3>
<PRE>Number <B>getPageSize</B>()</PRE>
<UL>Returns the number of records per page</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getPostprocessor"><!-- --></A>
<H3>getPostprocessor</H3>
<PRE>Object <B>getPostprocessor</B>(columnIndex)</PRE>
<UL>Gets the postprocessor function for the specified column.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getPreprocessor"><!-- --></A>
<H3>getPreprocessor</H3>
<PRE>Object <B>getPreprocessor</B>(columnIndex)</PRE>
<UL>Gets the preprocessor function for the specified column.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTotalPages"><!-- --></A>
<H3>getTotalPages</H3>
<PRE>Number <B>getTotalPages</B>()</PRE>
<UL>Returns the total number of pages available</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTotalRowCount"><!-- --></A>
<H3>getTotalRowCount</H3>
<PRE>Number <B>getTotalRowCount</B>()</PRE>
<UL>Returns the total number of records available, override if needed</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="initPaging"><!-- --></A>
<H3>initPaging</H3>
<PRE>void <B>initPaging</B>(url, pageSize, baseParams)</PRE>
<UL>Initializes paging for this model.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isPaged"><!-- --></A>
<H3>isPaged</H3>
<PRE>Boolean <B>isPaged</B>()</PRE>
<UL>Returns true if this model uses paging</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="load"><!-- --></A>
<H3>load</H3>
<PRE>void <B>load</B>(&lt;Object/String&gt; url, &lt;<i>String/Object</i>&gt; params, &lt;<i>Function</i>&gt; callback, &lt;<i>Number</i>&gt; insertIndex)</PRE>
<UL>Initiates the loading of the data from the specified URL - Failed load attempts will
fire the <a href="#onLoadException">onLoadException</a> event.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>url</CODE> - The url from which the data can be loaded
</UL>
<UL><CODE>params</CODE> - (optional) The parameters to pass as either a url encoded string "param1=1&amp;param2=2" or as an object {param1: 1, param2: 2}
</UL>
<UL><CODE>callback</CODE> - (optional) Callback when load is complete - called with signature (this, rowCountLoaded)
</UL>
<UL><CODE>insertIndex</CODE> - (optional) if present, loaded data is inserted at the specified index instead of overwriting existing data
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="loadData"><!-- --></A>
<H3>loadData</H3>
<PRE>void <B>loadData</B>(data, callback, keepExisting, insertIndex)</PRE>
<UL>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.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="loadPage"><!-- --></A>
<H3>loadPage</H3>
<PRE>void <B>loadPage</B>(pageNum, callback, keepExisting)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removePostprocessor"><!-- --></A>
<H3>removePostprocessor</H3>
<PRE>void <B>removePostprocessor</B>(columnIndex)</PRE>
<UL>Removes a postprocessor function.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removePreprocessor"><!-- --></A>
<H3>removePreprocessor</H3>
<PRE>void <B>removePreprocessor</B>(columnIndex)</PRE>
<UL>Removes a preprocessor function.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="sort"><!-- --></A>
<H3>sort</H3>
<PRE>void <B>sort</B>(columnModel, columnIndex, direction, suppressEvent)</PRE>
<UL>Overridden sort method to use remote sorting if turned on</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sat Oct 14 06:07:10 2006</div>
</BODY>
</HTML>
Reference in a new issue View git blame Copy permalink