|
| | PagingToolbar( Object config )
+ Create a new PagingToolbar Create a new PagingToolbar Parameters:config : ObjectThe config object
Returns: | 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:arg1 : MixedThe following types of arguments are all valid:
@@ -768,39 +780,39 @@ Note that there are a few special strings that are treated differently as explai
- '-': Creates a separator element (equivalent to addSeparator)
- ' ': Creates a spacer element (equivalent to addSpacer)
- '->': Creates a fill element (equivalent to addFill)
- arg2 : Mixedetc. : Mixed
Returns: | Toolbar |
| | addButton( Object/Array config )
- :
- Ext.Button/ArrayAdds a button (or buttons). See Ext.Button for more info on the config.
+ arg2 : Mixedetc. : MixedReturns: | 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. | 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. | 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. | 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. | 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
- Note: See the notes within Ext.Container.add. Parameters:Returns:Ext.Toolbar.ItemThe element's item
| Toolbar |
| | addElement( Mixed el )
- :
- Ext.Toolbar.ItemAdds any standard HTML element to the toolbar
+ Note: See the notes within Ext.Container.add. Parameters:Returns:Ext.Toolbar.ItemThe element's item
| 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:Returns:Ext.Toolbar.ItemThe element's item
| Toolbar |
| | addEvents( Object|String o, string Optional. )
- :
+
Note: See the notes within Ext.Container.add. Parameters:Returns:Ext.Toolbar.ItemThe element's item
| Toolbar |
| | addEvents( Object|String o, string Optional. )
+ :
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable |
| | addField( Ext.form.Field field )
- :
- Ext.Toolbar.ItemAdds a dynamically rendered Ext.form field (TextField, ComboBox, etc). Note: the field should not have
+Usage: this.addEvents('storeloaded', 'storecleared');
| 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.
- Note: See the notes within Ext.Container.add. | Toolbar |
| | addFill()
- :
- voidForces subsequent additions into the float:right toolbar
+ Note: See the notes within Ext.Container.add. | Toolbar |
| | addFill()
+ :
+ voidForces 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. | Toolbar |
| | addItem( Ext.Toolbar.Item item )
- :
- Ext.Toolbar.Item | Toolbar |
| | addItem( Ext.Toolbar.Item item )
+ :
+ Ext.Toolbar.ItemAdds any Toolbar.Item or subclass
Note: See the notes within Ext.Container.add. | Toolbar |
| | addListener( String eventName, Function handler, [Object scope], [Object options] )
- :
+
Note: See the notes within Ext.Container.add. | 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:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -850,64 +862,60 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-});
Returns: | Observable |
| | addSeparator()
- :
- Ext.Toolbar.ItemAdds a separator
+}); Returns: | Observable |
| | addSeparator()
+ :
+ Ext.Toolbar.ItemAdds a separator
Note: See the notes within Ext.Container.add. | Toolbar |
| | addSpacer()
- :
- Ext.Toolbar.Spacer | Toolbar |
| | addSpacer()
+ :
+ Ext.Toolbar.SpacerAdds a spacer element
Note: See the notes within Ext.Container.add. Adds a spacer element
- Note: See the notes within Ext.Container.add. Parameters:Returns:Ext.Toolbar.SpacerThe spacer item
| Toolbar |
| | addText( String text )
- :
- Ext.Toolbar.ItemAdds text to the toolbar
+ Note: See the notes within Ext.Container.add. Parameters:Returns:Ext.Toolbar.SpacerThe spacer item
| Toolbar |
| | addText( String text )
+ :
+ Ext.Toolbar.ItemAdds 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:text : StringThe text to add
Returns:Ext.Toolbar.ItemThe element's item
| 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. | Component |
| | bind( Ext.data.Store store )
- :
- voidBinds the paging toolbar to the specified Ext.data.Store (deprecated) Binds the paging toolbar to the specified Ext.data.Store (deprecated)Parameters:store : Ext.data.StoreThe data store to bind
Returns: | PagingToolbar |
| | bindStore( Store store, [Boolean initial] )
- :
- voidBinds the paging toolbar to the specified Ext.data.Store | PagingToolbar |
| | bubble( Function fn, [Object scope], [Array args] )
- :
+
Note: See the notes within Ext.Container.add. Parameters:text : StringThe text to add
Returns:Ext.Toolbar.ItemThe element's item
| 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. | Component |
| | bind( Ext.data.Store store )
+ :
+ voidBinds the paging toolbar to the specified Ext.data.Store (deprecated) Binds the paging toolbar to the specified Ext.data.Store (deprecated)Parameters:store : Ext.data.StoreThe data store to bind
Returns: | PagingToolbar |
| | bindStore( Store store, [Boolean initial] )
+ :
+ voidBinds the paging toolbar to the specified Ext.data.Store | PagingToolbar |
| | bubble( Function fn, [Object scope], [Array args] )
+ :
Ext.ContainerBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
function call will be the scope provided or the current component. The arguments to the function
will be the args provided or the current component. If the function returns false at any point,
-the bubble is stopped. | Container |
| | canLayout()
- :
- voidWe can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its par... We can only lay out if there is a view area in which to layout.
-display:none on the layout target, *or any of its parent elements* will mean it has no view area. | Container |
| | cascade( Function fn, [Object scope], [Array args] )
- :
+the bubble is stopped. | Container |
| | cascade( Function fn, [Object scope], [Array args] )
+ :
Ext.ContainerCascades down the component/container heirarchy from this component (called first), calling the specified function wi... Cascades down the component/container heirarchy from this component (called first), 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 cascade is stopped on that branch. | Container |
| | changePage( Integer page )
- :
- voidChange the active page Change the active page Parameters:page : IntegerThe page to display
Returns: | PagingToolbar |
| | cloneConfig( Object overrides )
- :
+the cascade is stopped on that branch. | Container |
| | changePage( Integer page )
+ :
+ voidChange the active page Change the active page Parameters:page : IntegerThe page to display
Returns: | PagingToolbar |
| | 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. | Component |
| | destroy()
- :
- voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: | Component |
| | 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,
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. | Component |
| | disable()
- :
- Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component |
| | doLayout( [Boolean shallow], [Boolean force] )
- :
- Ext.ContainerForce this container's layout to be recalculated. A call to this function is required after adding a new component
+should usually not need to be called directly. | Component |
| | disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component |
| | doLayout( [Boolean shallow], [Boolean force] )
+ :
+ Ext.ContainerForce 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:shallow : Boolean(optional) True to only calc the layout of this component, and let child components auto
-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.
Returns: | Container |
| | doRefresh()
- :
- voidRefresh 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. | PagingToolbar |
| | enable()
- :
- Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component |
| | enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+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. Returns: | Container |
| | doRefresh()
+ :
+ voidRefresh 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. | PagingToolbar |
| | enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | 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
@@ -939,39 +947,39 @@ access the required target more quickly.
myForm.header.setStyle( 'color', 'red');
}
}
-}); | 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:prop : Stringvalue : String
Returns:ArrayArray of Ext.Components
| Container |
| | findBy( Function fn, [Object scope] )
- :
- ArrayFind a component under this container at any level by a custom function. If the passed function returns
+}); | 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:prop : Stringvalue : String
Returns:ArrayArray of Ext.Components
| Container |
| | findBy( Function fn, [Object scope] )
+ :
+ ArrayFind a component under this container at any level by a custom function. If the passed function returns
true, the com... Find a component under this container at any level by a custom function. If the passed function returns
-true, the component will be included in the results. The passed function is called with the arguments (component, this container). Parameters:fn : FunctionThe function to call scope : Object(optional)
Returns:ArrayArray of Ext.Components
| Container |
| | findById( String id )
- :
- Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container |
| | findByType( String/Class xtype, [Boolean shallow] )
- :
+true, the component will be included in the results. The passed function is called with the arguments (component, this container).Parameters:fn : FunctionThe function to call scope : Object(optional)
Returns:ArrayArray of Ext.Components
| Container |
| | findById( String id )
+ :
+ Ext.ComponentFind a component under this container at any level by id Find a component under this container at any level by id | Container |
| | findByType( String/Class xtype, [Boolean shallow] )
+ :
ArrayFind a component under this container at any level by xtype or class Find a component under this container at any level by xtype or class Parameters:xtype : String/ClassThe xtype string for a component, or the class of the component directly 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:ArrayArray of Ext.Components
| Container |
| | findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+the default), or true to check whether this Component is directly of the specified xtype. Returns:ArrayArray of Ext.Components
| Container |
| | 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. | Component |
| | findParentByType( String/Class xtype )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component |
| | fireEvent( String eventName, Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. | Component |
| | findParentByType( String/Class xtype )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | 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... | Observable |
| | focus( [Boolean selectText], [Boolean/Number delay] )
- :
- Ext.ComponentTry to focus this component. Try to focus this component. Parameters:selectText : Boolean(optional) If applicable, true to also select the text in this component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns: | Component |
| | get( String/Number key )
- :
- Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:Returns:Ext.ComponentExt.Component
| Container |
| | getBox( [Boolean local] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent |
| | getBubbleTarget()
- :
- Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | Component |
| | getComponent( String/Number comp )
- :
- Ext.ComponentExamines this container's items property
+by calling enableBubble. | Observable |
| | focus( [Boolean selectText], [Boolean/Number delay] )
+ :
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:selectText : Boolean(optional) If applicable, true to also select the text in this component delay : Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns: | Component |
| | get( String/Number key )
+ :
+ Ext.ComponentGet a component contained by this container (alias for items.get(key)) Get a component contained by this container (alias for items.get(key)) Parameters:Returns:Ext.ComponentExt.Component
| Container |
| | getBox( [Boolean local] )
+ :
+ ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent |
| | getBubbleTarget()
+ :
+ Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | Component |
| | getComponent( String/Number comp )
+ :
+ Ext.ComponentExamines this container's items property
and gets a direct child component of this container. Examines this container's items property
and gets a direct child component of this container. | Container |
| | getEl()
- :
- Ext.Element | Container |
| | getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the autoEl config.
@@ -998,35 +1006,35 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component |
| | getHeight()
- :
- NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent |
| | getId()
- :
- StringReturns the id of this component or automatically generates and
+}); | Component |
| | getHeight()
+ :
+ NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent |
| | getId()
+ :
+ StringReturns the id of this component or automatically generates and
returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component |
| | getItemId()
- :
- StringReturns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component |
| | getItemId()
+ :
+ StringReturns the itemId of this component. If an
+itemId was not assigned through configuration the
id is returned using g... Returns the itemId of this component. If an
itemId was not assigned through configuration the
- id is returned using getId. | Component |
| | getLayout()
- :
- ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
+ id is returned using getId. | Component |
| | getLayout()
+ :
+ ContainerLayoutReturns the layout currently in use by the container. If the container does not currently have a layout
set, a defau... Returns the layout currently in use by the container. If the container does not currently have a layout
-set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container |
| | getLayoutTarget()
- :
- Ext.ElementReturns the Element to be used to contain the child Components of this Container.
+set, a default Ext.layout.ContainerLayout will be created and set as the container's layout. | Container |
| | getLayoutTarget()
+ :
+ Ext.ElementReturns the Element to be used to contain the child Components of this Container.
An implementation is provided which... Returns the Element to be used to contain the child Components of this Container.
An implementation is provided which returns the Container's Element, but
if there is a more complex structure to a Container, this may be overridden to return
-the element into which the layout renders child Components. | Container |
| | getOuterSize()
- :
- ObjectGets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. | BoxComponent |
| | getPosition( [Boolean local] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent |
| | getResizeEl()
- :
- Ext.ElementReturns the outermost Element of this Component which defines the Components overall size.
+the element into which the layout renders child Components. | Container |
| | getOuterSize()
+ :
+ ObjectGets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. | BoxComponent |
| | getPosition( [Boolean local] )
+ :
+ ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent |
| | getResizeEl()
+ :
+ Ext.ElementReturns 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 getEl,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -1034,36 +1042,36 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input> Element (which is what would be returned
by its getEl method, and the trigger button Element.
-This Element is returned as the resizeEl. | BoxComponent |
| | getSize()
- :
- ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent |
| | getWidth()
- :
- NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent |
| | getXType()
- :
- StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+This Element is returned as the resizeEl. | BoxComponent |
| | getSize()
+ :
+ ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent |
| | getWidth()
+ :
+ NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent |
| | getXType()
+ :
+ StringGets 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:
var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
| Component |
| | getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' | Component |
| | getXTypes()
+ :
+ StringReturns 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:
var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
| Component |
| | hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable |
| | hide()
- :
- Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' | Component |
| | hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable |
| | hide()
+ :
+ Ext.ComponentHide this component. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the ' beforehide' event and return
false to cancel hiding the component. Fires the ' hide'
event after hiding the component. Note this method is called internally if
-the component is configured to be hidden. | Component |
| | insert( Number index, Ext.Component component )
- :
- Ext.ComponentInserts a Component into this Container at a specified index. Fires the
+the component is configured to be hidden. | Component |
| | insert( Number index, Ext.Component component )
+ :
+ Ext.ComponentInserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires the add event after the
Component has been inserted. Parameters:index : NumberThe index at which the Component will be inserted
@@ -1075,17 +1083,17 @@ constructing a real Component object if lazy rendering might mean that the
inserted Component will not be rendered immediately. To take advantage of
this 'lazy instantiation', set the Ext.Component.xtype config
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.
+For a list of all available xtypes, see Ext.Component. | 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:index : NumberThe index where the item is to be inserted item : Object/Ext.Toolbar.Item/Ext.Button/ArrayThe button, or button config object to be
-inserted, or an array of buttons/configs.
Returns: | Toolbar |
| | isVisible()
- :
- BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| | isXType( String xtype, [Boolean shallow] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+inserted, or an array of buttons/configs. Returns: | Toolbar |
| | isVisible()
+ :
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| | isXType( String xtype, [Boolean shallow] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).
If using your own subclasses, be aware that a Component must register its own xtype
@@ -1096,9 +1104,9 @@ 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:xtype : StringThe xtype to check for this 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: | 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
+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:
myGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});
@@ -1111,44 +1119,44 @@ myGridPanel.mon(myGridPanel.getSelectionModel(), {
Parameters:item : Observable|ElementThe item to which to add a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
is the scope (this reference) in which the handler function is executed. opt : ObjectOptional. If the ename parameter was an event name, this
-is the addListener options.
Returns: | Component |
| | moveFirst()
- :
- voidMove 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. | PagingToolbar |
| | moveLast()
- :
- voidMove to the last page, has the same effect as clicking the 'last' button. Move to the last page, has the same effect as clicking the 'last' button. | PagingToolbar |
| | moveNext()
- :
- voidMove 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. | PagingToolbar |
| | movePrevious()
- :
- voidMove 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. | PagingToolbar |
| | mun( Observable|Element item, Object|String ename, Function fn, Object scope )
- :
+is the addListener options.Returns: | Component |
| | moveFirst()
+ :
+ voidMove 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. | PagingToolbar |
| | moveLast()
+ :
+ voidMove to the last page, has the same effect as clicking the 'last' button. Move to the last page, has the same effect as clicking the 'last' button. | PagingToolbar |
| | moveNext()
+ :
+ voidMove 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. | PagingToolbar |
| | movePrevious()
+ :
+ voidMove 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. | 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:item : Observable|ElementThe item from which to remove a listener/listeners. ename : Object|StringThe event name, or an object containing event name properties. fn : FunctionOptional. If the ename parameter was an event name, this
is the handler function. scope : ObjectOptional. If the ename parameter was an event name, this
-is the scope (this reference) in which the handler function is executed.
Returns: | Component |
| | nextSibling()
- :
- Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component |
| | on( String eventName, Function handler, [Object scope], [Object options] )
- :
+is the scope (this reference) in which the handler function is executed.Returns: | Component |
| | nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component |
| | on( String eventName, Function handler, [Object scope], [Object options] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
Returns: | Observable |
| | previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component |
| | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | 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. | Observable |
| | remove( Component/String component, [Boolean autoDestroy] )
- :
- Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| | previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component |
| | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | 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. | Observable |
| | remove( Component/String component, [Boolean autoDestroy] )
+ :
+ Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
the remove event a... Removes a component from this container. Fires the beforeremove event before removing, then fires
the remove event after the component has been removed. | Container |
| | removeAll( [Boolean autoDestroy] )
- :
+Defaults to the value of this Container's autoDestroy config.Returns: | Container |
| | removeAll( [Boolean autoDestroy] )
+ :
ArrayRemoves all components from this container. Removes all components from this container. | Container |
| | removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component |
| | removeListener( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable |
| | render( [Element/HTMLElement/String container], [String/Number position] )
- :
- voidRender this Component into the passed HTML element.
+Defaults to the value of this Container's autoDestroy config. | Container |
| | removeClass( string cls )
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component |
| | removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable |
| | render( [Element/HTMLElement/String container], [String/Number position] )
+ :
+ voidRender this Component into the passed HTML element.
If you are using a Container object to house this Component, then... Render this Component into the passed HTML element.
If you are using a Container object to house this Component, then
do not use the render method.
@@ -1170,33 +1178,33 @@ have in mind.
layout manager is used which does nothing but render child components sequentially into the
Container. No sizing or positioning will be performed in this situation. Parameters:container : Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted. position : String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container)
Returns: | Component |
| | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+which this component will be inserted (defaults to appending to the end of the container) Returns: | Component |
| | resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable |
| | setAutoScroll( Boolean scroll )
- :
- Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent |
| | setDisabled( Boolean disabled )
- :
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component |
| | setHeight( Number height )
- :
+events fired during event suspension will be sent to any listeners now. | Observable |
| | setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. | BoxComponent |
| | setDisabled( Boolean disabled )
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | Component |
| | setHeight( Number height )
+ :
Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters: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).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
-
Returns: | BoxComponent |
| | setPagePosition( Number x, Number y )
- :
- Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+ | BoxComponent |
| | setPagePosition( Number x, Number y )
+ :
+ Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position
Returns: | BoxComponent |
| | setPosition( Number left, Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position
Returns: | BoxComponent |
| | setPosition( Number left, Number top )
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent |
| | setSize( Mixed width, Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top
Returns: | BoxComponent |
| | setSize( Mixed width, Mixed height )
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either width and height as separate arguments, or you can pass a size object like {width:10, height:20}. Parameters:width : MixedThe new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
@@ -1208,53 +1216,53 @@ This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
undefined to leave the height unchanged.
| 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. | Component |
| | setWidth( Number width )
- :
+Returns: | 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. | Component |
| | setWidth( Number width )
+ :
Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:width : NumberThe new width to setThis may be one of:
Returns: | BoxComponent |
| | show()
- :
- Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+ | BoxComponent |
| | show()
+ :
+ Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the '... Show this component. Listen to the ' beforeshow' event and return
false to cancel showing the component. Fires the ' show'
-event after showing the component. | Component |
| | suspendEvents( Boolean queueSuspended )
- :
+event after showing the component. | Component |
| | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events;
Returns: | Observable |
| | syncSize()
- :
- Ext.BoxComponentForce 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. | BoxComponent |
| | un( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | 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:store : Ext.data.StoreThe data store to unbind
Returns: | PagingToolbar |
| | update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
- :
+after the resumeEvents call instead of discarding all suspended events;Returns: | Observable |
| | syncSize()
+ :
+ Ext.BoxComponentForce 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. | BoxComponent |
| | un( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) | 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:store : Ext.data.StoreThe data store to unbind
Returns: | PagingToolbar |
| | update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
+ :
voidUpdate the content area of a component. Update the content area of a component. Parameters:htmlOrData : MixedIf this component has been configured with a template via the tpl config
then it will use this argument as data to populate the template.
If this component was not configured with a template, the components
-content area will be updated via Ext.Element update loadScripts : Boolean(optional) Only legitimate when using the html configuration. Defaults to false callback : Function(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
Returns: | 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. | BoxComponent |