Observable Component BoxComponent Container Panel GridPanel EditorGridPanel PropertyGrid
Package: | Ext.grid |
Defined In: | PropertyGrid.js |
Class: | PropertyGrid |
Extends: | EditorGridPanel |
var grid = new Ext.grid.PropertyGrid({
title: 'Properties Grid',
autoHeight: true,
width: 300,
renderTo: 'grid-ct',
source: {
"(name)": "My Object",
"Created": new Date(Date.parse('10/15/2006')),
"Available": false,
"Version": .01,
"Description": "A test object"
}
});
Config Options | Defined By | |
---|---|---|
enableDragDrop : Boolean True to enable dragging of the selected rows of the GridPanel. Setting this to true causes this GridPanel's GridView ...
True to enable dragging of the selected rows of the GridPanel.
Setting this to true causes this GridPanel's GridView to create an instance of Ext.grid.GridDragZone. 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 | |
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 id can not be 0.
|
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. Note: although many components inherit this config option, not ...
True to use height:'auto', false to use fixed height. Note: although many components inherit this config option, not all will function as expected with a height of 'auto'. (defaults to false).
|
BoxComponent | |
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').
|
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.
|
Panel | |
border : Boolean True to display the borders of the panel's body element, false to hide them (defaults to true). By default, the borde...
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 | |
buttonAlign : String
The alignment of any buttons added to this panel. Valid values are 'right,' 'left' and 'center' (defaults to 'right').
|
Panel | |
buttons : Array
An array of Ext.Buttons or Ext.Button configs used to add buttons to the footer of this panel.
|
Panel | |
clicksToEdit : Number
The number of clicks on a cell required to display the cell's editor (defaults to 2)
|
EditorGridPanel | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for a...
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 : Boolean
True 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 | |
columns : Array
An array of columns to auto create a ColumnModel
|
GridPanel | |
ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for...
An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
|
Component | |
customEditors : Object An object containing name/value pairs of custom editor type definitions that allow the grid to support additional typ...
An object containing name/value pairs of custom editor type definitions that allow the grid to support additional types of editable fields. By default, the grid supports strongly-typed editing of strings, dates, numbers and booleans using built-in form editors, but any custom type can be supported and associated with a custom input control by specifying a custom editor. The name of the editor type should correspond with the name of the property that will use the editor. Example usage:
|
PropertyGrid | |
deferRowRender : Boolean
True to enable deferred row rendering. Default is true.
|
GridPanel | |
disableSelection : Boolean
True to disable selections in the grid (defaults to false). - ignored if a SelectionModel is specified
|
GridPanel | |
disabled : Boolean
Render this component disabled (default is false).
|
Component | |
draggable : Boolean True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD conf...
True to enable dragging of this Panel (defaults to false). For custom drag/drop implementations, an Ext.Panel.DD config could also be passed in this config instead of true. Ext.Panel.DD is an internal, undocumented class which moves a proxy Element around in place of the Panel's element, but provides no other behaviour during dragging or on drop. It is a subclass of Ext.dd.DragSource, so behaviour may be added by implementing the interface methods of Ext.dd.DragDrop eg: |
Panel | |
enableColumnHide : Boolean
True to enable hiding of columns with the header context menu.
|
GridPanel | |
enableColumnMove : Boolean
True to enable drag and drop reorder of columns.
|
GridPanel | |
enableColumnResize : Boolean
False to turn off column resizing for the whole grid (defaults to true).
|
GridPanel | |
enableHdMenu : Boolean
True to enable the drop down button for menu in the headers.
|
GridPanel | |
floating : Boolean True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where i...
True to float the panel (absolute position it with automatic shimming and shadow), false to display it inline where it is rendered (defaults to false). Note that by default, setting floating to true will cause the panel to display at negative offsets so that it is hidden -- because the panel is absolute positioned, the position must be set explicitly after render (e.g., myPanel.setPosition(100,100);). Also, when floating a panel you should always assign a fixed width, otherwise it will be auto width and will expand to fill to the right edge of the viewport.
|
Panel | |
footer : Boolean True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if...
True to create the footer element explicitly, false to skip creating it. By default, when footer is not specified, if one or more buttons have been added to the panel the footer will be created automatically, otherwise it will not.
|
Panel | |
frame : Boolean
True to render the panel with custom rounded borders, false to render with plain 1px square borders (defaults to false).
|
Panel | |
header : Boolean True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if...
True to create the header element explicitly, false to skip creating it. By default, when header is not specified, if a title is set the header will be created automatically, otherwise it will not. If a title is set but header is explicitly set to false, the header will not be rendered.
|
Panel | |
headerAsText : Boolean
True to display the panel title in the header, false to hide it (defaults to true).
|
Panel | |
height : Number
The height of this component in pixels (defaults to auto).
|
BoxComponent | |
Render this component hidden (default is false).
|
hidden : Boolean Component | |
hideCollapseTool : Boolean
True 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 | |
hideMode : String How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
|
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 A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom ic...
A CSS class that will provide a background image to be used as the header icon (defaults to ''). An example custom icon class would be something like: .my-icon { background: url(../images/my-icon.gif) 0 6px no-repeat !important;}
|
Panel | |
id : String
The unique id of this component (defaults to an auto-assigned id).
|
Component | |
keys : Object/Array A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this pa...
A KeyMap config object (in the format expected by Ext.KeyMap.addBinding used to assign custom key handling to this panel (defaults to null).
|
Panel | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
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.
|
Observable | |
loadMask : Object
An Ext.LoadMask config or true to mask the grid while loading (defaults to false).
|
GridPanel | |
maskDisabled : Boolean True to mask the panel when it is disabled, false to not mask it (defaults to true). Either way, the panel will alway...
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 | |
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 v...
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 | |
renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using...
The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.
|
Component | |
selModel : Object Any subclass of AbstractSelectionModel that will provide the selection model for the grid (defaults to Ext.grid.RowSe...
Any subclass of AbstractSelectionModel that will provide the selection model for the grid (defaults to Ext.grid.RowSelectionModel if not specified).
|
GridPanel | |
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 | |
source : Object
A data object to use as the data source of the grid (see setSource for details).
|
PropertyGrid | |
stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be...
An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and restoring Component state. |
Component | |
stateId : String The unique id for this component to use for state management purposes (defaults to the component id). See stateful fo...
The unique id for this component to use for state management purposes (defaults to the component id).
See stateful for an explanation of saving and restoring Component state. |
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.
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: Components attempt to save state when one of the events listed in the stateEvents configuration fires. 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.
|
GridPanel | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.app...
A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.Element.applyStyles.
|
Component | |
tabTip : String Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must...
Adds a tooltip when mousing over the tab of a Ext.Panel which is an item of a Ext.TabPanel. Ext.QuickTips.init() must be called in order for the tips to render.
|
Panel | |
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.
|
Panel | |
title : String The title text to display in the panel header (defaults to ''). When a title is specified the header element will aut...
The title text 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 don't 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).
|
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. |
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.GridView...
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.
|
GridPanel | |
width : Number
The width of this component in pixels (defaults to auto).
|
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. |
Panel | |
buttons : Array
This Panel's Array of buttons as created from the buttons
config property. 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 | |
ddText : String
Configures the text in the drag proxy (defaults to "{0} selected row(s)").
{0} is replaced with the number of select...
Configures the text in the drag proxy (defaults to "{0} selected row(s)").
{0} is replaced with the number of selected rows.
|
GridPanel | |
footer : Ext.Element | Panel | |
header : Ext.Element | Panel | |
True if this component is hidden. Read-only.
|
hidden : Boolean Component | |
initialConfig : Object
This Component's initial configuration specification. Read-only.
|
Component | |
ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a...
The component's owner Ext.Container (defaults to undefined, and is set automatically when
the component is added to a container). Read-only.
|
Component | |
rendered : Boolean
True if this component has been rendered. Read-only.
|
Component |
Method | Defined By | |
---|---|---|
PropertyGrid( Object config )
Parameters:
|
PropertyGrid | |
addButton( String/Object config , Function handler , Object scope ) : Ext.Button Adds 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 ) : void Adds a CSS class to the component's underlying element.
Adds a CSS class to the component's underlying element.
Parameters:
|
Component | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
bubble( Function fn , [Object scope ], [Array args ] ) : void Bubbles 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 | |
cloneConfig( Object overrides ) : Ext.Component Clone 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.Panel Collapses 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 | |
expand( Boolean animate ) : Ext.Panel Expands 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 fcn , [Object scope ] ) : Array Find 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. The passed function is called with the arguments (container, this component).
Parameters:
|
Component | |
findParentByType( String/Class xtype ) : Container Find 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 ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
focus( [Boolean selectText ], [Boolean/Number delay ] ) : Ext.Component Try to focus this component.
Try to focus this component.
Parameters:
|
Component | |
getBottomToolbar() : Ext.Toolbar Returns the toolbar from the bottom (bbar) section of the panel.
Returns the toolbar from the bottom (bbar) section of the panel.
Parameters:
|
Panel | |
getBox( [Boolean local ] ) : Object Gets the current box measurements of the component's underlying element.
Gets the current box measurements of the component's underlying element.
Parameters:
|
BoxComponent | |
getColumnModel() : 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 underlying Ext.Element.
Returns the underlying Ext.Element.
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 | |
getId() : String Returns the id of this component.
Returns the id of this component.
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 Returns the item id of this component.
Returns the item id of this component.
Parameters:
|
Component | |
getPosition( [Boolean local ] ) : Array Gets the current XY position of the component's underlying element.
Gets the current XY position of the component's underlying element.
Parameters:
|
BoxComponent | |
getSelectionModel() : SelectionModel Returns the grid's SelectionModel.
Returns the grid's SelectionModel.
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 | |
getSource() : Object Gets the source data object containing the property data. See setSource for details regarding the
format of the data...
Gets the source data object containing the property data. See setSource for details regarding the
format of the data object.
Parameters:
|
PropertyGrid | |
getStore() : DataSource Returns the grid's data store.
Returns the grid's data store.
Parameters:
|
GridPanel | |
getTopToolbar() : Ext.Toolbar Returns the toolbar from the top (tbar) section of the panel.
Returns the toolbar from the top (tbar) section of the panel.
Parameters:
|
Panel | |
getView() : GridView Returns the grid's GridView object.
Returns the grid's GridView object.
Parameters:
|
GridPanel | |
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 ) : Boolean Checks 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.
Hide this component.
Parameters:
|
Component | |
isVisible() : void Returns true if this component is visible.
Returns true if this component is visible.
Parameters:
|
Component | |
isXType( String xtype , [Boolean shallow ] ) : void Tests 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 | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
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 ) : void Reconfigures the grid to use a different Store and Column Model.
The View will be bound to the new objects and refres...
Reconfigures the grid to use a different Store and Column Model.
The View will be bound to the new objects and refreshed.
Parameters:
|
GridPanel | |
relayEvents( Object o , Array events ) : void Relays 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 | |
removeClass( string cls ) : void Removes 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 ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
render( [Element/HTMLElement/String container ], [String/Number position ] ) : void Render this Components into the passed HTML element.
If you are using a Container object to house this Component, the...
Render this Components 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 nothnig 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)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
setHeight( Number height ) : Ext.BoxComponent
|
BoxComponent | |
setIconClass( String cls ) : void Sets 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.
Parameters:
|
Panel | |
setPagePosition( Number x , Number y ) : Ext.BoxComponent Sets 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.BoxComponent Sets 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( Number/Object width , Number height ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept
either width...
Sets the width and height of the component. This method fires the resize event. This method can accept
either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
Parameters:
|
BoxComponent | |
setSource( Object source ) : void Sets the source data object containing the property data. The data object can contain one or more name/value
pairs r...
Sets the source data object containing the property data. The data object can contain one or more name/value
pairs representing all of the properties of an object to display in the grid, and this data will automatically
be loaded into the grid's store. The values should be supplied in the proper data type if needed,
otherwise string type will be assumed. If the grid already contains data, this method will replace any
existing data. See also the source config value. Example usage:
Parameters:
|
PropertyGrid | |
setTitle( String title , [String iconCls ] ) : void Sets the title text for the panel and optionally the icon class.
Sets the title text for the panel and optionally the icon class.
Parameters:
|
Panel | |
setVisible( Boolean visible ) : Ext.Component Convenience 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.BoxComponent
|
BoxComponent | |
show() : Ext.Component Show this component.
Show this component.
Parameters:
|
Component | |
startEditing( Number rowIndex , Number colIndex ) : void Starts editing the specified for the specified row/column
Starts editing the specified for the specified row/column
Parameters:
|
EditorGridPanel | |
stopEditing( [Boolean cancel ] ) : void Stops any active editing
Stops any active editing
Parameters:
|
EditorGridPanel | |
suspendEvents() : void Suspend 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.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 ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable | |
updateBox( Object box ) : Ext.BoxComponent Sets 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 | |
add : ( Ext.Container this , Ext.Component component , Number index ) Fires after any Ext.Component is added or inserted into the container.
Fires after any Ext.Component is added or inserted into the container.
Listeners will be called with the following arguments:
|
Container | |
afteredit : ( Object e ) Fires after a cell is edited.
grid - This grid
record - The record being edited
field - The field name being edited...
Fires after a cell is edited.
Listeners will be called with the following arguments:
|
EditorGridPanel | |
afterlayout : ( Ext.Container this , ContainerLayout layout ) Fires when the components in this container are arranged by the associated layout manager.
Fires when the components in this container are arranged by the associated layout manager.
Listeners will be called with the following arguments:
|
Container | |
beforeadd : ( Ext.Container this , Ext.Component component , Number index ) Fires before any Ext.Component is added or inserted into the container.
A handler can return false to cancel the add.
Fires before any Ext.Component is added or inserted into the container.
A handler can return false to cancel the add.
Listeners will be called with the following arguments:
|
Container | |
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). 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 ) Fires before the component is destroyed. Return false to stop the destroy.
Fires before the component is destroyed. Return false to stop the destroy.
Listeners will be called with the following arguments:
|
Component | |
beforeedit : ( Object e ) Fires before cell editing is triggered. The edit event object has the following properties
grid - This grid
record ...
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. Return false to stop the hide.
Fires before the component is hidden. Return false to stop the hide.
Listeners will be called with the following arguments:
|
Component | |
beforepropertychange : ( Object source , String recordId , Mixed value , Mixed oldValue ) Fires before a property value changes. Handlers can return false to cancel the property change
(this will internally...
Fires before a property value changes. Handlers can return false to cancel the property change
(this will internally call Ext.data.Record.reject on the property's record).
Listeners will be called with the following arguments:
|
PropertyGrid | |
beforeremove : ( Ext.Container this , Ext.Component component ) Fires before any Ext.Component is removed from the container. A handler can return
false to cancel the remove.
Fires before any Ext.Component is removed from the container. A handler can return
false to cancel the remove.
Listeners will be called with the following arguments:
|
Container | |
beforerender : ( Ext.Component this ) Fires before the component is rendered. Return false to stop the render.
Fires before the component is rendered. Return false to stop the render.
Listeners will be called with the following arguments:
|
Component | |
beforeshow : ( Ext.Component this ) Fires before the component is shown. Return false to stop the show.
Fires before the component is shown. Return false 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 to stop the restore.
Fires before the state of the component is restored. Return false 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 the ...
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).
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 | |
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 | |
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.
Listeners will be called with the following arguments:
|
Component | |
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 | |
propertychange : ( Object source , String recordId , Mixed value , Mixed oldValue ) Fires after a property value has changed.
Fires after a property value has changed.
Listeners will be called with the following arguments:
|
PropertyGrid | |
remove : ( Ext.Container this , Ext.Component component ) Fires after any Ext.Component is removed from the container.
Fires after any Ext.Component is removed from the container.
Listeners will be called with the following arguments:
|
Container | |
render : ( Ext.Component this ) Fires after the component is rendered.
Fires after the component 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 | |
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.
Fires after the component is shown.
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 ) Fires after the Panel title has been set or changed.
Fires after the Panel title has been set or changed.
Listeners will be called with the following arguments:
|
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 |