X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6e39d509471fe9b4e2660e0d1631b350d0c66f40..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.grid.EditorGridPanel.html?ds=inline diff --git a/docs/output/Ext.grid.EditorGridPanel.html b/docs/output/Ext.grid.EditorGridPanel.html deleted file mode 100644 index b26632f4..00000000 --- a/docs/output/Ext.grid.EditorGridPanel.html +++ /dev/null @@ -1,1565 +0,0 @@ -
Observable Component BoxComponent Container Panel GridPanel EditorGridPanel
Package: | Ext.grid |
Defined In: | EditorGrid.js |
Class: | EditorGridPanel |
Subclasses: | PropertyGrid |
Extends: | GridPanel |
This class extends the GridPanel Class to provide cell editing -on selected columns. The editable columns are specified by providing -an editor in the column configuration.
-Editability of columns may be controlled programatically by inserting an implementation -of isCellEditable into the -ColumnModel.
-Editing is performed on the value of the field specified by the column's -dataIndex in the backing Store -(so if you are using a renderer in order to display -transformed data, this must be accounted for).
-If a value-to-description mapping is used to render a column, then a ComboBox -which uses the same value-to-description -mapping would be an appropriate editor.
-If there is a more complex mismatch between the visible data in the grid, and the editable data in -the Store, then code to transform the data both before and after editing can be -injected using the beforeedit and afteredit events.Config Options | Defined By | |
---|---|---|
anchor : String Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout -based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | |
animCollapse : Boolean true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.... true to animate the transition when the panel is collapsed, false to skip the
-animation (defaults to true if the Ext.Fx class is available, otherwise false ). | Panel | |
autoEncode : Boolean True to automatically HTML encode and decode values pre and post edit (defaults to false) | EditorGridPanel | |
autoExpandColumn : String The id of a column in
-this grid that should expand to fill unused space. This value specified here can not
-be 0.
-N... The id of a column in -this grid that should expand to fill unused space. This value specified here can not -be 0. -Note: If the Grid's view is configured with -forceFit=true the autoExpandColumn -is ignored. See Ext.grid.Column.width -for additional details. -See autoExpandMax and autoExpandMin also. | GridPanel | |
autoExpandMax : Number The maximum width the autoExpandColumn
-can have (if enabled). Defaults to 1000. | GridPanel | |
autoExpandMin : Number The minimum width the autoExpandColumn
-can have (if enabled). Defaults to 50. | GridPanel | |
autoHeight : Boolean true to use height:'auto', false to use fixed height (defaults to false).
-Note: Setting autoHeight: true means that t... true to use height:'auto', false to use fixed height (defaults to false ).
-Note: Setting autoHeight: true means that the browser will manage the panel's height
-based on its contents, and that Ext will not manage it at all. If the panel is within a layout that
-manages dimensions (fit , border , etc.) then setting autoHeight: true
-can cause issues with scrolling and will not generally work as expected since the panel will take
-on the height of its contents rather than the height required by the Ext layout. | Panel | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
-them on render (defaults to false). | Component | |
baseCls : String The base CSS class to apply to this panel's element (defaults to 'x-panel').
-Another option available by default is t... The base CSS class to apply to this panel's element (defaults to 'x-panel' ).
-Another option available by default is to specify | Panel | |
bbar : Object/Array The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
-buttons/button co... The bottom toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of -buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. -To access the bottom toolbar after render, use getBottomToolbar. -Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
bbarCfg : Object | Panel | |
bodyCfg : Object A DomHelper element specification object may be specified for any
-Panel Element.
-By default, the Default element in t... A DomHelper element specification object may be specified for any -Panel Element. -By default, the Default element in the table below will be used for the html markup to
-create a child element with the commensurate Default class name ( -Panel Default Default Custom Additional Additional -Element element class element class style -======== ========================== ========= ============== =========== -header div baseCls+'-header' headerCfg headerCssClass headerStyle -bwrap div baseCls+'-bwrap' bwrapCfg bwrapCssClass bwrapStyle -+ tbar div baseCls+'-tbar' tbarCfg tbarCssClass tbarStyle -+ body div baseCls+'-body' bodyCfg bodyCssClass bodyStyle -+ bbar div baseCls+'-bbar' bbarCfg bbarCssClass bbarStyle -+ footer div baseCls+'-footer' footerCfg footerCssClass footerStyle -- Configuring a Custom element may be used, for example, to force the body Element -to use a different form of markup than is created by default. An example of this might be -to create a child Panel containing a custom content, such as -a header, or forcing centering of all Panel content by having the body be a <center> -element: -
-The example above also explicitly creates a | Panel | |
bodyCssClass : String/Object/Function Additional css class selector to be applied to the body element in the format expected by
-Ext.Element.addClass (defau... Additional css class selector to be applied to the body element in the format expected by
-Ext.Element.addClass (defaults to null). See bodyCfg. | Panel | |
border : Boolean True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
-the bord... True to display the borders of the panel's body element, false to hide them (defaults to true). By default,
-the border is a 2px wide inset border, but this can be further altered by setting bodyBorder to false. | Panel | |
boxMaxHeight : Number The maximum value in pixels which this BoxComponent will set its height to.
-Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMaxWidth : Number The maximum value in pixels which this BoxComponent will set its width to.
-Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinHeight : Number The minimum value in pixels which this BoxComponent will set its height to.
-Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
-Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
-See Ext.util.Observable.enableBubble... An array of events that, when fired, should be bubbled to any parent container. -See Ext.util.Observable.enableBubble. -Defaults to []. | GridPanel | |
buttonAlign : String The alignment of any buttons added to this panel. Valid values are 'right',
-'left' and 'center' (defaults to 'right'... The alignment of any buttons added to this panel. Valid values are 'right' ,
-'left' and 'center' (defaults to 'right' ). | Panel | |
buttons : Array buttons will be used as items for the toolbar in
-the footer (fbar). Typically the value of this configuration propert... buttons will be used as items for the toolbar in
-the footer (fbar ). Typically the value of this configuration property will be
-an array of Ext.Buttons or Ext.Button configuration objects.
-If an item is configured with minWidth or the Panel is configured with minButtonWidth ,
-that width will be applied to the item. | Panel | |
bwrapCfg : Object | Panel | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
-directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered -directly after each form field wrapper to provide field clearing (defaults to -'x-form-clear-left'). -Note: this config is only used when this Component is rendered by a Container -which has been configured to use the FormLayout layout -manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a -fieldLabel is specified or isFormField=true is specified. - See Ext.layout.FormLayout.fieldTpl also. | Component | |
clicksToEdit : Number The number of clicks on a cell required to display the cell's editor (defaults to 2).
-Setting this option to 'auto' m... The number of clicks on a cell required to display the cell's editor (defaults to 2). -Setting this option to 'auto' means that mousedown on the selected cell starts -editing that cell. | EditorGridPanel | |
closable : Boolean Panels themselves do not directly support being closed, but some Panel subclasses do (like
-Ext.Window) or a Panel Cla... Panels themselves do not directly support being closed, but some Panel subclasses do (like
-Ext.Window) or a Panel Class within an Ext.TabPanel. Specify true
-to enable closing in such situations. Defaults to false . | Panel | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
cm : Object Shorthand for colModel. | GridPanel | |
colModel : Object The Ext.grid.ColumnModel to use when rendering the grid (required). | GridPanel | |
collapseFirst : Boolean true to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the pane... true to make sure the collapse/expand toggle button always renders first (to the left of)
-any other tools in the panel's title bar, false to render it last (defaults to true ). | Panel | |
collapsed : Booleantrue to render the panel collapsed, false to render it expanded (defaults to
-false ). | Panel | |
collapsedCls : String A CSS class to add to the panel's element after it has been collapsed (defaults to
- 'x-panel-collapsed' ). | Panel | |
collapsible : Boolean True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
-the header ... True to make the panel collapsible and have the expand/collapse toggle button automatically rendered into
-the header tool button area, false to keep the panel statically sized with no button (defaults to false). | Panel | |
columnLines : Boolean true to add css for column separation lines.
-Default is false. | GridPanel | |
columns : Array An array of columns to auto create a
-Ext.grid.ColumnModel. The ColumnModel may be explicitly created via the
-colMo... An array of columns to auto create a
-Ext.grid.ColumnModel. The ColumnModel may be explicitly created via the
-colModel configuration property. | GridPanel | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
-adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for -adding customized styles to the container or any of its children using standard CSS rules. See -Ext.layout.ContainerLayout.extraCls also. -Note: ctCls defaults to '' except for the following class -which assigns a value by default: -
- | Component | |
data : Mixed The initial set of data to apply to the tpl to
-update the content area of the Component. | Component | |
ddGroup : String The DD group this GridPanel belongs to. Defaults to 'GridDD' if not specified. | GridPanel | |
ddText : String Configures the text in the drag proxy. Defaults to:
-ddText : '{0} selected row{1}'
-{0} is replaced with the number... Configures the text in the drag proxy. Defaults to:
-
-{0} is replaced with the number of selected rows. | GridPanel | |
deferRowRender : Boolean Defaults to true to enable deferred row rendering.
-This allows the GridPanel to be initially rendered empty, with th... Defaults to true to enable deferred row rendering. -This allows the GridPanel to be initially rendered empty, with the expensive update of the row -structure deferred so that layouts with GridPanels appear more quickly. | GridPanel | |
disableSelection : Boolean true to disable selections in the grid. Defaults to false. -Ignored if a SelectionModel is specified. | GridPanel | |
disabled : Boolean Render this panel disabled (default is false). An important note when using the disabled
-config on panels is that IE ... Render this panel disabled (default is false ). An important note when using the disabled
-config on panels is that IE will often fail to initialize the disabled mask element correectly if
-the panel's layout has not yet completed by the time the Panel is disabled during the render process.
-If you experience this issue, you may need to instead use the afterlayout event to initialize
-the disabled state:
-
| Panel | |
draggable : Boolean/Object true to enable dragging of this Panel (defaults to false).
-For custom drag/drop implementations, an Ext.Panel.DD conf...
For custom drag/drop implementations, an Ext.Panel.DD config could also be passed
-in this config instead of
| Panel | |
enableColumnHide : Boolean Defaults to true to enable hiding of columns
-with the header menu. | GridPanel | |
enableColumnMove : Boolean Defaults to true to enable drag and drop reorder of columns. false
-to turn off column reordering via drag drop. | GridPanel | |
enableColumnResize : Boolean false to turn off column resizing for the whole grid. Defaults to true. | GridPanel | |
enableDragDrop : Boolean Enables dragging of the selected rows of the GridPanel. Defaults to false.
-Setting this to true causes this GridPane... Enables dragging of the selected rows of the GridPanel. Defaults to false. -Setting this to true causes this GridPanel's GridView to -create an instance of Ext.grid.GridDragZone. Note: this is available only after -the Grid has been rendered as the GridView's dragZone -property. -A cooperating DropZone must be created who's implementations of -onNodeEnter, onNodeOver, -onNodeOut and onNodeDrop are able -to process the data which is provided. | GridPanel | |
enableHdMenu : Boolean Defaults to true to enable the drop down button for menu in the headers. | GridPanel | |
fbar : Object/Array A Toolbar object, a Toolbar config, or an array of
-Buttons/Button configs, describing a Toolbar to be rendered into t... A Toolbar object, a Toolbar config, or an array of -Buttons/Button configs, describing a Toolbar to be rendered into this Panel's footer element. -After render, the If buttonAlign configuration affects the layout of these items, for example:
-
-Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
fieldLabel : String The label text to display next to this Component (defaults to '').
-Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). -Note: this config is only used when this Component is rendered by a Container which -has been configured to use the FormLayout layout manager (e.g. -Ext.form.FormPanel or specifying layout:'form'). - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
floating : Mixed This property is used to configure the underlying Ext.Layer. Acceptable values for this
-configuration property are:<d... This property is used to configure the underlying Ext.Layer. Acceptable values for this -configuration property are:
| Panel | |
footer : Boolean true to create the footer element explicitly, false to skip creating it. The footer
-will be created automatically if ... | Panel | |
footerCfg : Object | Panel | |
forceLayout : Boolean If true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
-is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | |
forceValidation : Boolean True to force validation even if the value is unmodified (defaults to false) | EditorGridPanel | |
frame : Boolean false by default to render with plain 1px square borders. true to render with
-9 elements, complete with custom rounde... false by default to render with plain 1px square borders. true to render with
-9 elements, complete with custom rounded corners (also see Ext.Element.boxWrap).
-The template generated for each condition is depicted below:
| Panel | |
header : Boolean true to create the Panel's header element explicitly, false to skip creating
-it. If a title is set the header will b... | Panel | |
headerAsText : Boolean | Panel | |
headerCfg : Object | Panel | |
height : Number The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
hidden : Boolean Render this component hidden (default is false). If true, the
-hide method will be called internally. | Component | |
hideCollapseTool : Booleantrue to hide the expand/collapse toggle button when collapsible == true ,
-false to display it (defaults to false ). | Panel | |
hideHeaders : Boolean True to hide the grid's header. Defaults to false . | GridPanel | |
hideLabel : Boolean true to completely hide the label element
-(label and separator). Defaults to false.
-By default, even if you do not sp... true to completely hide the label element -(label and separator). Defaults to false. -By default, even if you do not specify a fieldLabel the space will still be -reserved so that the field will line up with other fields that do have labels. -Setting this to true will cause the field to not reserve that space. -Note: see the note for clearCls. -Example use:
| Component | |
hideMode : String How this component should be hidden. Supported values are 'visibility'
-(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility' -(css visibility), 'offsets' (negative offset position) and 'display' -(css display). -Note: the default of 'display' is generally preferred -since items are automatically laid out when they are first shown (no sizing -is done while hidden). | Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
-and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
iconCls : String The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
-An example o... The CSS class selector that specifies a background image to be used as the header icon (defaults to '').
- An example of specifying a custom icon class would be something like: -
| Panel | |
id : String The unique id of this component (defaults to an auto-assigned id).
-You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). -You should assign an id if you need to be able to access the component later and you do -not have an object reference available (e.g., using Ext.getCmp). -Note that this id will also be used as the element id for the containing HTML element -that is rendered to the page for this component. This allows you to write id-based CSS -rules to style the specific instance of this component uniquely, and also to select -sub-elements using this component's id as the parent. -Note: to avoid complications imposed by a unique id also see
- Note: to access the container of an item see | Component | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
-has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which -has been configured to use the FormLayout layout manager (e.g. -Ext.form.FormPanel or specifying layout:'form'). - An additional CSS class to apply to the div wrapping the form item -element of this field. If supplied, itemCls at the field level will override -the default itemCls supplied at the container level. The value specified for -itemCls will be added to the default class ('x-form-item'). -Since it is applied to the item wrapper (see -Ext.layout.FormLayout.fieldTpl), it allows -you to write standard CSS rules that can apply to the field, the label (if specified), or -any other element within the markup for the field. -Note: see the note for fieldLabel. -Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
-when no object reference is available. Instead of using an
-
-Note: to access the container of an item see ownerCt. | Component | |
keys : Object/Array A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
-used to assign custom key handling to thi... A Ext.KeyMap config object (in the format expected by Ext.KeyMap.addBinding
-used to assign custom key handling to this panel (defaults to null ). | Panel | |
labelSeparator : String The separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
-The o... The separator to display after the text of each -fieldLabel. This property may be configured at various levels. -The order of precedence is: -
Note: see the note for clearCls. - Also see hideLabel and -Ext.layout.FormLayout.fieldTpl. -Example use:
| Component | |
labelStyle : String A CSS style specification string to apply directly to this field's
-label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's -label. Defaults to the container's labelStyle value if set (e.g., -Ext.layout.FormLayout.labelStyle , or ''). -Note: see the note for - Also see
| Component | |
listeners : Object A config object containing one or more event handlers to be added to this
-object during initialization. This should ... A config object containing one or more event handlers to be added to this -object during initialization. This should be a valid listeners config object as specified in the -addListener example for attaching multiple handlers at once. -DOM events from ExtJs Components -While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
-is usually only done when extra value can be added. For example the DataView's
-
| Observable | |
loadMask : Object An Ext.LoadMask config or true to mask the grid while
-loading. Defaults to false . | GridPanel | |
margins : Object Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -or one of the two BoxLayout subclasses. -An object containing margins to apply to this BoxComponent in the -format:
-May also be a string containing space-separated, numeric margin values. The order of the -sides associated with each value matches the way CSS processes margin values: -
Defaults to:
| BoxComponent | |
maskDisabled : Boolean true to mask the panel when it is disabled, false to not mask it (defaults
-to true). Either way, the panel will alwa... true to mask the panel when it is disabled, false to not mask it (defaults
-to true ). Either way, the panel will always tell its contained elements to disable themselves
-when it is disabled, but masking the panel can provide an additional visual cue that the panel is
-disabled. | Panel | |
maxHeight : Number Sets the maximum height of the grid - ignored if autoHeight is not on. | GridPanel | |
minButtonWidth : Number Minimum width in pixels of all buttons in this panel (defaults to 75 ) | Panel | |
minColumnWidth : Number The minimum width a column can be resized to. Defaults to 25. | GridPanel | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
-over the Element, and removed when the mouse moves out. (defaults to ''). This can be
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
padding : Number/String A shortcut for setting a padding style on the body element. The value can either be
-a number to be applied to all sid... A shortcut for setting a padding style on the body element. The value can either be
-a number to be applied to all sides, or a normal css string describing padding.
-Defaults to undefined. | Panel | |
pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
-requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
-requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
-When a component is created, if any plugins are available, the component will call the init method on each
-plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
-component as needed to provide its functionality. | Component | |
ptype : String The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a Plugin is being
-specified not as a fully instantiated Component, but as a Component config
-object. The ptype will be looked up at render time up to determine what
-type of Plugin to create. -If you create your own Plugins, you may register them using -Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
ref : String A path specification, relative to the Component's ownerCt
-specifying into which ancestor Container to place a named r... A path specification, relative to the Component's The ancestor axis can be traversed by using '/' characters in the path. -For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the | Component | |
region : String Note: this config is only used when this BoxComponent is rendered
-by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered -by a Container which has been configured to use the BorderLayout -layout manager (e.g. specifying layout:'border'). - See Ext.layout.BorderLayout also. | BoxComponent | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
-Notes ... Specify the id of the element, a DOM element or an existing Element that this component -will be rendered into.
See render also. | Component | |
resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'bodyresize'. | Panel | |
selModel : Object Any subclass of AbstractSelectionModel that will provide the selection model for
-the grid (defaults to Ext.grid.CellS... Any subclass of AbstractSelectionModel that will provide the selection model for
-the grid (defaults to Ext.grid.CellSelectionModel if not specified). | EditorGridPanel | |
shadow : Boolean/String true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (... true (or a valid Ext.Shadow Ext.Shadow.mode value) to display a shadow behind the
-panel, false to display no shadow (defaults to 'sides' ). Note that this option
-only applies when floating = true . | Panel | |
shadowOffset : Number The number of pixels to offset the shadow if displayed (defaults to 4). Note that this
-option only applies when float... The number of pixels to offset the shadow if displayed (defaults to 4 ). Note that this
-option only applies when floating = true . | Panel | |
shim : Boolean false to disable the iframe shim in browsers which need one (defaults to true).
-Note that this option only applies wh... false to disable the iframe shim in browsers which need one (defaults to true ).
-Note that this option only applies when floating = true . | Panel | |
sm : Object Shorthand for selModel. | GridPanel | |
stateEvents : Array An array of events that, when fired, should trigger this component to save its state.
-Defaults to:stateEvents: ['col... An array of events that, when fired, should trigger this component to save its state.
-Defaults to:
-These can be any types of events supported by this component, including browser or -custom events (e.g., ['click', 'customerchange']). -See Ext.Component.stateful for an explanation of saving and restoring -Component state. | GridPanel | |
stateId : String The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
-(defaults to the component id if one was set, otherwise null if the
-component is using a generated id).
- See | Component | |
stateful : Boolean A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
-internal properties from a saved state on startup. The component must have
-either a - For state saving to work, the state manager's provider must have been -set to an implementation of Ext.state.Provider which overrides the -set and get -methods to save and recall name/value pairs. A built-in implementation, -Ext.state.CookieProvider is available. -To set the state provider for the current page: -
-A stateful Component attempts to save state when one of the events
-listed in the To save state, a stateful Component first serializes its state by
-calling The value yielded by getState is passed to Ext.state.Manager.set
-which uses the configured Ext.state.Provider to save the object
-keyed by the Component's During construction, a stateful Component attempts to restore
-its state by calling Ext.state.Manager.get passing the
- The resulting object is passed to You can perform extra processing on state save and restore by attaching -handlers to the beforestaterestore, staterestore, -beforestatesave and statesave events. | Component | |
store : Ext.data.Store The Ext.data.Store the grid should use as its data source (required). | GridPanel | |
stripeRows : Boolean true to stripe the rows. Default is false.
-This causes the CSS class x-grid3-row-alt to be added to alternate rows o... true to stripe the rows. Default is false.
- This causes the CSS class x-grid3-row-alt to be added to alternate rows of -the grid. A default CSS rule is provided which sets a background colour, but you can override this -with a rule which either overrides the background-color style using the '!important' -modifier, or which uses a CSS selector of higher specificity. | GridPanel | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
-Ext.Element.applyStyles.
-
| Component | |
tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
-A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. -A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over -the associated tab selector element. Ext.QuickTips.init() -must be called in order for the tips to render. | BoxComponent | |
tbar : Object/Array The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of
-buttons/button confi... The top toolbar of the panel. This can be a Ext.Toolbar object, a toolbar config, or an array of -buttons/button configs to be added to the toolbar. Note that this is not available as a property after render. -To access the top toolbar after render, use getTopToolbar. -Note: Although a Toolbar may contain Field components, these will not be updated by a load -of an ancestor FormPanel. A Panel's toolbars are not part of the standard Container->Component hierarchy, and -so are not scanned to collect form items. However, the values will be submitted because form -submission parameters are collected from the DOM tree. | Panel | |
tbarCfg : Object | Panel | |
title : String The title text to be used as innerHTML (html tags are accepted) to display in the panel
-header (defaults to ''). When... The title text to be used as innerHTML (html tags are accepted) to display in the panel
- header (defaults to ''). When a title is specified the
-header element will automatically be created and displayed unless
-header is explicitly set to false . If you do not want to specify a
-title at config time, but you may want one later, you must either specify a non-empty
-title (a blank space ' ' will do) or header:true so that the container
-element will get created. | Panel | |
titleCollapse : Boolean true to allow expanding and collapsing the panel (when collapsible = true)
-by clicking anywhere in the header bar, fa... true to allow expanding and collapsing the panel (when collapsible = true )
-by clicking anywhere in the header bar, false ) to allow it only by clicking to tool button
-(defaults to false )). If this panel is a child item of a border layout also see the
-BorderLayout.Region
-floatable config option. | Panel | |
toolTemplate : Ext.Template/Ext.XTemplate A Template used to create tools in the header Element. Defaults to:new Ext.Template('<div class="x-tool x-tool-{id... A Template used to create tools in the header Element. Defaults to:
-This may may be overridden to provide a custom DOM structure for tools based upon a more -complex XTemplate. The template's data is a single tool configuration object (Not the entire Array) -as specified in tools. In the following example an <a> tag is used to provide a -visual indication when hovering over the tool:
-Note that the CSS class 'x-tool-pdf' should have an associated style rule which provides an -appropriate background image, something like: -
| Panel | |
tools : Array An array of tool button configs to be added to the header tool area. When rendered, each tool is
-stored as an Element... An array of tool button configs to be added to the header tool area. When rendered, each tool is
-stored as an Element referenced by a public property called tools.<tool-type>
-Each tool config may contain the following properties: -
Note that, apart from the toggle tool which is provided when a panel is collapsible, these -tools only provide the visual button. Any required functionality must be provided by adding -handlers that implement the necessary behavior. -Example usage: -
-For the custom id of
| Panel | |
tpl : Mixed An Ext.Template, Ext.XTemplate
-or an array of strings to form an Ext.XTemplate.
-Used in conjunction with the data and... An data and
-tplWriteMode configurations. | Component | |
tplWriteMode : String The Ext.(X)Template method to use when
-updating the content area of the Component. Defaults to 'overwrite'
-(see Ext.X... The Ext.(X)Template method to use when
-updating the content area of the Component. Defaults to 'overwrite'
-(see Ext.XTemplate.overwrite ). | Component | |
unstyled : Boolean | Panel | |
view : Object The Ext.grid.GridView used by the grid. This can be set
-before a call to render(). | GridPanel | |
viewConfig : Object A config object that will be applied to the grid's UI view. Any of
-the config options available for Ext.grid.GridVi... A config object that will be applied to the grid's UI view. Any of
-the config options available for Ext.grid.GridView can be specified here. This option
-is ignored if view is specified. | GridPanel | |
width : Number The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
-Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
xtype : String The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
-a config object into a constructor. This config option is used only when
-lazy instantiation is being used, and a child item of a Container is being
-specified not as a fully instantiated Component, but as a Component config
-object. The xtype will be looked up at render time up to determine what
-type of child Component to create. -The predefined xtypes are listed here. - -If you subclass Components to create your own Components, you may register -them using Ext.ComponentMgr.registerType in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent |
Property | Defined By | |
---|---|---|
body : Ext.Element The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, ... The Panel's body Element which may be used to contain HTML content.
-The content may be specified in the html config, or it may be loaded using the
-autoLoad config, or through the Panel's Updater. Read-only.
- If this is used to load visible HTML elements in either way, then -the Panel may not be used as a Layout for hosting nested Panels. -If this Panel is intended to be used as the host of a Layout (See layout
-then the body Element must not be loaded or changed - it is under the control
-of the Panel's Layout.
- Note: see the Note for | Panel | |
buttons : Array This Panel's Array of buttons as created from the buttons
-config property. Read only. | Panel | |
bwrap : Ext.Element | Panel | |
collapsed : Boolean True if this panel is collapsed. Read-only. | Panel | |
dd : Ext.dd.DragSource. If this Panel is configured draggable, this property will contain
-an instance of Ext.dd.DragSource which handles drag... If this Panel is configured draggable, this property will contain -an instance of Ext.dd.DragSource which handles dragging the Panel. -The developer must provide implementations of the abstract methods of Ext.dd.DragSource -in order to supply behaviour for each stage of the drag/drop process. See draggable. | Panel | |
el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
-This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. -This will usually be a <DIV> element created by the class's onRender method, but
-that may be overridden using the Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners -config for a suggestion, or use a render listener directly:
-See also getEl | Component | |
footer : Ext.Element | Panel | |
header : Ext.Element | Panel | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
-this Component is added to a C... | Component | |
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
-is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
-is a child of a Container, and has been configured with a ref . | Component | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
EditorGridPanel( Object config )
- Parameters:
| EditorGridPanel | |
addButton( String/Object config , Function handler , Object scope )
- :
- Ext.ButtonAdds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to ... Adds a button to this panel. Note that this method must be called prior to rendering. The preferred
-approach is to add buttons via the buttons config. Parameters:
| Panel | |
addClass( string cls )
- :
- Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addEvents( Object|String o , string Optional. )
- :
- voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
bubble( Function fn , [Object scope ], [Array args ] )
- :
- Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of
-function call will be the scope provided or the current component. The arguments to the function
-will be the args provided or the current component. If the function returns false at any point,
-the bubble is stopped. Parameters:
| Container | |
canLayout()
- :
- void We can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its parent elements* will mean it has no view area. Parameters:
| Container | |
cloneConfig( Object overrides )
- :
- Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| Component | |
collapse( Boolean animate )
- :
- Ext.PanelCollapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse ac... Collapses the panel body so that it becomes hidden. Fires the beforecollapse event which will
-cancel the collapse action if it returns false. Parameters:
| Panel | |
destroy()
- :
- void Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
-removing the component from its Ext.Container (if applicable) and unregistering it from
-Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. Parameters:
| Component | |
enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
- This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default -implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to -access the required target more quickly. -Example:
Parameters:
| Observable | |
expand( Boolean animate )
- :
- Ext.PanelExpands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action ... Expands the panel body so that it becomes visible. Fires the beforeexpand event which will
-cancel the expand action if it returns false. Parameters:
| Panel | |
findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
-true, the con... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
-An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). -An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] )
- :
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
get( String/Number key )
- :
- Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:
| Container | |
getBottomToolbar() - : - Ext.Toolbar | Panel | |
getBox( [Boolean local ] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
getBubbleTarget()
- :
- Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
getColumnModel()
- :
- Ext.grid.ColumnModel Returns the grid's ColumnModel. Returns the grid's ColumnModel. Parameters:
| GridPanel | |
getDragDropText()
- :
- String Called to get grid's drag proxy text, by default returns this.ddText. Called to get grid's drag proxy text, by default returns this.ddText. Parameters:
| GridPanel | |
getEl()
- :
- Ext.Element Returns the Ext.Element which encapsulates this Component.
-This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. -This will usually be a <DIV> element created by the class's onRender method, but -that may be overridden using the autoEl config. -Note: this element will not be available until this Component has been rendered. - To add listeners for DOM events to this Component (as opposed to listeners -for this Component's own Observable events), see the listeners config for a suggestion, -or use a render listener directly:
Parameters:
| Component | |
getFrameHeight()
- :
- Number Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and ... Returns the height in pixels of the framing elements of this panel (including any top and bottom bars and
-header and footer elements, but not including the body height). To retrieve the body height see getInnerHeight. Parameters:
| Panel | |
getFrameWidth()
- :
- Number Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the bo... Returns the width in pixels of the framing elements of this panel (not including the body width). To
-retrieve the body width see getInnerWidth. Parameters:
| Panel | |
getGridEl()
- :
- Element Returns the grid's underlying element. Returns the grid's underlying element. Parameters:
| GridPanel | |
getHeight()
- :
- Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | |
getId()
- :
- String Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet:
Parameters:
| Component | |
getInnerHeight()
- :
- Number Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame he... Returns the height in pixels of the body element (not including the height of any framing elements).
-For the frame height see getFrameHeight. Parameters:
| Panel | |
getInnerWidth()
- :
- Number Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame widt... Returns the width in pixels of the body element (not including the width of any framing elements).
-For the frame width see getFrameWidth. Parameters:
| Panel | |
getItemId() - : - String | Component | |
getLayoutTarget()
- :
- Ext.Element Returns the Element to be used to contain the child Components of this Container.
-An implementation is provided which... Returns the Element to be used to contain the child Components of this Container. -An implementation is provided which returns the Container's Element, but -if there is a more complex structure to a Container, this may be overridden to return -the element into which the layout renders child Components. Parameters:
| Container | |
getOuterSize()
- :
- Object Gets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. Parameters:
| BoxComponent | |
getPosition( [Boolean local ] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getResizeEl()
- :
- Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
-Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. -Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
-contains both the Parameters:
| BoxComponent | |
getSelectionModel()
- :
- SelectionModel Returns the grid's selection model configured by the selModel
-configuration option. If no selection model was config... Returns the grid's selection model configured by the selModel
-configuration option. If no selection model was configured, this will create
-and return a RowSelectionModel.Parameters:
| GridPanel | |
getSize()
- :
- Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getStore()
- :
- Ext.data.Store Returns the grid's data store. Returns the grid's data store. Parameters:
| GridPanel | |
getTool( String id )
- :
- ObjectRetrieve a tool by id. Retrieve a tool by id. Parameters:
| Panel | |
getTopToolbar() - : - Ext.Toolbar | Panel | |
getView()
- :
- Ext.grid.GridView Returns the grid's GridView object. Returns the grid's GridView object. Parameters:
| GridPanel | |
getWidth()
- :
- Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
getXType()
- :
- String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
-available xtypes, see the Ext.Component header. Example usage:
-
Parameters:
| Component | |
getXTypes()
- :
- String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
-available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all -available xtypes, see the Ext.Component header. -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -Example usage: -
Parameters:
| Component | |
hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
hide()
- :
- Ext.Component Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
-false to cancel hiding the component. Fires the 'hide'
-event after hiding the component. Note this method is called internally if
-the component is configured to be hidden .Parameters:
| Component | |
isVisible()
- :
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
-from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended -from the xtype (default) or whether it is directly of the xtype specified (shallow = true). -If using your own subclasses, be aware that a Component must register its own xtype -to participate in determination of inherited xtypes. -For a list of all available xtypes, see the Ext.Component header. -Example usage: -
Parameters:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
- :
- voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
-is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component -is destroyed. Usage:
-or:
Parameters:
| Component | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
- :
- voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
nextSibling()
- :
- Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
previousSibling()
- :
- Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
reconfigure( Ext.data.Store store , Ext.grid.ColumnModel colModel )
- :
- voidReconfigures the grid to use a different Store and Column Model
-and fires the 'reconfigure' event. The View will be ... Reconfigures the grid to use a different Store and Column Model -and fires the 'reconfigure' event. The View will be bound to the new -objects and refreshed. -Be aware that upon reconfiguring a GridPanel, certain existing settings may become -invalidated. For example the configured autoExpandColumn may no longer exist in the -new ColumnModel. Also, an existing PagingToolbar will still be bound -to the old Store, and will need rebinding. Any plugins might also need reconfiguring -with the new data. Parameters:
| GridPanel | |
relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
removeAll( [Boolean autoDestroy ] )
- :
- ArrayRemoves all components from this container. Removes all components from this container. Parameters:
| Container | |
removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
-If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. -If you are using a Container object to house this Component, then -do not use the render method. -A Container's child Components are rendered by that Container's -layout manager when the Container is first rendered. -Certain layout managers allow dynamic addition of child components. Those that do -include Ext.layout.CardLayout, Ext.layout.AnchorLayout, -Ext.layout.FormLayout, Ext.layout.TableLayout. -If the Container is already rendered when a new child Component is added, you may need to call -the Container's doLayout to refresh the view which causes any -unrendered child Components to be rendered. This is required so that you can add multiple -child components if needed while only refreshing the layout once. -When creating complex UIs, it is important to remember that sizing and positioning -of child items is the responsibility of the Container's layout manager. -If you expect child items to be sized in response to user interactions, you must -configure the Container with a layout manager which creates and manages the type of layout you -have in mind. -Omitting the Container's layout config means that a basic -layout manager is used which does nothing but render child components sequentially into the -Container. No sizing or positioning will be performed in this situation. Parameters:
| Component | |
resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-event... Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
- :
- Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setHeight( Number height )
- :
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setIconClass( String cls )
- :
- voidSets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if ... Sets the CSS class that provides the icon image for this panel. This method will replace any existing
-icon class if one has already been set and fire the iconchange event after completion. Parameters:
| Panel | |
setPagePosition( Number x , Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left , Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:
| BoxComponent | |
setSize( Mixed width , Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
-either width and height as separate arguments, or you can pass a size object like {width:10, height:20} .Parameters:
| BoxComponent | |
setTitle( String title , [String iconCls ] )
- :
- voidSets the title text for the panel and optionally the icon class.
-In order to be able to set the title, a header eleme... Sets the title text for the panel and optionally the icon class. -In order to be able to set the title, a header element must have been created
-for the Panel. This is triggered either by configuring the Panel with a non-blank Parameters:
| Panel | |
setVisible( Boolean visible )
- :
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
- :
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show()
- :
- Ext.Component Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
-false to cancel showing the component. Fires the 'show'
-event after showing the component. Parameters:
| Component | |
startEditing( Number rowIndex , Number colIndex )
- :
- voidStarts editing the specified for the specified row/column Starts editing the specified for the specified row/column Parameters:
| EditorGridPanel | |
stopEditing( [Boolean cancel ] )
- :
- voidStops any active editing Stops any active editing Parameters:
| EditorGridPanel | |
suspendEvents( Boolean queueSuspended )
- :
- voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
syncSize()
- :
- Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | |
toggleCollapse( Boolean animate )
- :
- Ext.PanelShortcut for performing an expand or collapse based on the current state of the panel. Shortcut for performing an expand or collapse based on the current state of the panel. Parameters:
| Panel | |
un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
- :
- voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
- :
- Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent |
Event | Defined By | |
---|---|---|
activate :
- ( Ext.Panel p )
- Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some... Fires after the Panel has been visually activated.
-Note that Panels do not directly support being activated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments:
| Panel | |
added :
- ( Ext.Component this , Ext.Container ownerCt , number index )
- Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afteredit :
- ( Object e )
- Fires after a cell is edited. The edit event object has the following properties <br />
-<ul style="padding:5px;paddin... Fires after a cell is edited. The edit event object has the following properties -
Listeners will be called with the following arguments:
| EditorGridPanel | |
afterrender :
- ( Ext.Component this )
- Fires after the component rendering is finished.
-The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. -The afterrender event is fired after this Component has been rendered, been postprocesed -by any afterRender method defined for the Component, and, if stateful, after state -has been restored. Listeners will be called with the following arguments:
| Component | |
beforeclose :
- ( Ext.Panel p )
- Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses d... Fires before the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. This event only
-applies to such subclasses.
-A handler can return false to cancel the close. Listeners will be called with the following arguments:
| Panel | |
beforecollapse :
- ( Ext.Panel p , Boolean animate )
- Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Fires before the Panel is collapsed. A handler can return false to cancel the collapse. Listeners will be called with the following arguments:
| Panel | |
beforedestroy :
- ( Ext.Component this )
- | Component | |
beforeedit :
- ( Object e )
- Fires before cell editing is triggered. The edit event object has the following properties <br />
-<ul style="padding:... Fires before cell editing is triggered. The edit event object has the following properties -
Listeners will be called with the following arguments:
| EditorGridPanel | |
beforeexpand :
- ( Ext.Panel p , Boolean animate )
- Fires before the Panel is expanded. A handler can return false to cancel the expand. Fires before the Panel is expanded. A handler can return false to cancel the expand. Listeners will be called with the following arguments:
| Panel | |
beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
-Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforerender :
- ( Ext.Component this )
- | Component | |
beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
-Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
- ( Ext.Component this , Object state )
- Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
- ( Ext.Component this , Object state )
- Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:
| Component | |
bodyresize :
- ( Ext.Panel p , Number width , Number height )
- Fires after the Panel has been resized. Fires after the Panel has been resized. Listeners will be called with the following arguments:
| Panel | |
bodyscroll :
- ( Number scrollLeft , Number scrollTop )
- Fires when the body element is scrolled Fires when the body element is scrolled Listeners will be called with the following arguments:
| GridPanel | |
cellclick :
- ( Grid this , Number rowIndex , Number columnIndex , Ext.EventObject e )
- Fires when a cell is clicked.
-The data for the cell is drawn from the Record
-for this row. To access the data in th... Fires when a cell is clicked.
-The data for the cell is drawn from the Record
-for this row. To access the data in the listener function use the
-following technique:
-
Listeners will be called with the following arguments:
| GridPanel | |
cellcontextmenu :
- ( Grid this , Number rowIndex , Number cellIndex , Ext.EventObject e )
- Fires when a cell is right clicked Fires when a cell is right clicked Listeners will be called with the following arguments:
| GridPanel | |
celldblclick :
- ( Grid this , Number rowIndex , Number columnIndex , Ext.EventObject e )
- Fires when a cell is double clicked Fires when a cell is double clicked Listeners will be called with the following arguments:
| GridPanel | |
cellmousedown :
- ( Grid this , Number rowIndex , Number columnIndex , Ext.EventObject e )
- Fires before a cell is clicked Fires before a cell is clicked Listeners will be called with the following arguments:
| GridPanel | |
click :
- ( Ext.EventObject e )
- The raw click event for the entire grid. The raw click event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
close :
- ( Ext.Panel p )
- Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do... Fires after the Panel is closed. Note that Panels do not directly support being closed, but some
-Panel subclasses do (like Ext.Window) or a Panel within a Ext.TabPanel. Listeners will be called with the following arguments:
| Panel | |
collapse :
- ( Ext.Panel p )
- Fires after the Panel has been collapsed. Fires after the Panel has been collapsed. Listeners will be called with the following arguments:
| Panel | |
columnmove :
- ( Number oldIndex , Number newIndex )
- Fires when the user moves a column Fires when the user moves a column Listeners will be called with the following arguments:
| GridPanel | |
columnresize :
- ( Number columnIndex , Number newSize )
- Fires when the user resizes a column Fires when the user resizes a column Listeners will be called with the following arguments:
| GridPanel | |
containerclick :
- ( Grid this , Ext.EventObject e )
- Fires when the container is clicked. The container consists of any part of the grid body that is not covered by a row... Fires when the container is clicked. The container consists of any part of the grid body that is not covered by a row. Listeners will be called with the following arguments:
| GridPanel | |
containercontextmenu :
- ( Grid this , Ext.EventObject e )
- Fires when the container is right clicked. The container consists of any part of the grid body that is not covered by... Fires when the container is right clicked. The container consists of any part of the grid body that is not covered by a row. Listeners will be called with the following arguments:
| GridPanel | |
containerdblclick :
- ( Grid this , Ext.EventObject e )
- Fires when the container is double clicked. The container consists of any part of the grid body that is not covered b... Fires when the container is double clicked. The container consists of any part of the grid body that is not covered by a row. Listeners will be called with the following arguments:
| GridPanel | |
containermousedown :
- ( Grid this , Ext.EventObject e )
- Fires before the container is clicked. The container consists of any part of the grid body that is not covered by a r... Fires before the container is clicked. The container consists of any part of the grid body that is not covered by a row. Listeners will be called with the following arguments:
| GridPanel | |
contextmenu :
- ( Ext.EventObject e )
- The raw contextmenu event for the entire grid. The raw contextmenu event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
dblclick :
- ( Ext.EventObject e )
- The raw dblclick event for the entire grid. The raw dblclick event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
deactivate :
- ( Ext.Panel p )
- Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but ... Fires after the Panel has been visually deactivated.
-Note that Panels do not directly support being deactivated, but some Panel subclasses
-do (like Ext.Window). Panels which are child Components of a TabPanel fire the
-activate and deactivate events under the control of the TabPanel. Listeners will be called with the following arguments:
| Panel | |
destroy :
- ( Ext.Component this )
- Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
- ( Ext.Component this )
- Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
- ( Ext.Component this )
- Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
expand :
- ( Ext.Panel p )
- Fires after the Panel has been expanded. Fires after the Panel has been expanded. Listeners will be called with the following arguments:
| Panel | |
groupclick :
- ( Grid this , String groupField , String groupValue , Ext.EventObject e )
- Fires when group header is clicked. Only applies for grids with a GroupingView. Fires when group header is clicked. Only applies for grids with a GroupingView. Listeners will be called with the following arguments:
| GridPanel | |
groupcontextmenu :
- ( Grid this , String groupField , String groupValue , Ext.EventObject e )
- Fires when group header is right clicked. Only applies for grids with a GroupingView. Fires when group header is right clicked. Only applies for grids with a GroupingView. Listeners will be called with the following arguments:
| GridPanel | |
groupdblclick :
- ( Grid this , String groupField , String groupValue , Ext.EventObject e )
- Fires when group header is double clicked. Only applies for grids with a GroupingView. Fires when group header is double clicked. Only applies for grids with a GroupingView. Listeners will be called with the following arguments:
| GridPanel | |
groupmousedown :
- ( Grid this , String groupField , String groupValue , Ext.EventObject e )
- Fires before a group header is clicked. Only applies for grids with a GroupingView. Fires before a group header is clicked. Only applies for grids with a GroupingView. Listeners will be called with the following arguments:
| GridPanel | |
headerclick :
- ( Grid this , Number columnIndex , Ext.EventObject e )
- Fires when a header is clicked Fires when a header is clicked Listeners will be called with the following arguments:
| GridPanel | |
headercontextmenu :
- ( Grid this , Number columnIndex , Ext.EventObject e )
- Fires when a header is right clicked Fires when a header is right clicked Listeners will be called with the following arguments:
| GridPanel | |
headerdblclick :
- ( Grid this , Number columnIndex , Ext.EventObject e )
- Fires when a header cell is double clicked Fires when a header cell is double clicked Listeners will be called with the following arguments:
| GridPanel | |
headermousedown :
- ( Grid this , Number columnIndex , Ext.EventObject e )
- Fires before a header is clicked Fires before a header is clicked Listeners will be called with the following arguments:
| GridPanel | |
hide :
- ( Ext.Component this )
- Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
-Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
iconchange :
- ( Ext.Panel p , String The , String The )
- Fires after the Panel icon class has been set or changed. Fires after the Panel icon class has been set or changed. Listeners will be called with the following arguments:
| Panel | |
keydown :
- ( Ext.EventObject e )
- The raw keydown event for the entire grid. The raw keydown event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
keypress :
- ( Ext.EventObject e )
- The raw keypress event for the entire grid. The raw keypress event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
mousedown :
- ( Ext.EventObject e )
- The raw mousedown event for the entire grid. The raw mousedown event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
mouseout :
- ( Ext.EventObject e )
- The raw mouseout event for the entire grid. The raw mouseout event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
mouseover :
- ( Ext.EventObject e )
- The raw mouseover event for the entire grid. The raw mouseover event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
mouseup :
- ( Ext.EventObject e )
- The raw mouseup event for the entire grid. The raw mouseup event for the entire grid. Listeners will be called with the following arguments:
| GridPanel | |
move :
- ( Ext.Component this , Number x , Number y )
- Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
reconfigure :
- ( Grid this , Ext.data.Store store , Ext.grid.ColumnModel colModel )
- Fires when the grid is reconfigured with a new store and/or column model. Fires when the grid is reconfigured with a new store and/or column model. Listeners will be called with the following arguments:
| GridPanel | |
removed :
- ( Ext.Component this , Ext.Container ownerCt )
- Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
- ( Ext.Component this )
- Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
- ( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
- Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
rowbodyclick :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when the row body is clicked. Only applies for grids with enableRowBody configured. Fires when the row body is clicked. Only applies for grids with enableRowBody configured. Listeners will be called with the following arguments:
| GridPanel | |
rowbodycontextmenu :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when the row body is right clicked. Only applies for grids with enableRowBody configured. Fires when the row body is right clicked. Only applies for grids with enableRowBody configured. Listeners will be called with the following arguments:
| GridPanel | |
rowbodydblclick :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when the row body is double clicked. Only applies for grids with enableRowBody configured. Fires when the row body is double clicked. Only applies for grids with enableRowBody configured. Listeners will be called with the following arguments:
| GridPanel | |
rowbodymousedown :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires before the row body is clicked. Only applies for grids with enableRowBody configured. Fires before the row body is clicked. Only applies for grids with enableRowBody configured. Listeners will be called with the following arguments:
| GridPanel | |
rowclick :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when a row is clicked Fires when a row is clicked Listeners will be called with the following arguments:
| GridPanel | |
rowcontextmenu :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when a row is right clicked Fires when a row is right clicked Listeners will be called with the following arguments:
| GridPanel | |
rowdblclick :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires when a row is double clicked Fires when a row is double clicked Listeners will be called with the following arguments:
| GridPanel | |
rowmousedown :
- ( Grid this , Number rowIndex , Ext.EventObject e )
- Fires before a row is clicked Fires before a row is clicked Listeners will be called with the following arguments:
| GridPanel | |
show :
- ( Ext.Component this )
- Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
sortchange :
- ( Grid this , Object sortInfo )
- Fires when the grid's store sort changes Fires when the grid's store sort changes Listeners will be called with the following arguments:
| GridPanel | |
staterestore :
- ( Ext.Component this , Object state )
- Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
- ( Ext.Component this , Object state )
- Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments:
| Component | |
titlechange :
- ( Ext.Panel p , String The )
- | Panel | |
validateedit :
- ( Object e )
- Fires after a cell is edited, but before the value is set in the record. Return false
-to cancel the change. The edit ... Fires after a cell is edited, but before the value is set in the record. Return false
-to cancel the change. The edit event object has the following properties -
Listeners will be called with the following arguments:
| EditorGridPanel | |
viewready :
- ( Grid this )
- Fires when the grid view is available (use this for selecting a default row). Fires when the grid view is available (use this for selecting a default row). Listeners will be called with the following arguments:
| GridPanel |