X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..c8256059947f3aa8f5b0a9a2acf55e2142bb4742:/docs/output/Ext.PagingToolbar.html diff --git a/docs/output/Ext.PagingToolbar.html b/docs/output/Ext.PagingToolbar.html index 826eea77..e74d9c5d 100644 --- a/docs/output/Ext.PagingToolbar.html +++ b/docs/output/Ext.PagingToolbar.html @@ -1,4 +1,4 @@ -
Observable Component BoxComponent Container Toolbar PagingToolbar
Package: | Ext |
Defined In: | PagingToolbar.js |
Class: | PagingToolbar |
Extends: | Toolbar |
xtype: | paging |
As the amount of records increases, the time required for the browser to render +
Observable Component BoxComponent Container Toolbar PagingToolbar
Package: | Ext |
Defined In: | PagingToolbar.js |
Class: | PagingToolbar |
Extends: | Toolbar |
As the amount of records increases, the time required for the browser to render them increases. Paging is used to reduce the amount of data exchanged with the client. Note: if there are more records/rows than can be viewed in the available screen area, vertical scrollbars will be added.
@@ -13,10 +13,14 @@ paging criteria.Ext.QuickTips.init(); // to display button quicktips
var myStore = new Ext.data.Store({
+ reader: new Ext.data.JsonReader({
+ totalProperty: 'results',
+ ...
+ }),
...
});
-var myPageSize = 25; // server script should only send back 25 items
+var myPageSize = 25; // server script should only send back 25 items at a time
var grid = new Ext.grid.GridPanel({
...
@@ -34,15 +38,33 @@ paging criteria.
To use paging, pass the paging requirements to the server when the store is first loaded.
store.load({
params: {
- start: 0, // specify params for the first page load if using paging
+ // specify params for the first page load if using paging
+ start: 0,
limit: myPageSize,
+ // other params
foo: 'bar'
}
});
+If using store's autoLoad configuration:
+var myStore = new Ext.data.Store({
+ autoLoad: {params:{start: 0, limit: 25}},
+ ...
+});
+The packet sent back from the server would have this form:
+{
+ "success": true,
+ "results": 2000,
+ "rows": [ // *Note: this must be an Array
+ { "id": 1, "name": "Bill", "occupation": "Gardener" },
+ { "id": 2, "name": "Ben", "occupation": "Horticulturalist" },
+ ...
+ { "id": 25, "name": "Sue", "occupation": "Botanist" }
+ ]
+}
Paging with Local Data
Paging can also be accomplished with local data using extensions:
-- Ext.ux.data.PagingStore
+- Ext.ux.data.PagingStore
- Paging Memory Proxy (examples/ux/PagingMemoryProxy.js)
Config Options | Defined By | |
---|---|---|
activeItem : String/Number A string component id or the numeric index of the component that should be initially activated within the
container's... A string component id or the numeric index of the component that should be initially activated within the
@@ -53,14 +75,14 @@ items one at a time (like Customizable piece of the default paging text (defaults to 'of {0}'). Note that
this string is formatted using {0} as a token that is replaced by the number of
total pages. This token should be preserved when overriding this string if showing the
-total page count is desired. | PagingToolbar | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
anchor : String Note: this config is only used when this Component is rendered
+total page count is desired. | PagingToolbar | |
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
anchor : String Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered -by a Container which has been configured to use an AnchorLayout +by a Container which has been configured to use an AnchorLayout (or subclass thereof). based layout manager, for example:
See Ext.layout.AnchorLayout.anchor also. | Component | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
+ See Ext.layout.AnchorLayout.anchor also. | BoxComponent | |
applyTo : Mixed Specify the id of the element, a DOM element or an existing Element corresponding to a DIV
that is already present in... Specify the id of the element, a DOM element or an existing Element corresponding to a DIV that is already present in the document that specifies some structural markup for this component.
| BoxComponent | |
autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+}).show(); | BoxComponent | |
autoScroll : Boolean true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false... true to use overflow:'auto' on the components layout element and show scroll bars automatically when
+necessary, false to clip any overflowing content (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 | |
autoWidth : Boolean True to use width:'auto', false to use fixed width (or allow it to be managed by its parent
Container's layout manage... True to use width:'auto', false to use fixed width (or allow it to be managed by its parent @@ -169,10 +193,25 @@ child items when the browser changes its width:
| BoxComponent | |
beforePageText : String The text displayed before the input item (defaults to 'Page'). | PagingToolbar | |
bufferResize : Boolean/Number When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
-t... When set to true (100 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+}); | BoxComponent | |
beforePageText : String The text displayed before the input item (defaults to 'Page'). | PagingToolbar | |
boxMaxHeight : Number The maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMaxWidth : Number The maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinHeight : Number The minimum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The minimum value in pixels which this BoxComponent will set its height to. +Warning: This will override any size management applied by layout managers. | BoxComponent | |
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. +Warning: This will override any size management applied by layout managers. | BoxComponent | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to | Container | |
bufferResize : Boolean/Number When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
+th... When set to true (50 milliseconds) or a number of milliseconds, the layout assigned for this container will buffer
the frequency it calculates and does a re-layout of components. This is useful for heavy containers or containers
-with a large quantity of sub-components for which frequent layout calls would be expensive. | Container | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+with a large quantity of sub-components for which frequent layout calls would be expensive. Defaults to 50 . | Container | |
buttonAlign : String The default position at which to align child items. Defaults to "left"
+May be specified as "center" to cause items ad... The default position at which to align child items. Defaults to May be specified as Specify as | Toolbar | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered directly after each form field wrapper to provide field clearing (defaults to 'x-form-clear-left'). @@ -182,7 +221,21 @@ manager (e.g. fieldLabel is specified or isFormField=true is specified.See Ext.layout.FormLayout.fieldTpl also. | Component | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
-useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
+useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
contentEl : String Optional. 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
| Component | |
ctCls : String An optional extra CSS class that will be added to this component's container. This can be useful for
adding customize... An optional extra CSS class that will be added to this component's container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. See Ext.layout.ContainerLayout.extraCls also. @@ -193,18 +246,23 @@ which assigns a value by default:
- | Component | |
defaultType : String The default xtype of child Components to create in this Container when
+ | Component | |
data : Mixed The initial set of data to apply to the tpl to
+update the content area of the Component. | Component | |
defaultType : String The default xtype of child Components to create in this Container when
a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component. -Defaults to 'panel', except Ext.menu.Menu which defaults to 'menuitem', -and Ext.Toolbar and Ext.ButtonGroup which default to 'button'. | Container | |
defaults : Object A config object that will be applied to all components added to this container either via the items
-config or via the... A config object that will be applied to all components added to this container either via the items -config or via the add or insert methods. The defaults config can contain any -number of name/value property pairs to be added to each item, and should be valid for the types of items -being added to the container. For example, to automatically apply padding to the body of each of a set of -contained Ext.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}. - Note: defaults will not be applied to config objects if the option is already specified. -For example:
| Container | |
defaults : Object|Function This option is a means of applying default settings to all added items whether added through the items
+config or via ... This option is a means of applying default settings to all added items whether added through the items +config or via the add or insert methods. +If an added item is a config object, and not an instantiated Component, then the default properties are +unconditionally applied. If the added item is an instantiated Component, then the default properties are +applied conditionally so as not to override existing properties in the item. +If the defaults option is specified as a function, then the function will be called using this Container as the
+scope ( For example, to automatically apply padding to the body of each of a set of
+contained Ext.Panel items, you could pass: Usage:
The paging status message to display (defaults to 'Displaying {0} - {1} of {2}').
Note that this string is formatted using the braced numbers {0}-{2} as tokens
that are replaced by the values for start, end and total respectively. These tokens should
-be preserved when overriding this string if showing those values is desired. | PagingToolbar | |
emptyMsg : String The message to display when no records are found (defaults to 'No data to display') | PagingToolbar | |
fieldLabel : String The label text to display next to this Component (defaults to '').
+be preserved when overriding this string if showing those values is desired. | PagingToolbar | |
emptyMsg : String The message to display when no records are found (defaults to 'No data to display') | PagingToolbar | |
enableOverflow : Boolean Defaults to false. Configure true to make the toolbar provide a button
+which activates a dropdown Menu to show items ... Defaults to false. Configure true | Toolbar | |
fieldLabel : String The label text to display next to this Component (defaults to '').
Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). Note: this config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager (e.g. @@ -237,7 +297,13 @@ Example use:
| Component | |
firstText : String The quicktip text displayed for the first page button (defaults to 'First Page').
Note: quick tips must be initialize... The quicktip text displayed for the first page button (defaults to 'First Page').
-Note: quick tips must be initialized for the quicktip to show. | PagingToolbar | |
forceLayout : Boolean If true the container will force a layout initially even if hidden or collapsed. This option
+Note: quick tips must be initialized for the quicktip to show. | PagingToolbar | |
flex : Number Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxL... Note: this config is only used when this Component is rendered
+by a Container which has been configured to use a BoxLayout.
+Each child Component with a | BoxComponent | |
forceLayout : Boolean If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing fo... If true the container will force a layout initially even if hidden or collapsed. This option
is useful for forcing forms to render in collapsed or hidden containers. (defaults to false). | Container | |
height : Number The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
@@ -268,7 +334,11 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). | Component | |
hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
-button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
id : String The unique id of this component (defaults to an auto-assigned id).
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. | Component | |
id : String The unique id of this component (defaults to an auto-assigned id).
You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.getCmp). @@ -278,8 +348,11 @@ rules to style the specific instance of this component uniquely, and also to sel sub-elements using this component's id as the parent.Note: to avoid complications imposed by a unique id also see
Note: to access the container of an item see | Component | |
itemCls : String An additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item + Note: to access the container of an item see | Component | |
itemCls : String Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which +has been configured to use the FormLayout layout manager (e.g. +Ext.form.FormPanel or specifying layout:'form'). + An additional CSS class to apply to the div wrapping the form item element of this field. If supplied, itemCls at the field level will override the default itemCls supplied at the container level. The value specified for itemCls will be added to the default class ('x-form-item'). @@ -288,22 +361,22 @@ the default itemCls supplied at the container level. The value s you to write standard CSS rules that can apply to the field, the label (if specified), or any other element within the markup for the field.Note: see the note for fieldLabel. -Example use:
| Component | |
itemId : String An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
when no object reference is available. Instead of using an
| Component | |
lastText : String The quicktip text displayed for the last page button (defaults to 'Last Page').
Note: quick tips must be initialized ... The quicktip text displayed for the last page button (defaults to 'Last Page').
-Note: quick tips must be initialized for the quicktip to show. | PagingToolbar | |
layout : String/Object This class assigns a default layout (layout:'toolbar').
-Developers may override this configuration option if another... This class assigns a default layout ( layout:'toolbar' ).
-Developers may override this configuration option if another layout
-is required (the constructor must be passed a configuration object in this
-case instead of an array).
+Note: quick tips must be initialized for the quicktip to show. | PagingToolbar | |
layout : String/Object This class assigns a default layout (layout:'toolbar').
+Developers may override this configuration option if another ... This class assigns a default layout ( layout:'toolbar' ).
+Developers may override this configuration option if another layout
+is required (the constructor must be passed a configuration object in this
+case instead of an array).
See Ext.Container.layout for additional information. | Toolbar | |
layoutConfig : Object | Container | |
listeners : Object A config object containing one or more event handlers to be added to this
@@ -520,9 +593,9 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create. If you create your own Plugins, you may register them using Ext.ComponentMgr.registerPlugin in order to be able to -take advantage of lazy instantiation and rendering. | Component | |
ref : String A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which -ancestor Container to place a named reference to this Component. +take advantage of lazy instantiation and rendering. | Component | |
ref : String A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's The ancestor axis can be traversed by using '/' characters in the path. For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:
-In the code above, if the ref had been | Component | |
refreshText : String | Component | |
refreshText : String The quicktip text displayed for the Refresh button (defaults to 'Refresh').
Note: quick tips must be initialized for ... The quicktip text displayed for the Refresh button (defaults to 'Refresh').
Note: quick tips must be initialized for the quicktip to show. | PagingToolbar | |
region : String Note: this config is only used when this BoxComponent is rendered
by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered @@ -561,7 +635,7 @@ to render and manage its child items. When using this config, a call to render() is not required.
See render also. | Component | |
stateEvents : Array An array of events that, when fired, should trigger this component to
+ See render also. | Component | |
resizeEvent : String The event to listen to for resizing in layouts. Defaults to 'resize' . | Container | |
stateEvents : Array An array of events that, when fired, should trigger this component to
save its state (defaults to none). stateEvents ... An array of events that, when fired, should trigger this component to
save its state (defaults to none). A custom style specification to be appl
}
})
]
-}); | Component | |
width : Number The width of this component in pixels (defaults to auto).
+}); | Component | |
tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. +A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over +the associated tab selector element. Ext.QuickTips.init() +must be called in order for the tips to render. | BoxComponent | |
tpl : Mixed An Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and... An data and
+tplWriteMode configurations. | Component | |
tplWriteMode : String The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X... The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite ). | Component | |
width : Number The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset se... The width of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
x : Number The local x (left) coordinate for this component if contained within a positioning container. | BoxComponent | |
xtype : String The registered xtype to create. This config option is not used when passing
a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing
@@ -664,60 +751,64 @@ config for a suggestion, or use a render listener directly:
-See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
items : MixedCollection The collection of components in this container as a Ext.util.MixedCollection | Container | |
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.
- Note: to access items within the container see itemId. | Component | |
pageSize : Number The number of records to display per page. See also cursor. | PagingToolbar | |
paramNames : Object Deprecated. paramNames should be set in the data store
+ See also getEl | Component | |
hidden : Boolean True if this component is hidden. Read-only. | Component | |
initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
items : MixedCollection The collection of components in this container as a Ext.util.MixedCollection | Container | |
ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... | Component | |
pageSize : Number The number of records to display per page. See also cursor. | PagingToolbar | |
paramNames : Object Deprecated. paramNames should be set in the data store
(see Ext.data.Store.paramNames).
Object mapping of parameter n... Deprecated. Object mapping of parameter names used for load calls, initially set to: -{start: 'start', limit: 'limit'} | PagingToolbar | |
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |||
---|---|---|---|---|
PagingToolbar( Object config )
- Create a new PagingToolbar Create a new PagingToolbar Parameters:
| PagingToolbar | |||
add( Mixed arg1 , Mixed arg2 , Mixed etc. )
- :
- voidAdds element(s) to the toolbar -- this function takes a variable number of
-arguments of mixed type and adds them to ... Adds element(s) to the toolbar -- this function takes a variable number of -arguments of mixed type and adds them to the toolbar. -Note: See the notes within Ext.Container.add. Parameters:
| PagingToolbar | |||
refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref . | Component | |||
rendered : Boolean True if this component has been rendered. Read-only. | Component |
Method | Defined By | |
---|---|---|
PagingToolbar( Object config )
+ Create a new PagingToolbar Create a new PagingToolbar Parameters:
| PagingToolbar | |
add( Mixed arg1 , Mixed arg2 , Mixed etc. )
+ :
+ voidAdds element(s) to the toolbar -- this function takes a variable number of
+arguments of mixed type and adds them to t... Adds element(s) to the toolbar -- this function takes a variable number of +arguments of mixed type and adds them to the toolbar. +Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addButton( Object/Array config )
:
- Ext.Button/ArrayAdds a button (or buttons). See Ext.Button for more info on the config.
-Note: See the notes within Ext.Container.add... Adds a button (or buttons). See Ext.Button for more info on the config.
+ Ext.Button/Array Adds a button (or buttons). See Ext.Button for more info on the config.
+Note: See the notes within Ext.Container.add. Adds a button (or buttons). See Ext.Button for more info on the config.
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addClass( string cls )
:
Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addDom( Object config )
:
- Ext.Toolbar.ItemAdds a new element to the toolbar from the passed Ext.DomHelper config
-Note: See the notes within Ext.Container.add. Adds a new element to the toolbar from the passed Ext.DomHelper config
+ Ext.Toolbar.Item Adds a new element to the toolbar from the passed Ext.DomHelper config
+Note: See the notes within Ext.Container.add. Adds a new element to the toolbar from the passed Ext.DomHelper config
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addElement( Mixed el )
:
- Ext.Toolbar.ItemAdds any standard HTML element to the toolbar
-Note: See the notes within Ext.Container.add. Adds any standard HTML element to the toolbar
- Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addEvents( Object object )
+ Ext.Toolbar.ItemAdds any standard HTML element to the toolbar
+Note: See the notes within Ext.Container.add. Adds any standard HTML element to the toolbar
+ Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable Parameters:
| Observable | |
addField( Ext.form.Field field )
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addField( Ext.form.Field field )
:
- Ext.Toolbar.ItemAdds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
-been rendered... Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
-been rendered yet. For a field that has already been rendered, use addElement.
+ Ext.Toolbar.Item Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
+been rendered ... Adds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
+been rendered yet. For a field that has already been rendered, use addElement.
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addFill()
:
- void Forces subsequent additions into the float:right toolbar
-Note: See the notes within Ext.Container.add. Forces subsequent additions into the float:right toolbar
+ void Forces subsequent additions into the float:right toolbar
+Note: See the notes within Ext.Container.add. Forces subsequent additions into the float:right toolbar
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addItem( Ext.Toolbar.Item item )
:
- Ext.Toolbar.ItemAdds any Toolbar.Item or subclass
-Note: See the notes within Ext.Container.add. Adds any Toolbar.Item or subclass
+ Ext.Toolbar.Item Adds any Toolbar.Item or subclass
+Note: See the notes within Ext.Container.add. Adds any Toolbar.Item or subclass
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
addSeparator()
:
- Ext.Toolbar.Item Adds a separator
-Note: See the notes within Ext.Container.add. Adds a separator
+ Ext.Toolbar.Item Adds a separator
+Note: See the notes within Ext.Container.add. Adds a separator
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addSpacer()
:
- Ext.Toolbar.Spacer Adds a spacer element
-Note: See the notes within Ext.Container.add. Adds a spacer element
+ Ext.Toolbar.Spacer Adds a spacer element
+Note: See the notes within Ext.Container.add. Adds a spacer element
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
addText( String text )
:
- Ext.Toolbar.ItemAdds text to the toolbar
-Note: See the notes within Ext.Container.add. Adds text to the toolbar
+ Ext.Toolbar.Item Adds text to the toolbar
+Note: See the notes within Ext.Container.add. Adds text to the toolbar
Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
applyToMarkup( String/HTMLElement el )
:
voidApply 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:
| Component | |
bind( Ext.data.Store store )
@@ -816,11 +907,45 @@ should usually not need to be called directly.Force this container's layout to be recalculated. A call to this function is required after adding a new component
to... Force this container's layout to be recalculated. A call to this function is required after adding a new component
to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:
| Container | |
enable()
- :
- Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events Parameters:
| Observable | |
find( String prop , String value )
+calc layouts as required (defaults to false, which calls doLayout recursively for each subcontainer)force : Boolean(optional) True to force a layout to occur, even if the item is hidden.
| Container | |
doRefresh()
+ :
+ void Refresh the current page, has the same effect as clicking the 'refresh' button. Refresh the current page, has the same effect as clicking the 'refresh' button. Parameters:
| PagingToolbar | |
enable()
+ :
+ Ext.Component Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default +implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to +access the required target more quickly. +Example:
Parameters:
| Observable | |
find( String prop , String value )
:
ArrayFind a component under this container at any level by property Find a component under this container at any level by property Parameters:
| Container | |
findBy( Function fn , [Object scope ] )
:
@@ -856,9 +981,9 @@ by calling Examines this container's items property
and gets a direct child component of this container.Parameters:
| Container | |
getEl()
@@ -907,7 +1032,7 @@ the element into which the Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
getResizeEl()
:
- void Returns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
contains both the Parameters:
| BoxComponent | |
getSize()
+This Element is returned as the resizeEl .Parameters:
| BoxComponent | |
getSize()
:
Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| BoxComponent | |
getWidth()
:
@@ -959,9 +1084,9 @@ property to the registered type of the Component wanted. For a list of all available xtypes, see Ext.Component.Returns:
| Container | |
insertButton( Number index , Object/Ext.Toolbar.Item/Ext.Button/Array item )
:
- Ext.Button/ItemInserts any Ext.Toolbar.Item/Ext.Button at the specified index.
-Note: See the notes within Ext.Container.add. Inserts any Ext.Toolbar.Item/Ext.Button at the specified index.
- Note: See the notes within Ext.Container.add. Parameters:
| Toolbar | |
isVisible()
:
Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
@@ -977,7 +1102,22 @@ to participate in determination of inherited xtypes.
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 instanceParameters:
| Component | |
moveFirst()
+the default), or true to check whether this Component is directly of the specified xtype.Returns:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component +is destroyed. Usage:
+or:
Parameters:
| Component | |
moveFirst()
:
void Move to the first page, has the same effect as clicking the 'first' button. Move to the first page, has the same effect as clicking the 'first' button. Parameters:
| PagingToolbar | |
moveLast()
:
@@ -985,7 +1125,11 @@ the default), or true to check whether this Component is directly of the specifi
:
void Move to the next page, has the same effect as clicking the 'next' button. Move to the next page, has the same effect as clicking the 'next' button. Parameters:
| PagingToolbar | |
movePrevious()
:
- void Move to the previous page, has the same effect as clicking the 'previous' button. Move to the previous page, has the same effect as clicking the 'previous' button. Parameters:
| PagingToolbar | |
nextSibling()
+ void Move to the previous page, has the same effect as clicking the 'previous' button. Move to the previous page, has the same effect as clicking the 'previous' button. Parameters:
| PagingToolbar | |
mun( Observable|Element item , Object|String ename , Function fn , Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
nextSibling()
:
Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
@@ -994,9 +1138,7 @@ the default), or true to check whether this Component is directly of the specifi
:
Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
purgeListeners()
:
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
refresh()
- :
- void Refresh the current page, has the same effect as clicking the 'refresh' button. Refresh the current page, has the same effect as clicking the 'refresh' button. Parameters:
| PagingToolbar | |
relayEvents( Object o , Array events )
+ voidRemoves all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
:
voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
remove( Component/String component , [Boolean autoDestroy ] )
:
@@ -1040,12 +1182,14 @@ 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:
| Observable | |
setDisabled( Boolean disabled )
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
- 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:
| 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:
| BoxComponent | |
setPagePosition( Number x , Number y )
@@ -1072,10 +1216,10 @@ This may be one of:
| BoxComponent | |
setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| 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:
| BoxComponent | |
show()
:
@@ -1091,11 +1235,18 @@ after the Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
unbind( Ext.data.Store store )
:
- voidUnbinds the paging toolbar from the specified Ext.data.Store (deprecated) Unbinds the paging toolbar from the specified Ext.data.Store (deprecated) Parameters:
| PagingToolbar | |
updateBox( Object box )
+ voidUnbinds the paging toolbar from the specified Ext.data.Store (deprecated) Unbinds the paging toolbar from the specified Ext.data.Store (deprecated) Parameters:
| PagingToolbar | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
:
Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent |
Event | Defined By | |
---|---|---|
add :
( Ext.Container this , Ext.Component component , Number index )
- Listeners will be called with the following arguments:
| Container | |
afterlayout :
+ Listeners will be called with the following arguments:
| Container | |
added :
+ ( Ext.Component this , Ext.Container ownerCt , number index )
+ Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
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 | |
afterrender :
( Ext.Component this )
@@ -1171,7 +1322,9 @@ Fires after the component is hidden when calling the Fires after the overflow state has changed. Fires after the overflow state has changed. Listeners will be called with the following arguments:
| Toolbar | |
remove :
( Ext.Container this , Ext.Component component )
- Listeners will be called with the following arguments:
| Container | |
render :
+ Listeners will be called with the following arguments:
| Container | |
removed :
+ ( Ext.Component this , Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
|