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

674 lines
16 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.AbstractColumnModel
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="YAHOO.ext.grid.AbstractColumnModel";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();" style="margin:15px;">
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class YAHOO.ext.grid.AbstractColumnModel</H2>
<PRE>Object
|
+--<b>YAHOO.ext.grid.AbstractColumnModel</b>
</PRE>
<DL>
<DT>
<B>Direct Known Subclasses:</B>
<DD>
<a href="YAHOO.ext.grid.DefaultColumnModel.html">YAHOO.ext.grid.DefaultColumnModel</a>
</DD>
</DL>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>YAHOO.ext.grid.AbstractColumnModel</B>
</DL>
<P>
<BR/>This abstract class defines the ColumnModel interface and provides default implementations of the events required by the Grid.
<BR/><I>Defined in <a href='overview-summary-AbstractColumnModel.js.html'>AbstractColumnModel.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;<a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a></CODE></FONT></TD>
<TD><CODE><B><A HREF="#onHeaderChange">onHeaderChange</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a header has changed - fireDirect sig: (this, columnIndex, newHeader)</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="#onHiddenChange">onHiddenChange</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a column is hidden or unhidden - fireDirect sig: (this, columnIndex, hidden)</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="#onWidthChange">onWidthChange</A></B></CODE>
<BR>
&nbsp;&nbsp;Fires when a column width is changed - fireDirect sig: (this, columnIndex, newWidth)</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.AbstractColumnModel.html#YAHOO.ext.grid.AbstractColumnModel()">YAHOO.ext.grid.AbstractColumnModel</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="#fireHeaderChange">fireHeaderChange</A></B>(colIndex, newHeader)
</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="#fireHiddenChange">fireHiddenChange</A></B>(colIndex, hidden)
</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="#fireWidthChange">fireWidthChange</A></B>(colIndex, newWidth)
</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="#getColumnCount">getColumnCount</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the number of columns.
</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="#getColumnHeader">getColumnHeader</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the header 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="#getColumnWidth">getColumnWidth</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the width for the specified column.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getRenderer">getRenderer</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the rendering (formatting) function defined for the column.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE>&nbsp;<a href="Function.html">Function</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSortType">getSortType</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the sorting comparison function defined for the column (defaults to sortTypes.none).
</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="#getTotalWidth">getTotalWidth</A></B>()
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns the total width of all columns.
</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="#isHidden">isHidden</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns true if the specified column is hidden.
</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="#isSortable">isSortable</A></B>(&lt;Number&gt; col)
</CODE>
<BR>
&nbsp;&nbsp;
Interface method - Returns true if the specified column is sortable.
</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="onHeaderChange"><!-- --></A>
<H3>onHeaderChange</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onHeaderChange</B></PRE>
<UL>
Fires when a header has changed - fireDirect sig: (this, columnIndex, newHeader)
</UL>
<HR>
<A NAME="onHiddenChange"><!-- --></A>
<H3>onHiddenChange</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onHiddenChange</B></PRE>
<UL>
Fires when a column is hidden or unhidden - fireDirect sig: (this, columnIndex, hidden)
</UL>
<HR>
<A NAME="onWidthChange"><!-- --></A>
<H3>onWidthChange</H3>
<PRE><a href="YAHOO.util.CustomEvent.html">YAHOO.util.CustomEvent</a>&nbsp;<B>onWidthChange</B></PRE>
<UL>
Fires when a column width is changed - fireDirect sig: (this, columnIndex, newWidth)
</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.AbstractColumnModel()"><!-- --></A><H3>
YAHOO.ext.grid.AbstractColumnModel</H3>
<PRE><B>YAHOO.ext.grid.AbstractColumnModel</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="fireHeaderChange"><!-- --></A>
<H3>fireHeaderChange</H3>
<PRE>void <B>fireHeaderChange</B>(colIndex, newHeader)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="fireHiddenChange"><!-- --></A>
<H3>fireHiddenChange</H3>
<PRE>void <B>fireHiddenChange</B>(colIndex, hidden)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="fireWidthChange"><!-- --></A>
<H3>fireWidthChange</H3>
<PRE>void <B>fireWidthChange</B>(colIndex, newWidth)</PRE>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getColumnCount"><!-- --></A>
<H3>getColumnCount</H3>
<PRE>Number <B>getColumnCount</B>()</PRE>
<UL>Interface method - Returns the number of columns.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getColumnHeader"><!-- --></A>
<H3>getColumnHeader</H3>
<PRE>String <B>getColumnHeader</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns the header for the specified column.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getColumnWidth"><!-- --></A>
<H3>getColumnWidth</H3>
<PRE>Number <B>getColumnWidth</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns the width for the specified column.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getRenderer"><!-- --></A>
<H3>getRenderer</H3>
<PRE><a href="Function.html">Function</a> <B>getRenderer</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns the rendering (formatting) function defined for the column.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSortType"><!-- --></A>
<H3>getSortType</H3>
<PRE><a href="Function.html">Function</a> <B>getSortType</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns the sorting comparison function defined for the column (defaults to sortTypes.none).</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTotalWidth"><!-- --></A>
<H3>getTotalWidth</H3>
<PRE>Number <B>getTotalWidth</B>()</PRE>
<UL>Interface method - Returns the total width of all columns.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isHidden"><!-- --></A>
<H3>isHidden</H3>
<PRE>Boolean <B>isHidden</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns true if the specified column is hidden.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="isSortable"><!-- --></A>
<H3>isSortable</H3>
<PRE>Boolean <B>isSortable</B>(&lt;Number&gt; col)</PRE>
<UL>Interface method - Returns true if the specified column is sortable.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>col</CODE> - The column index
</UL>
</UL>
<!-- 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