|
| activeClass : String The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") | BaseItem |
| allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component |
| altText : String The altText to use for the icon, if it exists. Defaults to ''. | Item |
| applyTo : MixedSpecify 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.
@@ -45,7 +48,10 @@ different DOM elements. Example usage: {
}
}
| Component |
| autoShow : BooleanTrue 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 |
| canActivate : Boolean True if this item can be visually activated (defaults to true) | Item |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
+them on render (defaults to false). | Component |
| bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... | Component |
| canActivate : Boolean True if this item can be visually activated (defaults to true) | Item |
| clearCls : StringThe CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide field clearing (defaults to
'x-form-clear-left').
@@ -53,7 +59,7 @@ directly after each form field wrapper to provide field clearing (defaults to
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 |
| clickHideDelay : Number Length of time in milliseconds to wait before hiding after a click (defaults to 100) | BaseItem |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
+ See Ext.layout.FormLayout.fieldTpl also. | Component |
| clickHideDelay : Number Length of time in milliseconds to wait before hiding after a click (defaults to 1) | BaseItem |
| cls : StringAn optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for adding customized styles to the component or any of its children using standard CSS rules. | Component |
| contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
for this comp... Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
@@ -129,10 +135,10 @@ button on a window by setting hide:true on the button when adding it to its pare
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 |
| icon : StringThe path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
-icon is specified iconCls should ... The path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
-icon is specified iconCls should not be. | Item |
| iconCls : StringA CSS class that specifies a background image that will be used as the icon for
-this item (defaults to ''). If icon... A CSS class that specifies a background image that will be used as the icon for
+This content is inserted into the body before any configured contentEl is appended. | Component |
| icon : StringThe path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
+icon is specified iconCls should n... The path to an icon to display in this item (defaults to Ext.BLANK_IMAGE_URL). If
+icon is specified iconCls should not be. | Item |
| iconCls : StringA CSS class that specifies a background image that will be used as the icon for
+this item (defaults to ''). If iconC... A CSS class that specifies a background image that will be used as the icon for
this item (defaults to ''). If iconCls is specified icon should not be. | Item |
| id : StringThe 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
@@ -271,8 +277,8 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable |
| menu : MixedEither an instance of Ext.menu.Menu or the config object for an
-Ext.menu.Menu which acts as the submenu when this it... Either an instance of Ext.menu.Menu or the config object for an
+}); | Observable |
| menu : MixedEither an instance of Ext.menu.Menu or the config object for an
+Ext.menu.Menu which acts as the submenu when this ite... Either an instance of Ext.menu.Menu or the config object for an
Ext.menu.Menu which acts as the submenu when this item is activated. | Item |
| overCls : StringAn optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves
over the Element, and removed when the mouse moves out. (defaults to ''). This can be
@@ -433,7 +439,7 @@ config for a suggestion, or use a render listener directly: new
single: true // Remove the listener after first invocation
}
});
- 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 |
| menu : Ext.menu.Menu
+ 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 |
| menu : Ext.menu.Menu
The submenu associated with this Item if one was configured. | Item |
| ownerCt : Ext.ContainerThis Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a C... This Component's owner Container (defaults to undefined, and is set automatically when
this Component is added to a Container). Read-only.
@@ -500,7 +506,12 @@ Or a shorthand syntax:
scope: this
}); Returns: | 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. | Component |
| cloneConfig( Object overrides )
+ 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 |
| bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope ( this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. | 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. | Component |
| destroy()
@@ -515,45 +526,47 @@ should usually not need to be called directly.Enable 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
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
-access the required target more quickly.
- Example: Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+ Example: Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
| 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. | Component |
| findParentByType( String/Class xtype )
+true, the container will be returned. | Component |
| findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
- 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 )
+ 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:xtype : String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class: shallow : Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype. Returns: | 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).
@@ -615,7 +628,7 @@ false to cancel hiding the component. Fires the 'h... Hi
event after hiding the component. Note this method is called internally if
the component is configured to be hidden . | Component |
| isVisible()
:
- BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| isXType( String xtype , [Boolean shallow ] )
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component |
| isXType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
@@ -627,7 +640,11 @@ to participate in determination of inherited xtypes.
var t = new Ext.form.TextField();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
| 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
|