| anchor : StringNote: this config is only used when this Component is rendered
+}); Config Options|
| allowDepress : BooleanFalse to not allow a pressed Button to be depressed (defaults to undefined). Only valid when enableToggle is true. | Button | | allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | | anchor : StringNote: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered
-by a Container which has been configured to use an AnchorLayout
+by a Container which has been configured to use an AnchorLayout (or subclass thereof).
based layout manager, for example:
- See Ext.layout.AnchorLayout.anchor also. | Component | | applyTo : Mixed | BoxComponent | | 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.
@@ -43,13 +43,13 @@ to create its subcomponents from that markup if applicable.
If applyTo is specified, any value passed for renderTo will be ignored and the target
element's parent node will automatically be used as the component's container.
- | Component | | arrowAlign : String(Optional) The side of the Button box to render the arrow if the button has an associated menu.
-Two values are allowe... (Optional) The side of the Button box to render the arrow if the button has an associated menu.
-Two values are allowed:
-
+ | Component | | arrowAlign : String(Optional) The side of the Button box to render the arrow if the button has an associated menu.
+Two values are allow... (Optional) The side of the Button box to render the arrow if the button has an associated menu.
+Two values are allowed:
+
Defaults to 'right'. | Button | | arrowHandler : Function A function called when the arrow button is clicked (can be used instead of click event) | SplitButton | | arrowTooltip : String The title attribute of the arrow | SplitButton | | autoHeight : BooleanTrue 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.
@@ -82,7 +82,9 @@ result in elements needing to be synchronized with the new height. Example:<
}
}
}
-}).show(); | BoxComponent | | autoShow : BooleanTrue if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
+}).show(); | BoxComponent | | autoScroll : Booleantrue 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 : 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 | | autoWidth : BooleanTrue 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
@@ -114,11 +116,19 @@ child items when the browser changes its width: var myPanel = <
}, {
title: 'Box 3'
}],
-});
| BoxComponent | | buttonSelector : String(Optional) A DomQuery selector which is used to extract the active, clickable element from the
-DOM structure created.... (Optional) A DomQuery selector which is used to extract the active, clickable element from the
-DOM structure created.
- When a custom template is used, you must ensure that this selector results in the selection of
-a focussable element.
+}); | BoxComponent | | boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+Warning: This will override any size mana... The maximum value in pixels which this BoxComponent will set its height to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMaxWidth : NumberThe maximum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The maximum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | boxMinHeight : NumberThe 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 : NumberThe minimum value in pixels which this BoxComponent will set its width to.
+Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to.
+ Warning: This will override any size management applied by layout managers. | BoxComponent | | buttonSelector : String(Optional) A DomQuery selector which is used to extract the active, clickable element from the
+DOM structure created... (Optional) A DomQuery selector which is used to extract the active, clickable element from the
+DOM structure created.
+ When a custom template is used, you must ensure that this selector results in the selection of
+a focussable element.
Defaults to 'button:first-child'. | Button | | 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
@@ -127,7 +137,9 @@ 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 | | clickEvent : String The type of event to map to the button's event handler (defaults to 'click') | Button | | cls : String A CSS class string to apply to the button's main element. | Button | | ctCls : String | Component | | clickEvent : StringThe DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
+De... The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
+Defaults to 'click'. | Button | | cls : String A CSS class string to apply to the button's main element. | Button | | ctCls : StringAn 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.
@@ -152,11 +164,17 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Name'
}]
-});
| Component | | handleMouseEvents : Boolean False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) | Button | | handler : FunctionA function called when the button is clicked (can be used instead of click event).
-The handler is passed the followin... A function called when the button is clicked (can be used instead of click event).
-The handler is passed the following parameters:
-b : ButtonThis Button.
-e : EventObjectThe click event.
+}); | Component | | flex : NumberNote: 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 flex property will be flexed either vertically (by a VBoxLayout)
+or horizontally (by an HBoxLayout) according to the item's relative flex value
+compared to the sum of all Components with flex value specified. Any child items that have
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent | | handleMouseEvents : Boolean False to disable visual cues on mouseover, mouseout and mousedown (defaults to true) | Button | | handler : FunctionA function called when the button is clicked (can be used instead of click event).
+The handler is passed the followi... A function called when the button is clicked (can be used instead of click event).
+The handler is passed the following parameters:
+b : ButtonThis Button.
+e : EventObjectThe click event.
| Button | | height : NumberThe height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset s... The height of this component in pixels (defaults to auto).
Note to express this dimension as a percentage or offset see Ext.Component.anchor. | BoxComponent | | hidden : Boolean True to start hidden (defaults to false) | Button | | hideLabel : Booleantrue to completely hide the label element
@@ -183,17 +201,17 @@ since items are automatically laid out when they are first shown (no sizing
is done while hidden). | Component | | hideParent : BooleanTrue 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 | | icon : StringThe path to an image to display in the button (the image will be set as the background-image
-CSS property of the butt... The path to an image to display in the button (the image will be set as the background-image
-CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon') | Button | | iconAlign : String(Optional) The side of the Button box to render the icon. Four values are allowed:
-<ul class="mdetail-params">
-'top'<... (Optional) The side of the Button box to render the icon. Four values are allowed:
-
-- 'top'
-- 'right'
-- 'bottom'
-- 'left'
-
+button on a window by setting hide:true on the button when adding it to its parent container. | Component | | icon : StringThe path to an image to display in the button (the image will be set as the background-image
+CSS property of the but... The path to an image to display in the button (the image will be set as the background-image
+CSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon') | Button | | iconAlign : String(Optional) The side of the Button box to render the icon. Four values are allowed:
+<ul class="mdetail-params">
+'top... (Optional) The side of the Button box to render the icon. Four values are allowed:
+
+- 'top'
+- 'right'
+- 'bottom'
+- 'left'
+
Defaults to 'left'. | Button | | iconCls : String A css class which sets a background image to be used as the icon for this button | Button | | 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
@@ -204,8 +222,11 @@ rules to style the specific instance of this component uniquely, and also to sel
sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see
itemId and ref .
- Note: to access the container of an item see ownerCt . | Component | | itemCls : StringAn additional CSS class to apply to the div wrapping the form item
-element of this field. If supplied, itemCls at th... An additional CSS class to apply to the div wrapping the form item
+ Note: to access the container of an item see ownerCt . | Component | | itemCls : StringNote: 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').
@@ -214,22 +235,22 @@ the default itemCls supplied at the container level. The value s
you to write standard CSS rules that can apply to the field, the label (if specified), or
any other element within the markup for the field.
Note: see the note for fieldLabel.
-Example use: // Apply a style to the field's label:
+Example use:// Apply a style to the field's label:
<style>
.required .x-form-item-label {font-weight:bold;color:red;}
</style>
new Ext.FormPanel({
- height: 100,
- renderTo: Ext.getBody(),
- items: [{
- xtype: 'textfield',
- fieldLabel: 'Name',
- itemCls: 'required' //this label will be styled
- },{
- xtype: 'textfield',
- fieldLabel: 'Favorite Color'
- }]
+ height: 100,
+ renderTo: Ext.getBody(),
+ items: [{
+ xtype: 'textfield',
+ fieldLabel: 'Name',
+ itemCls: 'required' //this label will be styled
+ },{
+ xtype: 'textfield',
+ fieldLabel: 'Favorite Color'
+ }]
});
| Component | | itemId : StringAn 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 id with
@@ -379,14 +400,14 @@ right and left are set to the second.
to the second, and the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.
- Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | menu : MixedStandard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde... Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). | Button | | menuAlign : StringThe position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?'). | Button | | minWidth : NumberThe minimum width for this button (used to give a set of buttons a common width).
+ Defaults to: {top:0, right:0, bottom:0, left:0}
| BoxComponent | | menu : MixedStandard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde... Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined). | Button | | menuAlign : StringThe position to align the menu to (see Ext.Element.alignTo for more details, defaults to 'tl-bl?'). | Button | | minWidth : NumberThe minimum width for this button (used to give a set of buttons a common width).
See also Ext.Panel. minButtonWidth. | Button | | 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
-useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | overflowText : StringIf used in a Toolbar, the
-text to be used if this item is shown in the overflow menu. See also
-Ext.Toolbar.Item.overf... If used in a Toolbar, the
-text to be used if this item is shown in the overflow menu. See also
+useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules. | Component | | overflowText : StringIf used in a Toolbar, the
+text to be used if this item is shown in the overflow menu. See also
+Ext.Toolbar.Item.ove... | Button | | 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/ArrayAn 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.
@@ -401,9 +422,9 @@ object. The ptype will be looked up at render time up to determine
type of Plugin to create.
If you create your own Plugins, you may register them using
Ext.ComponentMgr.registerPlugin in order to be able to
-take advantage of lazy instantiation and rendering. | Component | | ref : StringA path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named r... A path specification, relative to the Component's ownerCt specifying into which
-ancestor Container to place a named reference to this Component.
+take advantage of lazy instantiation and rendering. | Component | | ref : StringA path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named r... A path specification, relative to the Component's ownerCt
+specifying into which ancestor Container to place a named reference to this Component.
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: var myGrid = new Ext.grid.EditorGridPanel({
title: 'My EditorGridPanel',
@@ -422,9 +443,10 @@ For example, to put a reference to a Toolbar Button into the Panel which owns
}
}
});
- In the code above, if the ref had been 'saveButton' the reference would
-have been placed into the Toolbar. Each '/' in the ref moves up one level from the
-Component's ownerCt. | Component | | region : StringNote: this config is only used when this BoxComponent is rendered
+ In the code above, if the ref had been 'saveButton'
+the reference would have been placed into the Toolbar. Each '/' in the ref
+moves up one level from the Component's ownerCt .
+ Also see the added and removed events. | Component | | region : StringNote: 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').
@@ -440,18 +462,18 @@ to render and manage its child items.
When using this config, a call to render() is not required.
-See render also. | Component | | repeat : Boolean/ObjectTrue to repeat fire the click event while the mouse is down. This can also be
-a ClickRepeater config object (defaults... True to repeat fire the click event while the mouse is down. This can also be
-a ClickRepeater config object (defaults to false). | Button | | scale : String(Optional) The size of the Button. Three values are allowed:
-<ul class="mdetail-params">
-'small'<div class="sub-desc"... (Optional) The size of the Button. Three values are allowed:
-
-- 'small'
Results in the button element being 16px high.
-- 'medium'
Results in the button element being 24px high.
-- 'large'
Results in the button element being 32px high.
-
- Defaults to 'small'. | Button | | scope : Object | Component | | repeat : Boolean/ObjectTrue to repeat fire the click event while the mouse is down. This can also be
+a ClickRepeater config object (default... True to repeat fire the click event while the mouse is down. This can also be
+a ClickRepeater config object (defaults to false). | Button | | scale : String(Optional) The size of the Button. Three values are allowed:
+<ul class="mdetail-params">
+'small'<div class="sub-des... (Optional) The size of the Button. Three values are allowed:
+
+- 'small'
Results in the button element being 16px high.
+- 'medium'
Results in the button element being 24px high.
+- 'large'
Results in the button element being 32px high.
+
+ Defaults to 'small'. | Button | | scope : ObjectThe scope ( this reference) in which the
+ handler and toggleHandler is
executed. Defaults to this Button. | Button | | stateEvents : ArrayAn 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). stateEvents may be any type
@@ -522,12 +544,18 @@ Ext.Element.ap... A custom style specification to be appl
}
})
]
-}); | Component | | tabIndex : Number Set a DOM tabIndex for this button (defaults to undefined) | Button | | template : Ext.TemplateA Template used to create the Button's DOM structure.
-Instances, or subclasses which need a different DOM structure m... A Template used to create the Button's DOM structure.
-Instances, or subclasses which need a different DOM structure may provide a different
-template layout in conjunction with an implementation of getTemplateArgs. | Button | | text : String The button text to be used as innerHTML (html tags are accepted) | Button | | toggleGroup : String The group this toggle button is a member of (only 1 per group can be pressed) | Button | | toggleHandler : FunctionFunction called when a Button with enableToggle set to true is clicked. Two arguments are passed:<ul class="mdetail-p... Function called when a Button with enableToggle set to true is clicked. Two arguments are passed: | Component | | tabIndex : Number Set a DOM tabIndex for this button (defaults to undefined) | Button | | tabTip : StringNote: 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 | | template : Ext.Template
+A Template used to create the Button's DOM structure.
+Instances, or subclasses which need a different DOM structure...
+ A Template used to create the Button's DOM structure.
+Instances, or subclasses which need a different DOM structure may provide a different
+template layout in conjunction with an implementation of getTemplateArgs. | Button | | text : String The button text to be used as innerHTML (html tags are accepted) | Button | | toggleGroup : String The group this toggle button is a member of (only 1 per group can be pressed) | Button | | toggleHandler : FunctionFunction called when a Button with enableToggle set to true is clicked. Two arguments are passed:<ul class="mdetail-p... Function called when a Button with enableToggle set to true is clicked. Two arguments are passed: | Button | | tooltip : String/ObjectThe tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config obj... The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object | Button | | tooltipType : String The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. | Button | | type : String submit, reset or button - defaults to 'button' | Button | | width : NumberThe 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 : StringThe registered xtype to create. This config option is not used when passing
@@ -541,8 +569,8 @@ The predefined xtypes are listed 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 |
Public Properties|
| btnEl : Ext.ElementAn Element encapsulating the Button's clickable element. By default,
-this references a <button> element. Read o... An Element encapsulating the Button's clickable element. By default,
+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 |
Public Properties|
| btnEl : Ext.ElementAn Element encapsulating the Button's clickable element. By default,
+this references a <button> element. Read ... An Element encapsulating the Button's clickable element. By default,
this references a <button> element. Read only. | Button | | disabled : Boolean Read-only. True if this button is disabled | Button | | el : Ext.ElementThe Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the ... The Ext.Element which encapsulates this Component. Read-only.
This will usually be a <DIV> element created by the class's onRender method, but
@@ -560,15 +588,20 @@ 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 Read-only. True if this button is hidden | Button | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | menu : Menu
-The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option. | Button | | ownerCt : Ext.PanelThe Button's owner Ext.Panel (defaults to undefined, and is set automatically when
-the Button is added to a container... The Button's owner Ext.Panel (defaults to undefined, and is set automatically when
-the Button is added to a container). Read-only. | Button | | pressed : Boolean Read-only. True if this button is pressed (only if enableToggle = true) | Button | | rendered : Boolean True if this component has been rendered. Read-only. | Component |
Public Methods|
| SplitButton( Object config )
- Create a new menu button Create a new menu button Parameters:config : ObjectThe config object Returns: | SplitButton | | addClass( string cls )
+See also getEl | Component | | hidden : Boolean Read-only. True if this button is hidden | Button | | initialConfig : Object This Component's initial configuration specification. Read-only. | Component | | menu : Menu
+The {@link Ext.menu.Menu Menu} object associated with this Button when configured with the {@link #menu} config option. | Button | | 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.
+ Note: to access items within the Container see itemId. | Component | | pressed : Boolean Read-only. True if this button is pressed (only if enableToggle = true) | Button | | refOwner : Ext.ContainerThe 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 |
Public Methods|
| SplitButton( Object config )
+ Create a new menu button Create a new menu button Parameters:config : ObjectThe config object Returns: | SplitButton | | 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 | | addEvents( Object object )
+ Ext.ComponentAdds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. | Component | | addEvents( Object|String o , string Optional. )
:
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ 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 | | 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.
@@ -589,8 +622,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -598,27 +631,27 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ 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 )
@@ -634,9 +667,41 @@ should usually not need to be called directly.Disable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | enable()
:
- Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | enableBubble( Object events )
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | enableBubble( String/Array events )
:
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | findParentBy( Function fn )
+ 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
@@ -691,7 +756,7 @@ id is returned using g... | Button | | getResizeEl()
:
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ Ext.Element Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return t... Returns the outermost Element of this Component which defines the Components overall size.
Usually this will return the same Element as getEl ,
but in some cases, a Component may have some more wrapping Elements around its main
@@ -699,24 +764,23 @@ 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()
+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 | | getTemplateArgs()
:
- ObjectThis method returns an object which provides substitution parameters for the Template used
-to create this Button's DO... This method returns an object which provides substitution parameters for the Template used
-to create this Button's DOM structure.
- Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
-own implementation of this method.
- The default implementation which provides data for the default template returns an Array containing the
-following items:
-- The Button's text
-- The <button>'s type
-- The iconCls applied to the <button> element
-- The cls applied to the Button's main Element
-- A CSS class name controlling the Button's scale and icon alignment
-- A CSS class name which applies an arrow to the Button if configured with a menu
- | Button | | getText()
+ ArrayThis method returns an Array which provides substitution parameters for the Template used
+to create this Button's DO... This method returns an Array which provides substitution parameters for the Template used
+to create this Button's DOM structure.
+ Instances or subclasses which use a different Template to create a different DOM structure may need to provide their
+own implementation of this method.
+ The default implementation which provides data for the default template returns an Array containing the
+following items:
+- The <button>'s type
+- A CSS class name applied to the Button's main <tbody> element which determines the button's scale and icon alignment.
+- A CSS class to determine the presence and position of an arrow icon. (
'x-btn-arrow' or 'x-btn-arrow-bottom' or '' )
+- The cls CSS class name applied to the button's wrapping <table> element.
+- The Component id which is applied to the button's wrapping <table> element.
+ | Button | | getText()
:
StringGets the text for this Button Gets the text for this Button | Button | | getWidth()
:
@@ -762,7 +826,26 @@ 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 | | nextSibling()
+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});
+
+ or:
+myGridPanel.mon(myGridPanel.getSelectionModel(), {
+ selectionchange: handleSelectionChange,
+ buffer: 50
+});
+
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 | | 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 ] )
:
@@ -809,20 +892,27 @@ event... | Observable | | setArrowHandler( Function handler , [Object scope ] )
:
- voidSets this button's arrow click handler. Sets this button's arrow click handler. | SplitButton | | setDisabled( Boolean disabled )
+ voidSets this button's arrow click handler. Sets this button's arrow click handler. | SplitButton | | 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 | | setHandler( Function handler , [Object scope ] )
:
- Ext.ButtonAssigns this Button's click handler Assigns this Button's click handler | Button | | setHeight( Number height )
+ Ext.ButtonAssigns this Button's click handler Assigns this Button's click handler | Button | | 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 | | setIconClass( String cls )
+Returns: | BoxComponent | | setIcon( String icon )
+ :
+ Ext.ButtonSets the background image (inline style) of the button. This method also changes
+the value of the icon config inter... Sets the background image (inline style) of the button. This method also changes
+the value of the icon config internally. | Button | | setIconClass( String cls )
:
- Ext.ButtonSets the CSS class that provides a background image to use as the button's icon. This method also changes
-the value ... Sets the CSS class that provides a background image to use as the button's icon. This method also changes
+ Ext.Button Sets the CSS class that provides a background image to use as the button's icon. This method also changes
+the value... Sets the CSS class that provides a background image to use as the button's icon. This method also changes
the value of the iconCls config internally. | Button | | setPagePosition( Number x , Number y )
:
Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
@@ -849,9 +939,9 @@ This may be one of:
:
Ext.ButtonSets this Button's text Sets this Button's text Parameters:text : StringThe button text Returns: | Button | | setTooltip( String/Object tooltip. )
:
- Ext.ButtonSets the tooltip for this Button. Sets the tooltip for this Button. | Button | | 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 )
@@ -875,9 +965,16 @@ after the If a state it passed, it becomes the pressed state otherwise the current state is toggled. If a state it passed, it becomes the pressed state otherwise the current state is toggled. | Button | | un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) | Observable | | updateBox( Object box )
+ voidRemoves an event handler (shorthand for removeListener.) | Observable | | 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 |
Public Events|
| afterrender :
+ Ext.BoxComponentSets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. | BoxComponent |
Public Events|
| 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... | Button | | 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:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| BoxComponent | | render :
+ Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:this : Ext.Componentx : NumberThe new x position y : NumberThe new y position
| 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 )
|
|