Upgrade to ExtJS 3.3.1 - Released 11/30/2010

[extjs.git] / docs / output / Ext.grid.NumberColumn.html

diff --git a/docs/output/Ext.grid.NumberColumn.html b/docs/output/Ext.grid.NumberColumn.html
index 7bb7052..50cc9a9 100644 (file)
--- a/docs/output/Ext.grid.NumberColumn.html
+++ b/docs/output/Ext.grid.NumberColumn.html
@@ -1,4 +1,5 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.NumberColumn-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.grid.NumberColumn"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.grid.Column.html" ext:member="" ext:cls="Ext.grid.Column">Column</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">NumberColumn</pre></div><h1>Class <a href="source/Column.html#cls-Ext.grid.NumberColumn">Ext.grid.NumberColumn</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.NumberColumn">Column.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.NumberColumn">NumberColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column" ext:member="">Column</a></td></tr></table><div class="description"><p>A Column definition class which renders a numeric data field according to a <a href="output/Ext.grid.NumberColumn.html#Ext.grid.NumberColumn-format" ext:member="format" ext:cls="Ext.grid.NumberColumn">format</a> string.  See the
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.grid.NumberColumn-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.grid.NumberColumn-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.grid.NumberColumn"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.grid.Column.html" ext:member="" ext:cls="Ext.grid.Column">Column</a>
+  <img src="resources/elbow-end.gif">NumberColumn</pre></div><h1>Class <a href="source/Column.html#cls-Ext.grid.NumberColumn">Ext.grid.NumberColumn</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.NumberColumn">Column.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Column.html#cls-Ext.grid.NumberColumn">NumberColumn</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column" ext:member="">Column</a></td></tr></table><div class="description"><p>A Column definition class which renders a numeric data field according to a <a href="output/Ext.grid.NumberColumn.html#Ext.grid.NumberColumn-format" ext:member="format" ext:cls="Ext.grid.NumberColumn">format</a> string.  See the

 <a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a> config option of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for more details.</p></div><div class="hr"></div><a id="Ext.grid.NumberColumn-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-align"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-align">align</a></b> : String<div class="mdesc">Optional. Set the CSS text-align property of the column.  Defaults to undefined.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#align" ext:member="#align" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-css"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-css">css</a></b> : String<div class="mdesc"><div class="short">Optional. An inline style definition string which is applied to all table cells in the column
 (excluding headers). De...</div><div class="long">Optional. An inline style definition string which is applied to all table cells in the column
 (excluding headers). Defaults to undefined.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#css" ext:member="#css" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-dataIndex"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-dataIndex">dataIndex</a></b> : String<div class="mdesc"><div class="short">Required. The name of the field in the
 <a href="output/Ext.grid.Column.html#Ext.grid.Column-xtype" ext:member="xtype" ext:cls="Ext.grid.Column">xtype</a> config option of <a href="output/Ext.grid.Column.html" ext:cls="Ext.grid.Column">Ext.grid.Column</a> for more details.</p></div><div class="hr"></div><a id="Ext.grid.NumberColumn-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-align"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-align">align</a></b> : String<div class="mdesc">Optional. Set the CSS text-align property of the column.  Defaults to undefined.</div></td><td class="msource"><a href="output/Ext.grid.Column.html#align" ext:member="#align" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-css"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-css">css</a></b> : String<div class="mdesc"><div class="short">Optional. An inline style definition string which is applied to all table cells in the column
 (excluding headers). De...</div><div class="long">Optional. An inline style definition string which is applied to all table cells in the column
 (excluding headers). Defaults to undefined.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#css" ext:member="#css" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-dataIndex"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-dataIndex">dataIndex</a></b> : String<div class="mdesc"><div class="short">Required. The name of the field in the


@@ -45,7 +46,7 @@ group option in the header menu for the column. See also <code><a href="output/E
 (html tags are accepted) to display in the Grid view.  Note: to
 hav...</div><div class="long">Optional. The header text to be used as innerHTML
 (html tags are accepted) to display in the Grid view.  <b>Note</b>: to
 (html tags are accepted) to display in the Grid view.  Note: to
 hav...</div><div class="long">Optional. The header text to be used as innerHTML
 (html tags are accepted) to display in the Grid view.  <b>Note</b>: to

-have a clickable header with no text displayed use <tt>'&#160;'</tt>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#header" ext:member="#header" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-hidden"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hidden">hidden</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true to initially hide this column. Defaults to false.
+have a clickable header with no text displayed use <tt>'&amp;#160;'</tt>.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#header" ext:member="#header" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-hidden"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hidden">hidden</a></b> : Boolean<div class="mdesc"><div class="short">Optional. true to initially hide this column. Defaults to false.

 A hidden column may be shown via the header row menu...</div><div class="long">Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.
 A hidden column <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">may be shown via the header row menu</a>.
 If a column is never to be shown, simply do not include this column in the Column Model at all.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hidden" ext:member="#hidden" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-hideable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hideable">hideable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Specify as false to prevent the user from hiding this column
 A hidden column may be shown via the header row menu...</div><div class="long">Optional. <tt>true</tt> to initially hide this column. Defaults to <tt>false</tt>.
 A hidden column <a href="output/Ext.grid.GridPanel.html#Ext.grid.GridPanel-enableColumnHide" ext:member="enableColumnHide" ext:cls="Ext.grid.GridPanel">may be shown via the header row menu</a>.
 If a column is never to be shown, simply do not include this column in the Column Model at all.</div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#hidden" ext:member="#hidden" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-hideable"></a><b><a href="source/Column.html#cfg-Ext.grid.Column-hideable">hideable</a></b> : Boolean<div class="mdesc"><div class="short">Optional. Specify as false to prevent the user from hiding this column


@@ -160,4 +161,12 @@ was extracted.</p></li>
 used to edit the cell.</div><div class="long">Returns the <a href="output/Ext.Editor.html" ext:cls="Ext.Editor">editor</a> defined for this column that was created to wrap the <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Field</a>
 used to edit the cell.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Editor</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#getCellEditor" ext:member="#getCellEditor" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-setEditor"></a><b><a href="source/Column.html#method-Ext.grid.Column-setEditor">setEditor</a></b>(&nbsp;<code>Ext.Editor/Ext.form.Field&nbsp;editor</code>&nbsp;)
     :
 used to edit the cell.</div><div class="long">Returns the <a href="output/Ext.Editor.html" ext:cls="Ext.Editor">editor</a> defined for this column that was created to wrap the <a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field">Field</a>
 used to edit the cell.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>rowIndex</code> : Number<div class="sub-desc">The row index</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Editor</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#getCellEditor" ext:member="#getCellEditor" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-setEditor"></a><b><a href="source/Column.html#method-Ext.grid.Column-setEditor">setEditor</a></b>(&nbsp;<code>Ext.Editor/Ext.form.Field&nbsp;editor</code>&nbsp;)
     :

-                                        void<div class="mdesc"><div class="short">Sets a new editor for this column.</div><div class="long">Sets a new editor for this column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>editor</code> : Ext.Editor/Ext.form.Field<div class="sub-desc">The editor to set</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#setEditor" ext:member="#setEditor" ext:cls="Ext.grid.Column">Column</a></td></tr></tbody></table><a id="Ext.grid.NumberColumn-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file
+                                        void<div class="mdesc"><div class="short">Sets a new editor for this column.</div><div class="long">Sets a new editor for this column.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>editor</code> : Ext.Editor/Ext.form.Field<div class="sub-desc">The editor to set</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#setEditor" ext:member="#setEditor" ext:cls="Ext.grid.Column">Column</a></td></tr></tbody></table><a id="Ext.grid.NumberColumn-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-click"></a><b><a href="source/Column.html#event-Ext.grid.Column-click">click</a></b> :
+                                      (&nbsp;<code>Column&nbsp;this</code>,&nbsp;<code>Grid&nbsp;The</code>,&nbsp;<code>Number&nbsp;rowIndex</code>,&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
+    <div class="mdesc"><div class="short">Fires when this Column is clicked.</div><div class="long">Fires when this Column is clicked.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Column<div class="sub-desc"></div></li><li><code>The</code> : Grid<div class="sub-desc">owning GridPanel</div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#click" ext:member="#click" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-contextmenu"></a><b><a href="source/Column.html#event-Ext.grid.Column-contextmenu">contextmenu</a></b> :
+                                      (&nbsp;<code>Column&nbsp;this</code>,&nbsp;<code>Grid&nbsp;The</code>,&nbsp;<code>Number&nbsp;rowIndex</code>,&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
+    <div class="mdesc"><div class="short">Fires when this Column is right clicked.</div><div class="long">Fires when this Column is right clicked.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Column<div class="sub-desc"></div></li><li><code>The</code> : Grid<div class="sub-desc">owning GridPanel</div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#contextmenu" ext:member="#contextmenu" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-dblclick"></a><b><a href="source/Column.html#event-Ext.grid.Column-dblclick">dblclick</a></b> :
+                                      (&nbsp;<code>Column&nbsp;this</code>,&nbsp;<code>Grid&nbsp;The</code>,&nbsp;<code>Number&nbsp;rowIndex</code>,&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
+    <div class="mdesc"><div class="short">Fires when this Column is double clicked.</div><div class="long">Fires when this Column is double clicked.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Column<div class="sub-desc"></div></li><li><code>The</code> : Grid<div class="sub-desc">owning GridPanel</div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#dblclick" ext:member="#dblclick" ext:cls="Ext.grid.Column">Column</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.grid.Column-mousedown"></a><b><a href="source/Column.html#event-Ext.grid.Column-mousedown">mousedown</a></b> :
+                                      (&nbsp;<code>Column&nbsp;this</code>,&nbsp;<code>Grid&nbsp;The</code>,&nbsp;<code>Number&nbsp;rowIndex</code>,&nbsp;<code>Ext.EventObject&nbsp;e</code>&nbsp;)
+    <div class="mdesc"><div class="short">Fires when this Column receives a mousedown event.</div><div class="long">Fires when this Column receives a mousedown event.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Column<div class="sub-desc"></div></li><li><code>The</code> : Grid<div class="sub-desc">owning GridPanel</div></li><li><code>rowIndex</code> : Number<div class="sub-desc"></div></li><li><code>e</code> : Ext.EventObject<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.grid.Column.html#mousedown" ext:member="#mousedown" ext:cls="Ext.grid.Column">Column</a></td></tr></tbody></table></div>
\ No newline at end of file