X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..6b044c28b5f26fb99c86c237ffad19741c0f7f3d:/docs/output/Ext.list.ListView.html diff --git a/docs/output/Ext.list.ListView.html b/docs/output/Ext.list.ListView.html index 14a47520..12ddb87c 100644 --- a/docs/output/Ext.list.ListView.html +++ b/docs/output/Ext.list.ListView.html @@ -1,82 +1,86 @@ -
Observable Component BoxComponent DataView ListView
Package: | Ext.list |
Defined In: | ListView.js |
Class: | ListView |
Extends: | DataView |
Ext.list.ListView is a fast and light-weight implentation of a -Grid like view with the following characteristics:
-Example usage:
-// consume JSON of this form:
-{
- "images":[
- {
- "name":"dance_fever.jpg",
- "size":2067,
- "lastmod":1236974993000,
- "url":"images\/thumbs\/dance_fever.jpg"
- },
- {
- "name":"zack_sink.jpg",
- "size":2303,
- "lastmod":1236974993000,
- "url":"images\/thumbs\/zack_sink.jpg"
- }
- ]
-}
-var store = new Ext.data.JsonStore({
- url: 'get-images.php',
- root: 'images',
- fields: [
- 'name', 'url',
- {name:'size', type: 'float'},
- {name:'lastmod', type:'date', dateFormat:'timestamp'}
- ]
-});
-store.load();
-
-var listView = new Ext.list.ListView({
- store: store,
- multiSelect: true,
- emptyText: 'No images to display',
- reserveScrollOffset: true,
- columns: [{
- header: 'File',
- width: .5,
- dataIndex: 'name'
- },{
- header: 'Last Modified',
- width: .35,
- dataIndex: 'lastmod',
- tpl: '{lastmod:date("m-d h:i a")}'
- },{
- header: 'Size',
- dataIndex: 'size',
- tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
- align: 'right'
- }]
-});
-
-// put it in a Panel so it looks pretty
-var panel = new Ext.Panel({
- id:'images-view',
- width:425,
- height:250,
- collapsible:true,
- layout:'fit',
- title:'Simple ListView (0 items selected)',
- items: listView
-});
-panel.render(document.body);
-
-// little bit of feedback
-listView.on('selectionchange', function(view, nodes){
- var l = nodes.length;
- var s = l != 1 ? 's' : '';
- panel.setTitle('Simple ListView ('+l+' item'+s+' selected)');
+Observable
+ Component
+ BoxComponent
+ DataView
+ ListView
Class Ext.list.ListView
Package: Ext.list Defined In: ListView.js Class: ListView Extends: DataView
Ext.list.ListView is a fast and light-weight implentation of a
+Grid like view with the following characteristics:
+
+- resizable columns
+- selectable
+- column widths are initially proportioned by percentage based on the container
+width and number of columns
+- uses templates to render the data in any required format
+- no horizontal scrolling
+- no editing
+
+Example usage:
+// consume JSON of this form:
+{
+ "images":[
+ {
+ "name":"dance_fever.jpg",
+ "size":2067,
+ "lastmod":1236974993000,
+ "url":"images\/thumbs\/dance_fever.jpg"
+ },
+ {
+ "name":"zack_sink.jpg",
+ "size":2303,
+ "lastmod":1236974993000,
+ "url":"images\/thumbs\/zack_sink.jpg"
+ }
+ ]
+}
+var store = new Ext.data.JsonStore({
+ url: 'get-images.php',
+ root: 'images',
+ fields: [
+ 'name', 'url',
+ {name:'size', type: 'float'},
+ {name:'lastmod', type:'date', dateFormat:'timestamp'}
+ ]
+});
+store.load();
+
+var listView = new Ext.list.ListView({
+ store: store,
+ multiSelect: true,
+ emptyText: 'No images to display',
+ reserveScrollOffset: true,
+ columns: [{
+ header: 'File',
+ width: .5,
+ dataIndex: 'name'
+ },{
+ header: 'Last Modified',
+ width: .35,
+ dataIndex: 'lastmod',
+ tpl: '{lastmod:date("m-d h:i a")}'
+ },{
+ header: 'Size',
+ dataIndex: 'size',
+ tpl: '{size:fileSize}', // format using Ext.util.Format.fileSize()
+ align: 'right'
+ }]
+});
+
+// put it in a Panel so it looks pretty
+var panel = new Ext.Panel({
+ id:'images-view',
+ width:425,
+ height:250,
+ collapsible:true,
+ layout:'fit',
+ title:'Simple ListView (0 items selected)',
+ items: listView
+});
+panel.render(document.body);
+
+// little bit of feedback
+listView.on('selectionchange', function(view, nodes){
+ var l = nodes.length;
+ var s = l != 1 ? 's' : '';
+ panel.setTitle('Simple ListView ('+l+' item'+s+' selected)');
});
Config Options
Config Options Defined By allowDomMove : BooleanWhether the component can move the Dom node when rendering (defaults to true). Component anchor : StringNote: 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 (or subclass thereof).
@@ -193,7 +197,9 @@ child items when the browser changes its width:
var myPanel = <
}, {
title: 'Box 3'
}],
-});
BoxComponent boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+}); BoxComponent blockRefresh : BooleanSet this to true to ignore datachanged events on the bound store. This is useful if
+you wish to provide custom transi...Set this to true to ignore datachanged events on the bound store. This is useful if
+you wish to provide custom transition animations via a plugin (defaults to false) DataView boxMaxHeight : NumberThe 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 : NumberThe 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.
@@ -201,7 +207,10 @@ Warning: This will override any size manag...The maxi
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 : NumberThe 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 clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+Warning: This will override any size management applied by layout managers.
BoxComponent bubbleEvents : ArrayAn 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 [].
Component clearCls : StringThe 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').
@@ -211,39 +220,39 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.
See Ext.layout.FormLayout.fieldTpl also.
Component cls : StringAn 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 columnResize : Boolean/ObjectSpecify true or specify a configuration object for Ext.list.ListView.ColumnResizer
-to enable the columns to be resiz...Specify true or specify a configuration object for Ext.list.ListView.ColumnResizer
-to enable the columns to be resizable (defaults to true). ListView columnSort : Boolean/ObjectSpecify true or specify a configuration object for Ext.list.ListView.Sorter
-to enable the columns to be sortable (de...Specify true or specify a configuration object for Ext.list.ListView.Sorter
-to enable the columns to be sortable (defaults to true). ListView columns : ArrayAn array of column configuration objects, for example:
-{
- align: 'right',
- dataIndex: 'size',
- header: '...An array of column configuration objects, for example:
-{
- align: 'right',
- dataIndex: 'size',
- header: 'Size',
- tpl: '{size:fileSize}',
- width: .35
-}
-Acceptable properties for each column configuration object are:
-
-- align : StringSet the CSS text-align property
-of the column. Defaults to 'left'.
-- dataIndex : StringSee Ext.grid.Column.
-dataIndex for details.
-- header : StringSee Ext.grid.Column.
-header for details.
-- tpl : StringSpecify a string to pass as the
-configuration string for Ext.XTemplate. By default an Ext.XTemplate
-will be implicitly created using the dataIndex.
-- width : NumberPercentage of the container width
-this column should be allocated. Columns that have no width specified will be
-allocated with an equal percentage to fill 100% of the container width. To easily take
-advantage of the full container width, leave the width of at least one column undefined.
-Note that if you do not want to take up the full width of the container, the width of
-every column needs to be explicitly defined.
+useful for adding customized styles to the component or any of its children using standard CSS rules.
Component columnResize : Boolean/ObjectSpecify true or specify a configuration object for Ext.list.ListView.ColumnResizer
+to enable the columns to be resiza...Specify true or specify a configuration object for Ext.list.ListView.ColumnResizer
+to enable the columns to be resizable (defaults to true). ListView columnSort : Boolean/ObjectSpecify true or specify a configuration object for Ext.list.ListView.Sorter
+to enable the columns to be sortable (def...Specify true or specify a configuration object for Ext.list.ListView.Sorter
+to enable the columns to be sortable (defaults to true). ListView columns : ArrayAn array of column configuration objects, for example:
+{
+ align: 'right',
+ dataIndex: 'size',
+ header: 'Size...An array of column configuration objects, for example:
+{
+ align: 'right',
+ dataIndex: 'size',
+ header: 'Size',
+ tpl: '{size:fileSize}',
+ width: .35
+}
+Acceptable properties for each column configuration object are:
+
+- align : StringSet the CSS text-align property
+of the column. Defaults to 'left'.
+- dataIndex : StringSee Ext.grid.Column.
+dataIndex for details.
+- header : StringSee Ext.grid.Column.
+header for details.
+- tpl : StringSpecify a string to pass as the
+configuration string for Ext.XTemplate. By default an Ext.XTemplate
+will be implicitly created using the dataIndex.
+- width : NumberPercentage of the container width
+this column should be allocated. Columns that have no width specified will be
+allocated with an equal percentage to fill 100% of the container width. To easily take
+advantage of the full container width, leave the width of at least one column undefined.
+Note that if you do not want to take up the full width of the container, the width of
+every column needs to be explicitly defined.
ListView contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
for this comp...Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
for this component.
@@ -293,7 +302,7 @@ compared to the sum of all Components with flex value specified. An
either a flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
BoxComponent height : NumberThe 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 : BooleanRender this component hidden (default is false). If true, the
-hide method will be called internally. Component hideHeaders : Booleantrue to hide the header row (defaults to false so
+hide method will be called internally. Component hideHeaders : Booleantrue to hide the header row (defaults to false so
the header row will be shown). ListView hideLabel : Booleantrue 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
@@ -390,9 +399,9 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
-Note: to access the container of an item see ownerCt.
Component itemSelector : StringDefaults to 'dl' to work with the preconfigured tpl.
-This setting specifies the CSS selector (e.g. div.some-class or... Component itemSelector : StringDefaults to 'dl' to work with the preconfigured tpl.
+This setting specifies the CSS selector (e.g. div.some-class or ...Defaults to 'dl' to work with the preconfigured tpl.
+This setting specifies the CSS selector (e.g. div.some-class or span:first-child)
that will be used to determine what nodes the ListView will be working with. ListView labelSeparator : StringThe 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
@@ -518,10 +527,10 @@ to the second, and the bottom is set to the third.
Defaults to:
{top:0, right:0, bottom:0, left:0}
BoxComponent multiSelect : BooleanTrue to allow selection of more than one item at a time, false to allow selection of only a single item
at a time or ...True to allow selection of more than one item at a time, false to allow selection of only a single item
-at a time or no selection at all, depending on the value of singleSelect (defaults to false). DataView overClass : StringThe CSS class applied when over a row (defaults to
-'x-list-over'). An example overriding the default styling:
- ....The CSS class applied when over a row (defaults to
-'x-list-over'). An example overriding the default styling:
+at a time or no selection at all, depending on the value of singleSelect (defaults to false). DataView overClass : StringThe CSS class applied when over a row (defaults to
+'x-list-over'). An example overriding the default styling:
+ .x-...The CSS class applied when over a row (defaults to
+'x-list-over'). An example overriding the default styling:
.x-list-over {background-color: orange;}
ListView overCls : StringAn 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
@@ -579,15 +588,16 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also.
Component reserveScrollOffset : BooleanBy default will defer accounting for the configured scrollOffset
-for 10 milliseconds. Specify true to account for t...By default will defer accounting for the configured scrollOffset
-for 10 milliseconds. Specify true to account for the configured
-scrollOffset immediately. ListView scrollOffset : NumberThe amount of space to reserve for the scrollbar (defaults to
-undefined). If an explicit value isn't specified, this...The amount of space to reserve for the scrollbar (defaults to
-undefined). If an explicit value isn't specified, this will be automatically
-calculated. ListView selectedClass : StringThe CSS class applied to a selected row (defaults to
-'x-list-selected'). An example overriding the default styling:
...The CSS class applied to a selected row (defaults to
-'x-list-selected'). An example overriding the default styling:
+See render also.
Component reserveScrollOffset : BooleanBy default will defer accounting for the configured scrollOffset
+for 10 milliseconds. Specify true to account for th...By default will defer accounting for the configured scrollOffset
+for 10 milliseconds. Specify true to account for the configured
+scrollOffset immediately. ListView scrollOffset : NumberThe amount of space to reserve for the scrollbar (defaults to
+undefined). If an explicit value isn't specified, this ...The amount of space to reserve for the scrollbar (defaults to
+undefined). If an explicit value isn't specified, this will be automatically
+calculated. ListView selectedClass : StringThe CSS class applied to a selected row (defaults to
+'x-list-selected'). An example overriding the default styling:
+ ...The CSS class applied to a selected row (defaults to
+'x-list-selected'). An example overriding the default styling:
.x-list-selected {background-color: yellow;}
ListView simpleSelect : BooleanTrue to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl,
false t...True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl,
false to force the user to hold Ctrl or Shift to select more than on item (defaults to false). DataView singleSelect : BooleanTrue to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false).
@@ -685,7 +695,7 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By disableHeaders : BooleanSet this property to true to disable the header click handler disabling sort
+take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By disableHeaders : BooleanSet this property to true to disable the header click handler disabling sort
(defaults to false). ListView disabled : BooleanTrue if this component is disabled. Read-only. Component el : Ext.ElementThe 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
@@ -770,25 +780,30 @@ Or a shorthand syntax:
:
void
Apply this component to existing markup that is valid. With this function, no call to render() is required.Apply this component to existing markup that is valid. With this function, no call to render() is required.Parameters:el
: String/HTMLElement
Returns:- void
Component bindStore( Store store
)
:
- voidChanges the data store bound to this view and refreshes it.Changes the data store bound to this view and refreshes it.Parameters:store
: StoreThe store to bind to this view
Returns:- void
DataView clearSelections( [Boolean suppressEvent
] )
+ voidChanges the data store bound to this view and refreshes it.Changes the data store bound to this view and refreshes it.Parameters:store
: StoreThe store to bind to this view
Returns:- void
DataView bubble( Function fn
, [Object scope
], [Array args
] )
+ :
+ Ext.ComponentBubbles 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:fn
: FunctionThe function to callscope
: Object(optional) The scope of the function (defaults to current node)args
: Array(optional) The args to call the function with (default to passing the current component)
Returns:Ext.Component
this
Component clearSelections( [Boolean suppressEvent
] )
:
voidClears all selections.Clears all selections.Parameters:suppressEvent
: Boolean(optional) True to skip firing of the selectionchange event
Returns:- void
DataView 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:overrides
: ObjectA new config containing any properties to override in the cloned version.
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.
Returns:Ext.Component
clone The cloned copy of this component
Component collectData( Array records
, Number startIndex
)
:
- ObjectFunction which can be overridden which returns the data object passed to this
-view's template to render the whole Li...Function which can be overridden which returns the data object passed to this
-view's template to render the whole ListView. The returned object
-shall contain the following properties:
-
-- columns : StringSee columns
-- rows : StringSee
-Ext.DataView.collectData
-
Parameters:records
: ArrayAn Array of Ext.data.Records to be rendered into the DataView.startIndex
: Numberthe index number of the Record being prepared for rendering.
Returns:Object
A data object containing properties to be processed by a repeating
-XTemplate as described above.
ListView deselect( HTMLElement/Number node
)
+ ObjectFunction which can be overridden which returns the data object passed to this
+view's template to render the whole Lis...Function which can be overridden which returns the data object passed to this
+view's template to render the whole ListView. The returned object
+shall contain the following properties:
+
+- columns : StringSee columns
+- rows : StringSee
+Ext.DataView.collectData
+
Parameters:records
: ArrayAn Array of Ext.data.Records to be rendered into the DataView.startIndex
: Numberthe index number of the Record being prepared for rendering.
Returns:Object
A data object containing properties to be processed by a repeating
+XTemplate as described above.
ListView deselect( HTMLElement/Number/Record node
)
:
- voidDeselects a node.Deselects a node.Parameters:node
: HTMLElement/NumberThe node to deselect
Returns:- void
DataView destroy()
+ voidDeselects a node.Deselects a node.Parameters:node
: HTMLElement/Number/RecordThe node, node index or record to deselect
Returns:- void
DataView destroy()
:
voidDestroys 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,
@@ -800,47 +815,49 @@ should usually not need to be called directly.Enable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
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.getBubbleTarget()
if present. There is no implementation in the Observable base class.
-This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
-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:
Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ 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.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+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:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable findItemFromChild( HTMLElement node
)
:
HTMLElementReturns the template node the passed child belongs to, or null if it doesn't belong to one.Returns the template node the passed child belongs to, or null if it doesn't belong to one.Parameters:node
: HTMLElement
Returns:HTMLElement
The template node
DataView 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:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Class xtype
)
+true, the container will be returned.Parameters:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Ext.Component/Class xtype
, [Boolean shallow
] )
:
- Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directly
Returns:Ext.Container
The first Container which matches the given xtype or class
Component fireEvent( String eventName
, Object... args
)
+ Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class:shallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype.
Returns:Ext.Container
The first Container which matches the given xtype or class
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).
@@ -881,9 +898,10 @@ returns an id
if an id
is not defined yet:<
itemId was not assigned through configuration the
id is returned using g...
Component getNode( HTMLElement/String/Number nodeInfo
)
+id
is returned using getId
.Parameters:- None.
Returns:String
Component getNode( HTMLElement/String/Number/Ext.data.Record nodeInfo
)
:
- HTMLElementGets a template node.Gets a template node.Parameters:nodeInfo
: HTMLElement/String/NumberAn HTMLElement template node, index of a template node or the id of a template node
Returns:HTMLElement
The node or null if it wasn't found
DataView getNodes( [Number start
], [Number end
] )
+ HTMLElementGets a template node.Gets a template node.Parameters:nodeInfo
: HTMLElement/String/Number/Ext.data.RecordAn HTMLElement template node, index of a template node,
+the id of a template node or the record associated with the node.
Returns:HTMLElement
The node or null if it wasn't found
DataView getNodes( [Number start
], [Number end
] )
:
ArrayGets a range nodes.Gets a range nodes.Parameters:start
: Number(optional) The index of the first node in the rangeend
: Number(optional) The index of the last node in the range
Returns:Array
An array of nodes
DataView getOuterSize()
:
@@ -940,13 +958,14 @@ alert(t.getXTypes()); // alerts 'component/box/field/textfield'
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:- None.
Returns:Ext.Component
this
Component indexOf( HTMLElement/String/Number nodeInfo
)
+the component is configured to be hidden
.Parameters:- None.
Returns:Ext.Component
this
Component indexOf( HTMLElement/String/Number/Record nodeInfo
)
:
- NumberFinds the index of the passed node.Finds the index of the passed node.Parameters:nodeInfo
: HTMLElement/String/NumberAn HTMLElement template node, index of a template node or the id of a template node
Returns:Number
The index of the node or -1
DataView isSelected( HTMLElement/Number node
)
+ NumberFinds the index of the passed node.Finds the index of the passed node.Parameters:nodeInfo
: HTMLElement/String/Number/RecordAn HTMLElement template node, index of a template node, the id of a template node
+or a record associated with a node.
Returns:Number
The index of the node or -1
DataView isSelected( HTMLElement/Number/Ext.data.Record node
)
:
- BooleanReturns true if the passed node is selected, else false.Returns true if the passed node is selected, else false.Parameters:node
: HTMLElement/NumberThe node or node index to check
Returns:Boolean
True if selected, else false
DataView isVisible()
+ BooleanReturns true if the passed node is selected, else false.Returns true if the passed node is selected, else false.Parameters:node
: HTMLElement/Number/Ext.data.RecordThe node, node index or record to check
Returns:Boolean
True if selected, else false
DataView isVisible()
:
- BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String xtype
, [Boolean shallow
] )
+ BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String/Ext.Component/Class 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
@@ -958,7 +977,11 @@ to participate in determination of inherited xtypes.
var t = new Ext.form.TextField();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
Parameters:xtype
: StringThe xtype to check for this Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class:
+var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.Component));
shallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
the default), or true to check whether this Component is directly of the specified xtype.
Returns:Boolean
True if this component descends from the specified xtype, false otherwise.
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
@@ -1032,19 +1055,19 @@ which this component will be inserted (defaults to appending to the end of the c
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:- None.
Returns:- void
Observable select( Array/HTMLElement/String/Number nodeInfo
, [Boolean keepExisting
], [Boolean suppressEvent
] )
+events fired during event suspension will be sent to any listeners now.Parameters:- None.
Returns:- void
Observable select( Array/HTMLElement/String/Number/Ext.data.Record nodeInfo
, [Boolean keepExisting
], [Boolean suppressEvent
] )
:
- voidSelects a set of nodes.Selects a set of nodes.Parameters:nodeInfo
: Array/HTMLElement/String/NumberAn HTMLElement template node, index of a template node,
-id of a template node or an array of any of those to selectkeepExisting
: Boolean(optional) true to keep existing selectionssuppressEvent
: Boolean(optional) true to skip firing of the selectionchange vent
Returns:- void
DataView selectRange( Number start
, Number end
, [Boolean keepExisting
] )
+ voidSelects a set of nodes.Selects a set of nodes.Parameters:nodeInfo
: Array/HTMLElement/String/Number/Ext.data.RecordAn HTMLElement template node, index of a template node,
+id of a template node, record associated with a node or an array of any of those to selectkeepExisting
: Boolean(optional) true to keep existing selectionssuppressEvent
: Boolean(optional) true to skip firing of the selectionchange vent
Returns:- void
DataView selectRange( Number start
, Number end
, [Boolean keepExisting
] )
:
voidSelects a range of nodes. All nodes between start and end are selected.Selects a range of nodes. All nodes between start and end are selected.Parameters:start
: NumberThe index of the first node in the rangeend
: NumberThe index of the last node in the rangekeepExisting
: Boolean(optional) True to retain existing selections
Returns:- void
DataView 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:scroll
: BooleanTrue to allow the Component to auto scroll.
Returns:Ext.BoxComponent
this
BoxComponent setDisabled( Boolean disabled
)
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHeight( Number height
)
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHeight( Mixed 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:height
: NumberThe new height to set. This may be one of:
-- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
+ 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:height
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
Returns:Ext.BoxComponent
this
BoxComponent setPagePosition( Number x
, Number y
)
@@ -1073,10 +1096,10 @@ This may be one of:
:
voidChanges the data store bound to this view and refreshes it. (deprecated in favor of bindStore)Changes the data store bound to this view and refreshes it. (deprecated in favor of bindStore)Parameters:store
: StoreThe store to bind to this view
Returns:- void
DataView 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:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Number width
)
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed 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:width
: NumberThe new width to setThis may be one of:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+ 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:width
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
Returns:Ext.BoxComponent
this
BoxComponent show()
: