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.DefaultSelectionModel.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

1169 lines
26 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.DefaultSelectionModel
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.grid.DefaultSelectionModel";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.grid.DefaultSelectionModel</H2>
<PRE>Object
|
+--<b>YAHOO.ext.grid.DefaultSelectionModel</b>
</PRE>
<DL>
<DT>
<B>Direct Known Subclasses:</B>
<DD>
<a href="YAHOO.ext.grid.DisableSelectionModel.html">YAHOO.ext.grid.DisableSelectionModel</a>, <a href="YAHOO.ext.grid.SingleSelectionModel.html">YAHOO.ext.grid.SingleSelectionModel</a>, <a href="YAHOO.ext.grid.EditorSelectionModel.html">YAHOO.ext.grid.EditorSelectionModel</a>
</DD>
</DL>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.grid.DefaultSelectionModel</B>
</DL>
<P>
<BR/>The default SelectionModel used by <a href="YAHOO.ext.grid.Grid.html#">YAHOO.ext.grid.Grid</a>.
It supports multiple selections and keyboard selection/navigation. <br><br>
<BR/><I>Defined in <a href='overview-summary-SelectionModel.js.html'>SelectionModel.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="#addListener">addListener</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;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#events">events</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;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#fireEvent">fireEvent</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;Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="#locked">locked</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;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onRowSelect">onRowSelect</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a row is selected or deselected - fireDirect sig: (this, row, isSelected)</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="#onSelectionChange">onSelectionChange</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when the selection changes on the Grid - fireDirect sig: (this, selectedRows[], selectedRowIds[])</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="#removeListener">removeListener</A></B></CODE>
<BR>
&nbsp;&nbsp;</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.DefaultSelectionModel.html#YAHOO.ext.grid.DefaultSelectionModel()">YAHOO.ext.grid.DefaultSelectionModel</A>
</B>
()
</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="#clearSelections">clearSelections</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Clears all selections.
</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="#deselectRange">deselectRange</A></B>(&lt;Number/HTMLElement&gt; startRow, &lt;Number/HTMLElement&gt; endRow)
</CODE>
<BR>
&nbsp;&nbsp;
Deselects a range of rows.
</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="#deselectRow">deselectRow</A></B>(&lt;Number/HTMLElement&gt; row)
</CODE>
<BR>
&nbsp;&nbsp;
Deselects a row.
</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="#focusRow">focusRow</A></B>(&lt;HTMLElement&gt; row)
</CODE>
<BR>
&nbsp;&nbsp;
Deprecated.
</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="#getCount">getCount</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Gets the number of selected rows.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Array</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSelectedRowIds">getSelectedRowIds</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the selected row ids.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;Array</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSelectedRows">getSelectedRows</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns the selected rows.
</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="#hasSelection">hasSelection</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Returns True if there is a selection.
</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="#isLocked">isLocked</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;Boolean</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#isSelectable">isSelectable</A></B>(&lt;HTMLElement&gt; row)
</CODE>
<BR>
&nbsp;&nbsp;
Returns True if the specified row is selectable.
</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="#isSelected">isSelected</A></B>(&lt;HTMLElement&gt; row)
</CODE>
<BR>
&nbsp;&nbsp;
Returns True if the specified row is selected.
</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="#lock">lock</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="#selectAll">selectAll</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Selects all rows.
</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="#selectFirstRow">selectFirstRow</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Selects the first row in the grid.
</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="#selectNext">selectNext</A></B>(&lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Selects the row immediately following the last selected row.
</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="#selectPrevious">selectPrevious</A></B>(&lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Selects the row that precedes the last selected row.
</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="#selectRange">selectRange</A></B>(&lt;Number/HTMLElement&gt; startRow, &lt;Number/HTMLElement&gt; endRow, &lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Selects a range of rows.
</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="#selectRow">selectRow</A></B>(&lt;Number/HTMLElement&gt; row, &lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Selects a row.
</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="#selectRows">selectRows</A></B>(&lt;Array&gt; rows, &lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Selects multiple rows.
</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="#selectRowsById">selectRowsById</A></B>(&lt;String/Array&gt; id, &lt;<i>Boolean</i>&gt; keepExisting)
</CODE>
<BR>
&nbsp;&nbsp;
Set the selected rows by their ID(s).
</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="#unlock">unlock</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
</TD>
</TR>
</TABLE>
<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="addListener"><!-- --></A>
<H3>addListener</H3>
<PRE>Object&nbsp;<B>addListener</B></PRE>
<UL>
</UL>
<HR>
<A NAME="events"><!-- --></A>
<H3>events</H3>
<PRE>Object&nbsp;<B>events</B></PRE>
<UL>
</UL>
<HR>
<A NAME="fireEvent"><!-- --></A>
<H3>fireEvent</H3>
<PRE>Object&nbsp;<B>fireEvent</B></PRE>
<UL>
</UL>
<HR>
<A NAME="locked"><!-- --></A>
<H3>locked</H3>
<PRE>Object&nbsp;<B>locked</B></PRE>
<UL>
</UL>
<HR>
<A NAME="onRowSelect"><!-- --></A>
<H3>onRowSelect</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onRowSelect</B></PRE>
<UL>
Fires when a row is selected or deselected - fireDirect sig: (this, row, isSelected)
</UL>
<HR>
<A NAME="onSelectionChange"><!-- --></A>
<H3>onSelectionChange</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onSelectionChange</B></PRE>
<UL>
Fires when the selection changes on the Grid - fireDirect sig: (this, selectedRows[], selectedRowIds[])
</UL>
<HR>
<A NAME="removeListener"><!-- --></A>
<H3>removeListener</H3>
<PRE>Object&nbsp;<B>removeListener</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.DefaultSelectionModel()"><!-- --></A><H3>
YAHOO.ext.grid.DefaultSelectionModel</H3>
<PRE><B>YAHOO.ext.grid.DefaultSelectionModel</B>()</PRE>
</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="clearSelections"><!-- --></A>
<H3>clearSelections</H3>
<PRE>void <B>clearSelections</B>()</PRE>
<UL>Clears all selections.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="deselectRange"><!-- --></A>
<H3>deselectRange</H3>
<PRE>void <B>deselectRange</B>(&lt;Number/HTMLElement&gt; startRow, &lt;Number/HTMLElement&gt; endRow)</PRE>
<UL>Deselects a range of rows. All rows in between startRow and endRow are also deselected.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>startRow</CODE> - The row or index of the first row in the range
</UL>
<UL><CODE>endRow</CODE> - The row or index of the last row in the range
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="deselectRow"><!-- --></A>
<H3>deselectRow</H3>
<PRE>void <B>deselectRow</B>(&lt;Number/HTMLElement&gt; row)</PRE>
<UL>Deselects a row.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>row</CODE> - The row or index of the row to deselect
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="focusRow"><!-- --></A>
<H3>focusRow</H3>
<PRE>void <B>focusRow</B>(&lt;HTMLElement&gt; row)</PRE>
<UL>Deprecated. Tries to focus the row and scroll it into view - Use grid.scrollTo or grid.getView().focusRow() instead.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>row</CODE> - The row to focus
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<UL>
<B>Deprecated</B> <I></I><BR/><BR/>
</UL>
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getCount"><!-- --></A>
<H3>getCount</H3>
<PRE>Number <B>getCount</B>()</PRE>
<UL>Gets the number of selected rows.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSelectedRowIds"><!-- --></A>
<H3>getSelectedRowIds</H3>
<PRE>Array <B>getSelectedRowIds</B>()</PRE>
<UL>Returns the selected row ids.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
Array of String ids
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSelectedRows"><!-- --></A>
<H3>getSelectedRows</H3>
<PRE>Array <B>getSelectedRows</B>()</PRE>
<UL>Returns the selected rows.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
Array of DOM row elements
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="hasSelection"><!-- --></A>
<H3>hasSelection</H3>
<PRE>Boolean <B>hasSelection</B>()</PRE>
<UL>Returns True if there is a selection.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isLocked"><!-- --></A>
<H3>isLocked</H3>
<PRE>Object <B>isLocked</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isSelectable"><!-- --></A>
<H3>isSelectable</H3>
<PRE>Boolean <B>isSelectable</B>(&lt;HTMLElement&gt; row)</PRE>
<UL>Returns True if the specified row is selectable.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>row</CODE> - The row to check
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isSelected"><!-- --></A>
<H3>isSelected</H3>
<PRE>Boolean <B>isSelected</B>(&lt;HTMLElement&gt; row)</PRE>
<UL>Returns True if the specified row is selected.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>row</CODE> - The row to check
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="lock"><!-- --></A>
<H3>lock</H3>
<PRE>void <B>lock</B>()</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectAll"><!-- --></A>
<H3>selectAll</H3>
<PRE>void <B>selectAll</B>()</PRE>
<UL>Selects all rows.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectFirstRow"><!-- --></A>
<H3>selectFirstRow</H3>
<PRE>void <B>selectFirstRow</B>()</PRE>
<UL>Selects the first row in the grid.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectNext"><!-- --></A>
<H3>selectNext</H3>
<PRE>void <B>selectNext</B>(&lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Selects the row immediately following the last selected row.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectPrevious"><!-- --></A>
<H3>selectPrevious</H3>
<PRE>void <B>selectPrevious</B>(&lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Selects the row that precedes the last selected row.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectRange"><!-- --></A>
<H3>selectRange</H3>
<PRE>void <B>selectRange</B>(&lt;Number/HTMLElement&gt; startRow, &lt;Number/HTMLElement&gt; endRow, &lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Selects a range of rows. All rows in between startRow and endRow are also selected.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>startRow</CODE> - The row or index of the first row in the range
</UL>
<UL><CODE>endRow</CODE> - The row or index of the last row in the range
</UL>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectRow"><!-- --></A>
<H3>selectRow</H3>
<PRE>void <B>selectRow</B>(&lt;Number/HTMLElement&gt; row, &lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Selects a row.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>row</CODE> - The row or index of the row to select
</UL>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectRows"><!-- --></A>
<H3>selectRows</H3>
<PRE>void <B>selectRows</B>(&lt;Array&gt; rows, &lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Selects multiple rows.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>rows</CODE> - Array of the rows or indexes of the row to select
</UL>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="selectRowsById"><!-- --></A>
<H3>selectRowsById</H3>
<PRE>void <B>selectRowsById</B>(&lt;String/Array&gt; id, &lt;<i>Boolean</i>&gt; keepExisting)</PRE>
<UL>Set the selected rows by their ID(s). IDs must match what is returned by the DataModel getRowId(index).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>id</CODE> - The id(s) to select
</UL>
<UL><CODE>keepExisting</CODE> - (optional) True to retain existing selections
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="unlock"><!-- --></A>
<H3>unlock</H3>
<PRE>void <B>unlock</B>()</PRE>
<!-- 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