| Package: | Ext |
| Defined In: | Toolbar.js |
| Class: | Toolbar.Item |
| Subclasses: | Toolbar.Separator, Toolbar.Spacer, Toolbar.TextItem |
| Extends: | Object |
ObservableComponent
| Package: | Ext |
| Defined In: | Toolbar.js |
| Class: | Toolbar.Item |
| Subclasses: | Toolbar.Separator, Toolbar.Spacer, Toolbar.TextItem |
| Extends: | BoxComponent |
| Config Options | Defined By | |
|---|---|---|
| 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 (or subclass thereof). +based layout manager, for example:
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.
| Component | |
| autoEl : Mixed A tag name or DomHelper spec used to create the Element which will
+encapsulate this Component.
+You do not normally ne... A tag name or DomHelper spec used to create the Element which will +encapsulate this Component. +You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, +and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex +DOM structure created by their own onRender methods. +This is intended to allow the developer to create application-specific utility Components encapsulated by +different DOM elements. Example usage: | Component | |
| autoHeight : Boolean True to use height:'auto', false to use fixed height (or allow it to be managed by its parent
+Container's layout mana... True to use height:'auto', false to use fixed height (or allow it to be managed by its parent +Container's layout manager. Defaults to false. +Note: Although many components inherit this config option, not all will +function as expected with a height of 'auto'. Setting autoHeight:true means that the +browser will manage height based on the element's contents, and that Ext will not manage it at all. +If the browser is managing the height, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the height might +result in elements needing to be synchronized with the new height. Example: | 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 +Container's layout manager. Defaults to false. +Note: Although many components inherit this config option, not all will +function as expected with a width of 'auto'. Setting autoWidth:true means that the +browser will manage width based on the element's contents, and that Ext will not manage it at all. +If the browser is managing the width, be aware that resizes performed by the browser in response +to changes within the structure of the Component cannot be detected. Therefore changes to the width might +result in elements needing to be synchronized with the new width. For example, where the target element is: | BoxComponent | |
| 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 []. | Component | |
| clearCls : String The CSS class used to to apply to the special clearing div rendered
+directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered +directly after each form field wrapper to provide field clearing (defaults to +'x-form-clear-left'). +Note: this config is only used when this Component is rendered by a Container +which has been configured to use the FormLayout layout +manager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a +fieldLabel is specified or isFormField=true is specified. + See Ext.layout.FormLayout.fieldTpl also. | Component | |
| 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 | |
| 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. +Note: ctCls defaults to '' except for the following class +which assigns a value by default: +
| Component | |
| data : Mixed The initial set of data to apply to the tpl to
+update the content area of the Component. | Component | |
| disabled : Boolean Render this component disabled (default is false). | Component | |
| disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | |
| fieldLabel : String The label text to display next to this Component (defaults to '').
+Note: this config is only used when this Component... The label text to display next to this Component (defaults to ''). +Note: this config is only used when this Component is rendered by a Container which +has been configured to use the FormLayout layout manager (e.g. +Ext.form.FormPanel or specifying layout:'form'). + Also see hideLabel and +Ext.layout.FormLayout.fieldTpl. +Example use: | Component | |
| 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 | |
| height : Number The height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
+Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | |
| hidden : Boolean Render this component hidden (default is false). If true, the
+hide method will be called internally. | Component | |
| hideLabel : Boolean true to completely hide the label element
+(label and separator). Defaults to false.
+By default, even if you do not sp... true to completely hide the label element +(label and separator). Defaults to false. +By default, even if you do not specify a fieldLabel the space will still be +reserved so that the field will line up with other fields that do have labels. +Setting this to true will cause the field to not reserve that space. +Note: see the note for clearCls. +Example use: | Component | |
| hideMode : String How this component should be hidden. Supported values are 'visibility'
+(css visibility), 'offsets' (negative offset p... How this component should be hidden. Supported values are 'visibility' +(css visibility), 'offsets' (negative offset position) and 'display' +(css display). +Note: the default of 'display' is generally preferred +since items are automatically laid out when they are first shown (no sizing +is done while hidden). | Component | |
| hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide
+and show the... True to hide and show the component's container when hide/show is called on the component, false to hide
+and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | |
| 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). +Note that this id will also be used as the element id for the containing HTML element +that is rendered to the page for this component. This allows you to write id-based CSS +rules to style the specific instance of this component uniquely, and also to select +sub-elements using this component's id as the parent. +Note: to avoid complications imposed by a unique id also see
+ Note: to access the container of an item see | Component | |
| itemCls : String Note: this config is only used when this Component is rendered by a Container which
+has been configured to use the Fo... Note: this config is only used when this Component is rendered by a Container which +has been configured to use the FormLayout layout manager (e.g. +Ext.form.FormPanel or specifying layout:'form'). + An additional CSS class to apply to the div wrapping the form item +element of this field. If supplied, itemCls at the field level will override +the default itemCls supplied at the container level. The value specified for +itemCls will be added to the default class ('x-form-item'). +Since it is applied to the item wrapper (see +Ext.layout.FormLayout.fieldTpl), it allows +you to write standard CSS rules that can apply to the field, the label (if specified), or +any other element within the markup for the field. +Note: see the note for fieldLabel. +Example use: | Component | |
| itemId : String An itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. ... An itemId can be used as an alternative way to get a reference to a component
+when no object reference is available. Instead of using an Note: to access the container of an item see ownerCt. | Component | |
| labelSeparator : String The separator to display after the text of each
+fieldLabel. This property may be configured at various levels.
+The o... The separator to display after the text of each +fieldLabel. This property may be configured at various levels. +The order of precedence is: +
Note: see the note for clearCls. + Also see hideLabel and +Ext.layout.FormLayout.fieldTpl. +Example use: | Component | |
| labelStyle : String A CSS style specification string to apply directly to this field's
+label. Defaults to the container's labelStyle val... A CSS style specification string to apply directly to this field's +label. Defaults to the container's labelStyle value if set (e.g., +Ext.layout.FormLayout.labelStyle , or ''). +Note: see the note for + Also see | Component | |
| listeners : Object A config object containing one or more event handlers to be added to this
+object during initialization. This should ... A config object containing one or more event handlers to be added to this +object during initialization. This should be a valid listeners config object as specified in the +addListener example for attaching multiple handlers at once. +DOM events from ExtJs Components +While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
+is usually only done when extra value can be added. For example the DataView's
+ | Observable | |
| margins : Object Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered +by a Container which has been configured to use the BorderLayout +or one of the two BoxLayout subclasses. +An object containing margins to apply to this BoxComponent in the +format: May also be a string containing space-separated, numeric margin values. The order of the +sides associated with each value matches the way CSS processes margin values: +
Defaults to: | BoxComponent | |
| overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
+over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
+over the Element, and removed when the mouse moves out. (defaults to ''). This can be
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | |
| overflowText : String Text to be used for the menu if the item is overflowed. | Toolbar.Item | |
| pageX : Number The page level x coordinate for this component if contained within a positioning container. | BoxComponent | |
| pageY : Number The page level y coordinate for this component if contained within a positioning container. | BoxComponent | |
| plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
+requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
+requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
+When a component is created, if any plugins are available, the component will call the init method on each
+plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
+component as needed to provide its functionality. | Component | |
| ptype : String The registered ptype to create. This config option is not used when passing
+a config object into a constructor. This ... The registered ptype to create. This config option is not used when passing
+a config object into a constructor. This config option is used only when
+lazy instantiation is being used, and a Plugin is being
+specified not as a fully instantiated Component, but as a Component config
+object. The ptype will be looked up at render time up to determine what
+type of Plugin to create. +If you create your own Plugins, you may register them using +Ext.ComponentMgr.registerPlugin in order to be able to +take advantage of lazy instantiation and rendering. | Component | |
| ref : String A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's The ancestor axis can be traversed by using '/' characters in the path. +For example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar: In the code above, if the | Component | |
| region : String Note: this config is only used when this BoxComponent is rendered
+by a Container which has been configured to use the... Note: this config is only used when this BoxComponent is rendered +by a Container which has been configured to use the BorderLayout +layout manager (e.g. specifying layout:'border'). + See Ext.layout.BorderLayout also. | BoxComponent | |
| renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
+will be rendered into.
+Notes ... Specify the id of the element, a DOM element or an existing Element that this component +will be rendered into.
See render also. | Component | |
| 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). See | Component | |
| stateId : String The unique id for this component to use for state management purposes
+(defaults to the component id if one was set, o... The unique id for this component to use for state management purposes
+(defaults to the component id if one was set, otherwise null if the
+component is using a generated id).
+ See | Component | |
| stateful : Boolean A flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of
+internal properties from a saved state on startup. The component must have
+either a + For state saving to work, the state manager's provider must have been +set to an implementation of Ext.state.Provider which overrides the +set and get +methods to save and recall name/value pairs. A built-in implementation, +Ext.state.CookieProvider is available. +To set the state provider for the current page: +A stateful Component attempts to save state when one of the events
+listed in the To save state, a stateful Component first serializes its state by
+calling The value yielded by getState is passed to Ext.state.Manager.set
+which uses the configured Ext.state.Provider to save the object
+keyed by the Component's During construction, a stateful Component attempts to restore
+its state by calling Ext.state.Manager.get passing the
+ The resulting object is passed to You can perform extra processing on state save and restore by attaching +handlers to the beforestaterestore, staterestore, +beforestatesave and statesave events. | Component | |
| style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
+Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
+Ext.Element.applyStyles.
+ | Component | |
| tabTip : String Note: this config is only used when this BoxComponent is a child item of a TabPanel.
+A string to be used as innerHTML... Note: this config is only used when this BoxComponent is a child item of a TabPanel. +A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over +the associated tab selector element. Ext.QuickTips.init() +must be called in order for the tips to render. | BoxComponent | |
| 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
+a config object into a constructor. This config option is used only when
+lazy instantiation is being used, and a child item of a Container is being
+specified not as a fully instantiated Component, but as a Component config
+object. The xtype will be looked up at render time up to determine what
+type of child Component to create. +The predefined xtypes are listed here. + +If you subclass Components to create your own Components, you may register +them using Ext.ComponentMgr.registerType in order to be able to +take advantage of lazy instantiation and rendering. | Component | |
| y : Number The local y (top) coordinate for this component if contained within a positioning container. | BoxComponent | |
| Property | Defined By | |
|---|---|---|
| disabled : Boolean True if this component is disabled. Read-only. | Component | |
| el : Ext.Element The Ext.Element which encapsulates this Component. Read-only.
+This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only. +This will usually be a <DIV> element created by the class's onRender method, but
+that may be overridden using the Note: this element will not be available until this Component has been rendered. + To add listeners for DOM events to this Component (as opposed to listeners +for this Component's own Observable events), see the listeners +config for a suggestion, or use a render listener directly: See also getEl | Component | |
| hidden : Boolean True if this component is hidden. Read-only. | Component | |
| initialConfig : Object This Component's initial configuration specification. Read-only. | Component | |
| ownerCt : Ext.Container This Component's owner Container (defaults to undefined, and is set automatically when
+this Component is added to a C... | Component | |
| refOwner : Ext.Container The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has... The ancestor Container into which the ref reference was inserted if this Component
+is a child of a Container, and has been configured with a ref. | Component | |
| rendered : Boolean True if this component has been rendered. Read-only. | Component | |
| Method | Defined By | |
|---|---|---|
Toolbar.Item( HTMLElement el )
+ Creates a new Item Creates a new Item Parameters:
| Toolbar.Item | |
addClass( string cls )
+ :
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters:
| Component | |
addEvents( Object|String o, string Optional. )
+ :
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName, Function handler, [Object scope], [Object options] )
+ :
+ voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
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 | |
cloneConfig( Object overrides )
+ :
+ Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| Component | |
| destroy()
+ :
+ void Destroys this component by purging any event listeners, removing the component's element from the DOM,
+removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
+removing the component from its Ext.Container (if applicable) and unregistering it from
+Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
+should usually not need to be called directly. Parameters:
| Component | |
| disable()
+ :
+ Ext.Component Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. Parameters:
| Component | |
| 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 | |
findParentBy( Function fn )
+ :
+ Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+true, the con... Find a container above this component at any level by a custom function. If the passed function returns
+true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName, Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
+An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). +An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) +by calling enableBubble. Parameters:
| Observable | |
focus( [Boolean selectText], [Boolean/Number delay] )
+ :
+ Ext.ComponentTry to focus this component. Try to focus this component. Parameters:
| Component | |
getBox( [Boolean local] )
+ :
+ ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
| getBubbleTarget()
+ :
+ Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
| getEl()
+ :
+ Ext.Element Returns the Ext.Element which encapsulates this Component.
+This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component. +This will usually be a <DIV> element created by the class's onRender method, but +that may be overridden using the autoEl config. +Note: this element will not be available until this Component has been rendered. + To add listeners for DOM events to this Component (as opposed to listeners +for this Component's own Observable events), see the listeners config for a suggestion, +or use a render listener directly: Parameters:
| Component | |
| getHeight()
+ :
+ Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| BoxComponent | |
| getId()
+ :
+ String Returns the id of this component or automatically generates and
+returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
+returns an id if an id is not defined yet:Parameters:
| Component | |
| getItemId() + : + String | Component | |
| getOuterSize()
+ :
+ Object Gets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. Parameters:
| BoxComponent | |
getPosition( [Boolean local] )
+ :
+ ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters:
| BoxComponent | |
| getResizeEl()
+ :
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
+Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size. +Usually this will return the same Element as An example is a ComboBox. It is encased in a wrapping Element which
+contains both the Parameters:
| BoxComponent | |
| 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()
+ :
+ Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| BoxComponent | |
| getXType()
+ :
+ String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+available xtypes, see the Ext.Component header. Example usage:
+ Parameters:
| Component | |
| getXTypes()
+ :
+ String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all +available xtypes, see the Ext.Component header. +If using your own subclasses, be aware that a Component must register its own xtype +to participate in determination of inherited xtypes. +Example usage: +Parameters:
| Component | |
hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
| hide()
+ :
+ Ext.Component Hide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the 'beforehide' event and return
+false to cancel hiding the component. Fires the 'hide'
+event after hiding the component. Note this method is called internally if
+the component is configured to be hidden.Parameters:
| Component | |
| isVisible()
+ :
+ Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype, [Boolean shallow] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended +from the xtype (default) or whether it is directly of the xtype specified (shallow = true). +If using your own subclasses, be aware that a Component must register its own xtype +to participate in determination of inherited xtypes. +For a list of all available xtypes, see the Ext.Component header. +Example usage: +Parameters:
| Component | |
mon( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt )
+ :
+ voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
+is destroye... Adds listeners to any Observable object (or Elements) which are automatically removed when this Component +is destroyed. Usage: or: Parameters:
| Component | |
mun( Observable|Element item, Object|String ename, Function fn, Object scope )
+ :
+ voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Component | |
| nextSibling()
+ :
+ Ext.Component Returns the next component in the owning container Returns the next component in the owning container Parameters:
| Component | |
on( String eventName, Function handler, [Object scope], [Object options] )
+ :
+ voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
| previousSibling()
+ :
+ Ext.Component Returns the previous component in the owning container Returns the previous component in the owning container Parameters:
| Component | |
| purgeListeners()
+ :
+ void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
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 | |
removeClass( string cls )
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters:
| Component | |
removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render( [Element/HTMLElement/String container], [String/Number position] )
+ :
+ voidRender this Component into the passed HTML element.
+If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. +If you are using a Container object to house this Component, then +do not use the render method. +A Container's child Components are rendered by that Container's +layout manager when the Container is first rendered. +Certain layout managers allow dynamic addition of child components. Those that do +include Ext.layout.CardLayout, Ext.layout.AnchorLayout, +Ext.layout.FormLayout, Ext.layout.TableLayout. +If the Container is already rendered when a new child Component is added, you may need to call +the Container's doLayout to refresh the view which causes any +unrendered child Components to be rendered. This is required so that you can add multiple +child components if needed while only refreshing the layout once. +When creating complex UIs, it is important to remember that sizing and positioning +of child items is the responsibility of the Container's layout manager. +If you expect child items to be sized in response to user interactions, you must +configure the Container with a layout manager which creates and manages the type of layout you +have in mind. +Omitting the Container's layout config means that a basic +layout manager is used which does nothing but render child components sequentially into the +Container. No sizing or positioning will be performed in this situation. Parameters:
| Component | |
| resumeEvents()
+ :
+ void Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+event... Resume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
+events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
+ :
+ Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
+ :
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. 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 )
+ :
+ Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
+This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
+This method fires the move event. Parameters:
| BoxComponent | |
setPosition( Number left, Number top )
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event. Parameters:
| BoxComponent | |
setSize( Mixed width, Mixed height )
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.Parameters:
| BoxComponent | |
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( 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()
+ :
+ Ext.Component Show this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the '... Show this component. Listen to the 'beforeshow' event and return
+false to cancel showing the component. Fires the 'show'
+event after showing the component. Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
+ :
+ voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
| syncSize()
+ :
+ Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | |
un( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData, [Boolean loadScripts], [Function callback] )
+ :
+ voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component | |
updateBox( Object box )
+ :
+ Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters:
| BoxComponent | |
| Event | Defined By | |
|---|---|---|
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 | |
afterrender :
+ ( Ext.Component this )
+ Fires after the component rendering is finished.
+The afterrender event is fired after this Component has been rendere... Fires after the component rendering is finished. +The afterrender event is fired after this Component has been rendered, been postprocesed +by any afterRender method defined for the Component, and, if stateful, after state +has been restored. Listeners will be called with the following arguments:
| Component | |
beforedestroy :
+ ( Ext.Component this )
+ | Component | |
beforehide :
+ ( Ext.Component this )
+ Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide. Fires before the component is hidden by calling the hide method.
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforerender :
+ ( Ext.Component this )
+ | Component | |
beforeshow :
+ ( Ext.Component this )
+ Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show. Fires before the component is shown by calling the show method.
+Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
beforestaterestore :
+ ( Ext.Component this, Object state )
+ Fires before the state of the component is restored. Return false from an event handler to stop the restore. Fires before the state of the component is restored. Return false from an event handler to stop the restore. Listeners will be called with the following arguments:
| Component | |
beforestatesave :
+ ( Ext.Component this, Object state )
+ Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments:
| Component | |
destroy :
+ ( Ext.Component this )
+ Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
+ ( Ext.Component this )
+ Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
+ ( Ext.Component this )
+ Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
hide :
+ ( Ext.Component this )
+ Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
+Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
move :
+ ( Ext.Component this, Number x, Number y )
+ Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| BoxComponent | |
removed :
+ ( Ext.Component this, Ext.Container ownerCt )
+ Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
+ ( Ext.Component this )
+ Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
+ ( Ext.Component this, Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight )
+ Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| BoxComponent | |
show :
+ ( Ext.Component this )
+ Fires after the component is shown when calling the show method. Fires after the component is shown when calling the show method. Listeners will be called with the following arguments:
| Component | |
staterestore :
+ ( Ext.Component this, Object state )
+ Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments:
| Component | |
statesave :
+ ( Ext.Component this, Object state )
+ Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments:
| Component | |
Properties