oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/extjs/docs/output/ColumnModel.jss.html

449 lines
No EOL
16 KiB
HTML
Raw Blame History

<html><head><title>ColumnModel.js</title><link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/></head><body><h1>ColumnModel.js</h1><pre class="highlighted"><code><i>/**
* @class Ext.grid.ColumnModel
* @extends Ext.util.Observable
* This is the <b>default</b> implementation of a ColumnModel used by the Grid. It defines
* the columns <b>in</b> the grid.
* &lt;br&gt;Usage:&lt;br&gt;
&lt;pre&gt;&lt;code&gt;
<b>var</b> colModel = <b>new</b> Ext.grid.ColumnModel([
{header: &quot;Ticker&quot;, width: 60, sortable: true, locked: true},
{header: &quot;Company Name&quot;, width: 150, sortable: true},
{header: &quot;Market Cap.&quot;, width: 100, sortable: true},
{header: &quot;$ Sales&quot;, width: 100, sortable: true, renderer: money},
{header: &quot;Employees&quot;, width: 100, sortable: true, resizable: false}
]);
&lt;/code&gt;&lt;/pre&gt;
* &lt;p&gt;
* The config options listed <b>for</b> this class, are options which may appear <b>in</b> each
* individual column definition.
* @constructor
* @param {Object} config An Array of column config objects. See <b>this</b> class's
* config objects <b>for</b> details.
*/</i>
Ext.grid.ColumnModel = <b>function</b>(config){
Ext.grid.ColumnModel.superclass.constructor.call(<b>this</b>);
<i>/**
* The config passed into the constructor
*/</i>
<b>this</b>.config = config;
<b>this</b>.lookup = {};
<i>// <b>if</b> id, create one</i>
<i>// <b>if</b> the column does not have a dataIndex mapping,</i>
<i>// map it to the order it is <b>in</b> the config</i>
<b>for</b>(var i = 0, len = config.length; i &lt; len; i++){
<b>if</b>(typeof config[i].dataIndex == &quot;undefined&quot;){
config[i].dataIndex = i;
}
<b>if</b>(typeof config[i].renderer == &quot;string&quot;){
config[i].renderer = Ext.util.Format[config[i].renderer];
}
<b>if</b>(typeof config[i].id == &quot;undefined&quot;){
config[i].id = i;
}
<b>this</b>.lookup[config[i].id] = config[i];
}
<i>/**
* The width of columns which have no width specified (defaults to 100)
* @type Number
*/</i>
<b>this</b>.defaultWidth = 100;
<i>/**
* Default sortable of columns which have no sortable specified (defaults to false)
* @type Boolean
*/</i>
<b>this</b>.defaultSortable = false;
<b>this</b>.addEvents({
<i>/**
* @event widthchange
* Fires when the width of a column changes
* @param {ColumnModel} <b>this</b>
* @param {Number} columnIndex The column index
* @param {Number} newWidth The <b>new</b> width
*/</i>
&quot;widthchange&quot;: true,
<i>/**
* @event headerchange
* Fires when the text of a header changes
* @param {ColumnModel} <b>this</b>
* @param {Number} columnIndex The column index
* @param {Number} newText The <b>new</b> header text
*/</i>
&quot;headerchange&quot;: true,
<i>/**
* @event hiddenchange
* Fires when a column is hidden or &quot;unhidden&quot;
* @param {ColumnModel} <b>this</b>
* @param {Number} columnIndex The column index
* @param {Number} hidden true <b>if</b> hidden, false otherwise
*/</i>
&quot;hiddenchange&quot;: true,
<i>/**
* @event columnmoved
* Fires when a column is moved
* @param {ColumnModel} <b>this</b>
* @param {Number} oldIndex
* @param {Number} newIndex
*/</i>
&quot;columnmoved&quot; : true,
<i>/**
* @event columlockchange
* Fires when a column's locked state is changed
* @param {ColumnModel} <b>this</b>
* @param {Number} colIndex
* @param {Boolean} locked true <b>if</b> locked
*/</i>
&quot;columnlockchange&quot; : true
});
Ext.grid.ColumnModel.superclass.constructor.call(<b>this</b>);
};
Ext.extend(Ext.grid.ColumnModel, Ext.util.Observable, {
<i>/**
* @cfg header {String} The header text to display <b>in</b> the Grid view.
*/</i>
<i>// holder</i>
<i>/***
* @cfg dataIndex {String} The name of the field <b>in</b> the grid's {@link Ext.data.Store}'s
* {@link Ext.data.Record} definition from which to draw the column's value. If not
* specified, the column's index is used as an index into the Record's data Array.
*/</i>
<i>// holder</i>
<i>/***
* @cfg width {Number} (Optional) The initial width <b>in</b> pixels of the column. Using <b>this</b>
* instead of {@link Ext.grid.Grid#autoSizeColumns} is more efficient.
*/</i>
<i>// holder</i>
<i>/***
* @cfg sortable {Boolean} True <b>if</b> sorting is to be allowed on <b>this</b> column. Defaults to true.
* Whether local/remote sorting is used is specified <b>in</b> {@link Ext.data.Store#remoteSort}.
*/</i>
<i>// holder</i>
<i>/***
* @cfg locked {Boolean} True to lock the column <b>in</b> place <b>while</b> scrolling the Grid.
* Defaults to false.
*/</i>
<i>// holder</i>
<i>/***
* @cfg resizable {Boolean} False to disable column resizing. Defaults to true.
*/</i>
<i>// holder</i>
<i>/***
* @cfg renderer {Function} (Optional) A <b>function</b> used to generate HTML markup <b>for</b> a cell
* given the cell's data value. See {@link #setRenderer}. If not specified, the
* <b>default</b> renderer uses the raw data value.
*/</i>
<i>// holder</i>
<i>/***
* Returns the id of the column at the specified index
* @param {Number} index
* @<b>return</b> {String} the id
*/</i>
getColumnId : <b>function</b>(index){
<b>return</b> this.config[index].id;
},
getColumnById : <b>function</b>(id){
<b>return</b> this.lookup[id];
},
getIndexById : <b>function</b>(id){
<b>for</b>(var i = 0, len = <b>this</b>.config.length; i &lt; len; i++){
<b>if</b>(this.config[i].id == id){
<b>return</b> i;
}
}
<b>return</b> -1;
},
moveColumn : <b>function</b>(oldIndex, newIndex){
<b>var</b> c = <b>this</b>.config[oldIndex];
<b>this</b>.config.splice(oldIndex, 1);
<b>this</b>.config.splice(newIndex, 0, c);
<b>this</b>.dataMap = null;
<b>this</b>.fireEvent(&quot;columnmoved&quot;, <b>this</b>, oldIndex, newIndex);
},
isLocked : <b>function</b>(colIndex){
<b>return</b> this.config[colIndex].locked === true;
},
setLocked : <b>function</b>(colIndex, value, suppressEvent){
<b>if</b>(this.isLocked(colIndex) == value){
<b>return</b>;
}
<b>this</b>.config[colIndex].locked = value;
<b>if</b>(!suppressEvent){
<b>this</b>.fireEvent(&quot;columnlockchange&quot;, <b>this</b>, colIndex, value);
}
},
getTotalLockedWidth : <b>function</b>(){
<b>var</b> totalWidth = 0;
<b>for</b>(var i = 0; i &lt; <b>this</b>.config.length; i++){
<b>if</b>(this.isLocked(i) &amp;&amp; !<b>this</b>.isHidden(i)){
<b>this</b>.totalWidth += <b>this</b>.getColumnWidth(i);
}
}
<b>return</b> totalWidth;
},
getLockedCount : <b>function</b>(){
<b>for</b>(var i = 0, len = <b>this</b>.config.length; i &lt; len; i++){
<b>if</b>(!<b>this</b>.isLocked(i)){
<b>return</b> i;
}
}
},
<i>/**
* Returns the number of columns.
* @<b>return</b> {Number}
*/</i>
getColumnCount : <b>function</b>(visibleOnly){
<b>if</b>(visibleOnly == true){
<b>var</b> c = 0;
<b>for</b>(var i = 0, len = <b>this</b>.config.length; i &lt; len; i++){
<b>if</b>(!<b>this</b>.isHidden(i)){
c++;
}
}
<b>return</b> c;
}
<b>return</b> this.config.length;
},
<i>/**
* Returns true <b>if</b> the specified column is sortable.
* @param {Number} col The column index
* @<b>return</b> {Boolean}
*/</i>
isSortable : <b>function</b>(col){
<b>if</b>(typeof <b>this</b>.config[col].sortable == &quot;undefined&quot;){
<b>return</b> this.defaultSortable;
}
<b>return</b> this.config[col].sortable;
},
<i>/**
* Returns the rendering (formatting) <b>function</b> defined <b>for</b> the column.
* @param {Number} col The column index.
* @<b>return</b> {Function} The <b>function</b> used to render the cell. See {@link #setRenderer}.
*/</i>
getRenderer : <b>function</b>(col){
<b>if</b>(!<b>this</b>.config[col].renderer){
<b>return</b> Ext.grid.ColumnModel.defaultRenderer;
}
<b>return</b> this.config[col].renderer;
},
<i>/**
* Sets the rendering (formatting) <b>function</b> for a column.
* @param {Number} col The column index
* @param {Function} fn The <b>function</b> to use to process the cell's raw data
* to <b>return</b> HTML markup <b>for</b> the grid view. The render <b>function</b> is called <b>with</b>
* the following parameters:&lt;ul&gt;
* &lt;li&gt;Data value.&lt;/li&gt;
* &lt;li&gt;Cell metadata. An object <b>in</b> which you may set the following attributes:&lt;ul&gt;
* &lt;li&gt;css A CSS style string to apply to the table cell.&lt;/li&gt;
* &lt;li&gt;attr An HTML attribute definition string to apply to the data container element &lt;i&gt;within&lt;/i&gt; the table cell.&lt;/li&gt;&lt;/ul&gt;
* &lt;li&gt;The {@link Ext.data.Record} from which the data was extracted.&lt;/li&gt;
* &lt;li&gt;Row index&lt;/li&gt;
* &lt;li&gt;Column index&lt;/li&gt;
* &lt;li&gt;The {@link Ext.data.Store} object from which the Record was extracted&lt;/li&gt;&lt;/ul&gt;
*/</i>
setRenderer : <b>function</b>(col, fn){
<b>this</b>.config[col].renderer = fn;
},
<i>/**
* Returns the width <b>for</b> the specified column.
* @param {Number} col The column index
* @<b>return</b> {Number}
*/</i>
getColumnWidth : <b>function</b>(col){
<b>return</b> this.config[col].width || <b>this</b>.defaultWidth;
},
<i>/**
* Sets the width <b>for</b> a column.
* @param {Number} col The column index
* @param {Number} width The <b>new</b> width
*/</i>
setColumnWidth : <b>function</b>(col, width, suppressEvent){
<b>this</b>.config[col].width = width;
<b>this</b>.totalWidth = null;
<b>if</b>(!suppressEvent){
<b>this</b>.fireEvent(&quot;widthchange&quot;, <b>this</b>, col, width);
}
},
<i>/**
* Returns the total width of all columns.
* @param {Boolean} includeHidden True to include hidden column widths
* @<b>return</b> {Number}
*/</i>
getTotalWidth : <b>function</b>(includeHidden){
<b>if</b>(!<b>this</b>.totalWidth){
<b>this</b>.totalWidth = 0;
<b>for</b>(var i = 0, len = <b>this</b>.config.length; i &lt; len; i++){
<b>if</b>(includeHidden || !<b>this</b>.isHidden(i)){
<b>this</b>.totalWidth += <b>this</b>.getColumnWidth(i);
}
}
}
<b>return</b> this.totalWidth;
},
<i>/**
* Returns the header <b>for</b> the specified column.
* @param {Number} col The column index
* @<b>return</b> {String}
*/</i>
getColumnHeader : <b>function</b>(col){
<b>return</b> this.config[col].header;
},
<i>/**
* Sets the header <b>for</b> a column.
* @param {Number} col The column index
* @param {String} header The <b>new</b> header
*/</i>
setColumnHeader : <b>function</b>(col, header){
<b>this</b>.config[col].header = header;
<b>this</b>.fireEvent(&quot;headerchange&quot;, <b>this</b>, col, header);
},
<i>/**
* Returns the tooltip <b>for</b> the specified column.
* @param {Number} col The column index
* @<b>return</b> {String}
*/</i>
getColumnTooltip : <b>function</b>(col){
<b>return</b> this.config[col].tooltip;
},
<i>/**
* Sets the tooltip <b>for</b> a column.
* @param {Number} col The column index
* @param {String} tooltip The <b>new</b> tooltip
*/</i>
setColumnTooltip : <b>function</b>(col, tooltip){
<b>this</b>.config[col].tooltip = tooltip;
},
<i>/**
* Returns the dataIndex <b>for</b> the specified column.
* @param {Number} col The column index
* @<b>return</b> {Number}
*/</i>
getDataIndex : <b>function</b>(col){
<b>return</b> this.config[col].dataIndex;
},
<i>/**
* Sets the dataIndex <b>for</b> a column.
* @param {Number} col The column index
* @param {Number} dataIndex The <b>new</b> dataIndex
*/</i>
setDataIndex : <b>function</b>(col, dataIndex){
<b>this</b>.config[col].dataIndex = dataIndex;
},
findColumnIndex : <b>function</b>(dataIndex){
<b>var</b> c = <b>this</b>.config;
<b>for</b>(var i = 0, len = c.length; i &lt; len; i++){
<b>if</b>(c[i].dataIndex == dataIndex){
<b>return</b> i;
}
}
<b>return</b> -1;
},
<i>/**
* Returns true <b>if</b> the cell is editable.
* @param {Number} colIndex The column index
* @param {Number} rowIndex The row index
* @<b>return</b> {Boolean}
*/</i>
isCellEditable : <b>function</b>(colIndex, rowIndex){
<b>return</b> (<b>this</b>.config[colIndex].editable || (<b>typeof</b> this.config[colIndex].editable == &quot;undefined&quot; &amp;&amp; <b>this</b>.config[colIndex].editor)) ? true : false;
},
<i>/**
* Returns the editor defined <b>for</b> the cell/column.
* @param {Number} colIndex The column index
* @param {Number} rowIndex The row index
* @<b>return</b> {Object}
*/</i>
getCellEditor : <b>function</b>(colIndex, rowIndex){
<b>return</b> this.config[colIndex].editor;
},
<i>/**
* Sets <b>if</b> a column is editable.
* @param {Number} col The column index
* @param {Boolean} editable True <b>if</b> the column is editable
*/</i>
setEditable : <b>function</b>(col, editable){
<b>this</b>.config[col].editable = editable;
},
<i>/**
* Returns true <b>if</b> the column is hidden.
* @param {Number} colIndex The column index
* @<b>return</b> {Boolean}
*/</i>
isHidden : <b>function</b>(colIndex){
<b>return</b> this.config[colIndex].hidden;
},
<i>/**
* Returns true <b>if</b> the column width cannot be changed
*/</i>
isFixed : <b>function</b>(colIndex){
<b>return</b> this.config[colIndex].fixed;
},
<i>/**
* Returns true <b>if</b> the column cannot be resized
* @<b>return</b> {Boolean}
*/</i>
isResizable : <b>function</b>(colIndex){
<b>return</b> this.config[colIndex].resizable !== false;
},
<i>/**
* Sets <b>if</b> a column is hidden.
* @param {Number} colIndex The column index
* @param {Boolean} hidden True <b>if</b> the column is hidden
*/</i>
setHidden : <b>function</b>(colIndex, hidden){
<b>this</b>.config[colIndex].hidden = hidden;
<b>this</b>.totalWidth = null;
<b>this</b>.fireEvent(&quot;hiddenchange&quot;, <b>this</b>, colIndex, hidden);
},
<i>/**
* Sets the editor <b>for</b> a column.
* @param {Number} col The column index
* @param {Object} editor The editor object
*/</i>
setEditor : <b>function</b>(col, editor){
<b>this</b>.config[col].editor = editor;
}
});
Ext.grid.ColumnModel.defaultRenderer = <b>function</b>(value){
<b>if</b>(typeof value == &quot;string&quot; &amp;&amp; value.length &lt; 1){
<b>return</b> &quot;&amp;#160;&quot;;
}
<b>return</b> value;
};
<i>// Alias <b>for</b> backwards compatibility</i>
Ext.grid.DefaultColumnModel = Ext.grid.ColumnModel;
</code></pre><hr><div style="font-size:10px;text-align:center;color:gray;">Ext - Copyright &copy; 2006-2007 Ext JS, LLC<br />All rights reserved.</div>
</body></html>
Reference in a new issue View git blame Copy permalink