/* This file is part of Ext JS 3.4 Copyright (c) 2011-2013 Sencha Inc Contact: http://www.sencha.com/contact GNU General Public License Usage This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file. Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html. If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact. Build date: 2013-04-03 15:07:25 */ Ext.data.JsonP.Ext_grid_PropertyColumnModel({"alternateClassNames":[],"aliases":{},"enum":null,"parentMixins":[],"tagname":"class","subclasses":[],"extends":"Ext.grid.ColumnModel","uses":[],"html":"
Hierarchy
Ext.util.ObservableExt.grid.ColumnModelExt.grid.PropertyColumnModelFiles
A custom column model for the Ext.grid.PropertyGrid. Generally it should not need to be used directly.
\nAn Array of object literals. The config options defined by\nExt.grid.Column are the options which may appear in the object literal for each\nindividual column definition.
\n(optional) Default sortable of columns which have no\nsortable specified (defaults to false). This property shall preferably be configured\nthrough the defaults config property.
\nDefaults to: false
(optional) The width of columns which have no width\nspecified (defaults to 100). This property shall preferably be configured through the\ndefaults config property.
\nDefaults to: 100
Object literal which will be used to apply Ext.grid.Column\nconfiguration options to all columns. Configuration options specified with\nindividual column configs will supersede these defaults.
\n(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick
event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:
// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n constructor: function(config) {\n this.listeners = config.listeners ? config.listeners : config;\n },\n\n // Component passes itself into plugin's init method\n init: function(c) {\n var p, l = this.listeners;\n for (p in l) {\n if (Ext.isFunction(l[p])) {\n l[p] = this.createHandler(l[p], c);\n } else {\n l[p].fn = this.createHandler(l[p].fn, c);\n }\n }\n\n // Add the listeners to the Element immediately following the render call\n c.render = c.render.createSequence(function() {\n var e = c.getEl();\n if (e) {\n e.on(l);\n }\n });\n },\n\n createHandler: function(fn, c) {\n return function(e) {\n fn.call(this, e, c);\n };\n }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n // Collapse combo when its element is clicked on\n plugins: [ new Ext.DomObserver({\n click: function(evt, comp) {\n comp.collapse();\n }\n })],\n store: myStore,\n typeAhead: true,\n mode: 'local',\n triggerAction: 'all'\n});\n
\n\n\n\nAn Array of Column definition objects representing the configuration\nof this ColumnModel. See Ext.grid.Column for the configuration properties that may\nbe specified.
\nThe grid this store will be bound to
\nThe source data config object
\nOverrides: Ext.grid.ColumnModel.constructor
Adds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
\nor the first event name string if multiple event names are being passed as separate parameters.
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n\nAppends an event handler to this object.
\nThe name of the event to listen for.
\nThe method the event invokes.
\nThe scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
An object containing handler configuration.\nproperties. This may contain any of the following properties:
this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
\n\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
myGridPanel.on({\n'click' : {\n fn: this.onClick,\n scope: this,\n delay: 100\n},\n'mouseover' : {\n fn: this.onMouseOver,\n scope: this\n},\n'mouseout' : {\n fn: this.onMouseOut,\n scope: this\n}\n});
\n\nOr a shorthand syntax:
\n
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
\n\ninherit docs
\n\nDestroys this column model by purging any event listeners. Destroys and dereferences all Columns.
\nOverrides: Ext.grid.ColumnModel.destroy
Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget()
if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.Field, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\n\nFires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nprivate
\n\nReturns the editor defined for the cell/column.
\nOverrides: Ext.grid.ColumnModel.getCellEditor
Returns the column for a specified id.
\nThe column id
\nthe column
\nReturns the number of columns.
\nOptional. Pass as true to only include visible columns.
\nReturns the column configs that return true by the passed function that is called\nwith (columnConfig, index)
\n\n// returns an array of column config objects for all hidden columns\nvar columns = grid.getColumnModel().getColumnsBy(function(c){\n return c.hidden;\n});\n
\n\nA function which, when passed a Column object, must\nreturn true
if the column is to be included in the returned Array.
The scope (this
reference) in which the function\nis executed. Defaults to this ColumnModel.
result
\nprivate
\n\nReturns the rendering (formatting) function defined for the column.
\nThe column index.
\nThe function used to render the cell. See setRenderer.
\nOverrides: Ext.grid.ColumnModel.getRenderer
Returns the total width of all columns.
\nTrue to include hidden column widths
\nChecks to see if this object has any listeners for a specified event
\nThe name of the event to check for
\nTrue if the event is being listened for, else false
\nprivate
\n\nReturns true if the cell is editable.
\n\nvar store = new Ext.data.Store({...});\nvar colModel = new Ext.grid.ColumnModel({\n columns: [...],\n isCellEditable: function(col, row) {\n var record = store.getAt(row);\n if (record.get('readonly')) { // replace with your condition\n return false;\n }\n return Ext.grid.ColumnModel.prototype.isCellEditable.call(this, col, row);\n }\n});\nvar grid = new Ext.grid.GridPanel({\n store: store,\n colModel: colModel,\n ...\n});\n
\n\nOverrides: Ext.grid.ColumnModel.isCellEditable
Returns true if the specified column menu is disabled.
\nThe column index
\nReturns true if the column can be resized
\nReturns true if the specified column is sortable.
\nThe column index
\nAppends an event handler to this object (shorthand for addListener.)
\nThe type of event to listen for
\nThe method the event invokes
\nThe scope (this
reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
An object containing handler configuration.
\nRelays selected events from the specified Observable as if the events were fired by this.
\nThe Observable whose events this object is to relay.
\nArray of event names to relay.
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\nThe handler to remove. This must be a reference to the function passed into the addListener call.
\nThe scope originally specified for the handler.
\nprivate
\nResume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.
\nSets the width for a column.
\nThe column index
\nThe new width
\nTrue to suppress firing the widthchange
\nevent. Defaults to false.
Reconfigures this column model according to the passed Array of column definition objects.\nFor a description of the individual properties of a column definition object, see the\nConfig Options.
\n\n\nCauses the configchange event to be fired. A GridPanel\nusing this ColumnModel will listen for this event and refresh its UI automatically.
\n\nArray of Column definition objects.
\nSpecify true to bypass cleanup which deletes the totalWidth\nand destroys existing editors.
\nSets if a column is editable.
\nThe column index
\nTrue if the column is editable
\nSets the editor for a column and destroys the prior editor.
\nThe column index
\nThe editor object
\nSets if a column is hidden.
\n\nmyGrid.getColumnModel().setHidden(0, true); // hide column 0 (0 = the first column).\n
\n\nThe column index
\nTrue if the column is hidden
\nSets the rendering (formatting) function for a column. See Ext.util.Format for some\ndefault formatting functions.
\nThe column index
\nThe function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:
The data value for the cell.
An object in which you may set the following attributes:
A CSS class name to add to the cell's TD element.
An HTML attribute definition string to apply to the data container element within the table cell\n(e.g. 'style=\"color:red;\"').
The Ext.data.Record from which the data was extracted.
Row index
Column index
The Ext.data.Store object from which the Record was extracted.
Setup any saved state for the column, ensures that defaults are applied.
\nSuspend the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\nRemoves an event handler (shorthand for removeListener.)
\nThe type of event the handler was associated with.
\nThe handler to remove. This must be a reference to the function passed into the addListener call.
\nThe scope originally specified for the handler.
\nFires when the configuration is changed
\nFires when the width of a column is programmaticially changed using\nsetColumnWidth
.\nNote internal resizing suppresses the event from firing. See also\nExt.grid.GridPanel.columnresize
.