| 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... | Component | | applyTo : Mixed | Component | | 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,14 +43,43 @@ 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.
+ | 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:
- 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
+ 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 | | autoEl : MixedA 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: {
+ xtype: 'box',
+ autoEl: {
+ tag: 'img',
+ src: 'http://www.example.com/example.jpg'
+ }
+}, {
+ xtype: 'box',
+ autoEl: {
+ tag: 'blockquote',
+ html: 'autoEl is cool!'
+ }
+}, {
+ xtype: 'container',
+ autoEl: 'ul',
+ cls: 'ux-unordered-list',
+ items: {
+ xtype: 'box',
+ autoEl: 'li',
+ html: 'First list item'
+ }
+}
| Component | | 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.
Note: Although many components inherit this config option, not all will
@@ -82,9 +111,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 | | 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
+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
Container's layout manager. Defaults to false.
Note: Although many components inherit this config option, not all will
@@ -114,12 +143,12 @@ 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
+}); | 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
+ 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
'x-form-clear-left').
@@ -127,7 +156,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.
@@ -138,7 +169,7 @@ which assigns a value by default:
To configure the above Class with an extra CSS class append to the default. For example,
for BoxLayout (Hbox and Vbox): ctCls: 'x-box-layout-ct custom-class'
- | Component | | disabled : Boolean True to start disabled (defaults to false) | Button | | disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | | enableToggle : Boolean True to enable pressed/not pressed toggling (defaults to false) | Button | | fieldLabel : StringThe label text to display next to this Component (defaults to '').
+ | Component | | disabled : Boolean True to start disabled (defaults to false) | Button | | disabledClass : String CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). | Component | | enableToggle : Boolean True to enable pressed/not pressed toggling (defaults to false) | Button | | fieldLabel : StringThe 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.
@@ -152,15 +183,15 @@ 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).
+}); | 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.
- | Button | | height : NumberThe height of this component in pixels (defaults to auto).
+ | 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
-(label and separator). Defaults to false.
+ 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
+(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
@@ -174,19 +205,19 @@ Example use: new Ext.FormPanel({
xtype: 'textfield'
hideLabel: true
}]
-});
| Component | | hideMode : StringHow this component should be hidden. Supported values are 'visibility'
+}); | Component | | hideMode : StringHow 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 : BooleanTrue to hide and show the component's container when hide/show is called on the component, false to hide
+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
+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">
+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'
@@ -194,7 +225,7 @@ CSS property of the button by default, so if you want a mixed icon/text button,
- '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).
+ 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
not have an object reference available (e.g., using Ext.getCmp).
@@ -204,8 +235,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,23 +248,23 @@ 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'
- }]
-});
| Component | | itemId : StringAn itemId can be used as an alternative way to get a reference to a component
+ 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
Ext.getCmp, use itemId with
@@ -259,8 +293,8 @@ avoiding potential conflicts with getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
Also see id and ref .
- Note: to access the container of an item see ownerCt. | Component | | labelSeparator : StringThe separator to display after the text of each
-fieldLabel. This property may be configured at various levels.
+ Note: to access the container of an item see ownerCt. | Component | | labelSeparator : StringThe 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:
@@ -288,7 +322,7 @@ Example use: new Ext.FormPanel({
xtype: 'textfield',
fieldLabel: 'Field 2' // labelSeparator will be '='
}]
-});
| Component | | labelStyle : StringA CSS style specification string to apply directly to this field's
+}); | Component | | labelStyle : StringA 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 '').
@@ -303,7 +337,7 @@ Example use: new Ext.FormPanel({
fieldLabel: 'Name',
labelStyle: 'font-weight:bold;'
}]
-});
| Component | | listeners : ObjectA config object containing one or more event handlers to be added to this
+}); | Component | | listeners : ObjectA 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.
@@ -358,7 +392,7 @@ Ext.DomObserver = Ext.extend(Object, {
typeAhead: true,
mode: 'local',
triggerAction: 'all'
-}); | Observable | | margins : ObjectNote: this config is only used when this BoxComponent is rendered
+}); | Observable | | margins : ObjectNote: 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.
@@ -380,19 +414,19 @@ 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).
-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
+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
+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... | 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/Array | 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.
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 | | pressed : Boolean True to start pressed (only if enableToggle = true) | Button | | ptype : StringThe registered ptype to create. This config option is not used when passing
+component as needed to provide its functionality. | Component | | pressed : Boolean True to start pressed (only if enableToggle = true) | Button | | ptype : StringThe 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
@@ -401,7 +435,7 @@ 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
+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.
@@ -424,12 +458,12 @@ 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
+Component's ownerCt. | 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').
- See Ext.layout.BorderLayout also. | BoxComponent | | renderTo : MixedSpecify the id of the element, a DOM element or an existing Element that this component
-will be rendered into.
+ See Ext.layout.BorderLayout also. | BoxComponent | | renderTo : MixedSpecify 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.
- Notes :
@@ -440,10 +474,10 @@ 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
+ 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">
+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:
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
+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
of event supported by this component, including browser or custom events
(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and
-restoring Component state. | Component | | stateId : StringThe unique id for this component to use for state management purposes
+restoring Component state. | Component | | stateId : StringThe 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 stateful for an explanation of saving and
-restoring Component state. | Component | | stateful : BooleanA flag which causes the Component to attempt to restore the state of
+restoring Component state. | Component | | stateful : BooleanA 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 stateId or id assigned
@@ -499,7 +533,7 @@ properties into the object, but a developer may override this to support
more behaviour.
You can perform extra processing on state save and restore by attaching
handlers to the beforestaterestore, staterestore,
-beforestatesave and statesave events. | Component | | style : StringA custom style specification to be applied to this component's Element. Should be a valid argument to
+ beforestatesave and statesave events. | Component | | style : StringA 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.
new Ext.Panel({
@@ -522,15 +556,19 @@ 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.
+}); | 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.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: | 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).
+ | 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
+ 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
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
@@ -541,9 +579,9 @@ 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,
+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,
-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 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
that may be overridden using the autoEl config.
@@ -560,16 +598,19 @@ 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 )
- :
- 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 )
- :
- voidUsed to define events on this Observable Used to define events on this Observable | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+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 | | 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|String o , string Optional. )
+ :
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable | | addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -589,8 +630,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,64 +639,96 @@ 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
-});
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 )
- :
+'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 )
+ :
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. | Component | | destroy()
- :
- voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
+An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: | Component | | destroy()
+ :
+ voidDestroys this component by purging any event listeners, removing the component's element from the DOM,
removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM,
removing the component from its Ext.Container (if applicable) and unregistering it from
Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method
-should usually not need to be called directly. | Component | | disable()
- :
- Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | enable()
- :
- Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable | | findParentBy( Function fn )
- :
- Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
+should usually not need to be called directly. | Component | | disable()
+ :
+ Ext.ComponentDisable this component and fire the 'disable' event. Disable this component and fire the 'disable' event. | Component | | enable()
+ :
+ Ext.ComponentEnable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. | Component | | enableBubble( Object 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");
+ }
+ }
+});
| 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 )
- :
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component | | fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+true, the container will be returned. | Component | | findParentByType( String/Class xtype )
+ :
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class | Component | | fireEvent( String eventName , Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable | | focus()
- :
- void | Button | | getBox( [Boolean local ] )
- :
- ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent | | getBubbleTarget()
- :
- Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | Component | | getEl()
- :
- Ext.ElementReturns the Ext.Element which encapsulates this Component.
+by calling enableBubble. | Observable | | focus()
+ :
+ void | Button | | getBox( [Boolean local ] )
+ :
+ ObjectGets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. | BoxComponent | | getBubbleTarget()
+ :
+ Ext.ContainerProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. | Component | | getEl()
+ :
+ Ext.ElementReturns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the cla... Returns the Ext.Element which encapsulates this Component.
This will usually be a <DIV> element created by the class's onRender method, but
that may be overridden using the autoEl config.
@@ -671,27 +744,27 @@ or use a render listener directly: new Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
| Component | | getHeight()
- :
- NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | getId()
- :
- StringReturns the id of this component or automatically generates and
+}); | Component | | getHeight()
+ :
+ NumberGets the current height of the component's underlying element. Gets the current height of the component's underlying element. | BoxComponent | | getId()
+ :
+ StringReturns the id of this component or automatically generates and
returns an id if an id is not defined yet:'ext-comp-'... Returns the id of this component or automatically generates and
-returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | getItemId()
- :
- StringReturns the itemId of this component. If an
-itemId was not assigned through configuration the
+returns an id if an id is not defined yet: 'ext-comp-' + (++Ext.Component.AUTO_ID)
| Component | | getItemId()
+ :
+ StringReturns the itemId of this component. If an
+itemId was not assigned through configuration the
id is returned using g... Returns the itemId of this component. If an
itemId was not assigned through configuration the
- id is returned using getId . | Component | | getOuterSize()
- :
- ObjectGets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. | BoxComponent | | getPosition( [Boolean local ] )
- :
- ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent | | getPressed( String group )
- :
- ButtonGets the pressed button in the passed group or null Gets the pressed button in the passed group or null | Button | | getResizeEl()
- :
- voidReturns the outermost Element of this Component which defines the Components overall size.
+ id is returned using getId . | Component | | getOuterSize()
+ :
+ ObjectGets the current size of the component's underlying element, including space taken by its margins. Gets the current size of the component's underlying element, including space taken by its margins. | BoxComponent | | getPosition( [Boolean local ] )
+ :
+ ArrayGets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. | BoxComponent | | getPressed( String group )
+ :
+ ButtonGets the pressed button in the passed group or null Gets the pressed button in the passed group or null | Button | | getResizeEl()
+ :
+ voidReturns 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,11 +772,11 @@ active Element.
An example is a ComboBox. It is encased in a wrapping Element which
contains both the <input> Element (which is what would be returned
by its getEl method, and the trigger button Element.
-This Element is returned as the resizeEl . | BoxComponent | | getSize()
- :
- ObjectGets the current size of the component's underlying element. Gets the current size of the component's underlying element. | BoxComponent | | getTemplateArgs()
- :
- ObjectThis method returns an object which provides substitution parameters for the Template used
+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
@@ -716,42 +789,42 @@ following items:
- 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()
- :
- StringGets the text for this Button Gets the text for this Button | Button | | getWidth()
- :
- NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | getXType()
- :
- StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
+ | Button | | getText()
+ :
+ StringGets the text for this Button Gets the text for this Button | Button | | getWidth()
+ :
+ NumberGets the current width of the component's underlying element. Gets the current width of the component's underlying element. | BoxComponent | | getXType()
+ :
+ StringGets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all
available xtypes, see the Ext.Component header. Example usage:
var t = new Ext.form.TextField();
-alert(t.getXType()); // alerts 'textfield'
| Component | | getXTypes()
- :
- StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
+alert(t.getXType()); // alerts 'textfield' | Component | | getXTypes()
+ :
+ StringReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext.Component header.
If using your own subclasses, be aware that a Component must register its own xtype
to participate in determination of inherited xtypes.
Example usage:
var t = new Ext.form.TextField();
-alert(t.getXTypes()); // alerts 'component/box/field/textfield'
| Component | | hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable | | hasVisibleMenu()
- :
- BooleanReturns true if the button has a menu and it is visible Returns true if the button has a menu and it is visible | Button | | hide()
- :
- Ext.ComponentHide this component. Listen to the 'beforehide' event and return
+alert(t.getXTypes()); // alerts 'component/box/field/textfield' | Component | | hasListener( String eventName )
+ :
+ BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event | Observable | | hasVisibleMenu()
+ :
+ BooleanReturns true if the button has a menu and it is visible Returns true if the button has a menu and it is visible | Button | | hide()
+ :
+ Ext.ComponentHide this component. Listen to the 'beforehide' event and return
false to cancel hiding the component. Fires the 'h... Hide this component. Listen to the ' beforehide' event and return
false to cancel hiding the component. Fires the ' hide'
event after hiding the component. Note this method is called internally if
-the component is configured to be hidden . | Component | | hideMenu()
- :
- voidHide this button's menu (if it has one) Hide this button's menu (if it has one) | Button | | isVisible()
- :
- BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | isXType( String xtype , [Boolean shallow ] )
- :
- BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
+the component is configured to be hidden . | Component | | hideMenu()
+ :
+ voidHide this button's menu (if it has one) Hide this button's menu (if it has one) | Button | | isVisible()
+ :
+ BooleanReturns true if this component is visible. Returns true if this component is visible. | Component | | isXType( String xtype , [Boolean shallow ] )
+ :
+ BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from the xtype (default) or whether it is directly of the xtype specified (shallow = true).
If using your own subclasses, be aware that a Component must register its own xtype
@@ -762,24 +835,24 @@ 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()
- :
- 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 ] )
- :
+the default), or true to check whether this Component is directly of the specified xtype.Returns: | Component | | nextSibling()
+ :
+ Ext.ComponentReturns the next component in the owning container Returns the next component in the owning container | Component | | on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | previousSibling()
- :
- Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable | | relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | removeClass( string cls )
- :
- Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component | | removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable | | render( [Element/HTMLElement/String container ], [String/Number position ] )
- :
- voidRender this Component into the passed HTML element.
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable | | previousSibling()
+ :
+ Ext.ComponentReturns the previous component in the owning container Returns the previous component in the owning container | Component | | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable | | relayEvents( Object o , Array events )
+ :
+ voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. | Observable | | removeClass( string cls )
+ :
+ Ext.ComponentRemoves a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. | Component | | removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable | | render( [Element/HTMLElement/String container ], [String/Number position ] )
+ :
+ voidRender this Component into the passed HTML element.
If you are using a Container object to house this Component, then... Render this Component into the passed HTML element.
If you are using a Container object to house this Component, then
do not use the render method.
@@ -801,39 +874,39 @@ have in mind.
layout manager is used which does nothing but render child components sequentially into the
Container. No sizing or positioning will be performed in this situation. Parameters:container : Element/HTMLElement/String(optional) The element this Component should be
rendered into. If it is being created from existing markup, this should be omitted. position : String/Number(optional) The element ID or DOM node index within the container before
-which this component will be inserted (defaults to appending to the end of the container) Returns: | Component | | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+which this component will be inserted (defaults to appending to the end of the container) Returns: | Component | | resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable | | setArrowHandler( Function handler , [Object scope ] )
- :
- voidSets this button's arrow click handler. Sets this button's arrow click handler. | SplitButton | | 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 )
- :
+events fired during event suspension will be sent to any listeners now. | Observable | | setArrowHandler( Function handler , [Object scope ] )
+ :
+ voidSets this button's arrow click handler. Sets this button's arrow click handler. | SplitButton | | 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.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 )
- :
- Ext.ButtonSets the CSS class that provides a background image to use as the button's icon. This method also changes
+ Returns: | BoxComponent | | 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
-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.
+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.
This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition.
-This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position Returns: | BoxComponent | | setPosition( Number left , Number top )
- :
- Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
+This method fires the move event. Parameters:x : NumberThe new x position y : NumberThe new y position Returns: | BoxComponent | | setPosition( Number left , Number top )
+ :
+ Ext.BoxComponentSets the left and top of the component. To set the page XY position instead, use setPagePosition.
This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition.
-This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top Returns: | BoxComponent | | setSize( Mixed width , Mixed height )
- :
- Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
+This method fires the move event. Parameters:left : NumberThe new left top : NumberThe new top Returns: | BoxComponent | | setSize( Mixed width , Mixed height )
+ :
+ Ext.BoxComponentSets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either wid... Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept
either width and height as separate arguments, or you can pass a size object like {width:10, height:20} . Parameters:width : MixedThe new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
@@ -845,111 +918,111 @@ This may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
undefined to leave the height unchanged.
- Returns:
| BoxComponent | | setText( String text )
- :
- Ext.ButtonSets this Button's text Sets this Button's text Parameters:text : StringThe button text Returns: | Button | | setTooltip( String/Object tooltip. )
- :
+Returns: | BoxComponent | | setText( String text )
+ :
+ 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. Parameters:tooltip. : String/ObjectThis may be:
- String : A string to be used as innerHTML (html tags are accepted) to show in a tooltip
- Object : A configuration object for Ext.QuickTips.register.
- Returns: | 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 )
- :
+Returns: | 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 )
+ :
Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:width : NumberThe new width to setThis may be one of: Returns: | BoxComponent | | show()
- :
- Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
+ Returns: | BoxComponent | | show()
+ :
+ Ext.ComponentShow this component. Listen to the 'beforeshow' event and return
false to cancel showing the component. Fires the '... Show this component. Listen to the ' beforeshow' event and return
false to cancel showing the component. Fires the ' show'
-event after showing the component. | Component | | showMenu()
- :
- voidShow this button's menu (if it has one) Show this button's menu (if it has one) | Button | | suspendEvents( Boolean queueSuspended )
- :
+event after showing the component. | Component | | showMenu()
+ :
+ voidShow this button's menu (if it has one) Show this button's menu (if it has one) | Button | | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events; Returns: | Observable | | syncSize()
- :
- Ext.BoxComponentForce the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. | BoxComponent | | toggle( [Boolean state ], [Boolean supressEvent ] )
- :
- Ext.ButtonIf 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 )
- :
- 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.Component this )
- Fires after the component rendering is finished.
+after the resumeEvents call instead of discarding all suspended events; Returns: | Observable | | syncSize()
+ :
+ Ext.BoxComponentForce the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. | BoxComponent | | toggle( [Boolean state ], [Boolean supressEvent ] )
+ :
+ Ext.ButtonIf 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 )
+ :
+ 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.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 | | arrowclick :
- ( MenuButton this , EventObject e )
- Fires when this button's arrow is clicked Fires when this button's arrow is clicked Listeners will be called with the following arguments:this : MenuButtone : EventObjectThe click event
| SplitButton | | beforedestroy :
- ( Ext.Component this )
- Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | Component | | beforehide :
- ( Ext.Component this )
- Fires before the component is hidden by calling the hide method.
+has been restored. Listeners will be called with the following arguments: | Component | | arrowclick :
+ ( MenuButton this , EventObject e )
+ Fires when this button's arrow is clicked Fires when this button's arrow is clicked Listeners will be called with the following arguments:this : MenuButtone : EventObjectThe click event
| SplitButton | | beforedestroy :
+ ( Ext.Component this )
+ Fires before the component is destroyed. Return false from an event handler to stop the destroy. Fires before the component is destroyed. Return false from an event handler to stop the destroy. Listeners will be called with the following arguments: | 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 )
- Fires before the component is rendered. Return false from an
+Return false from an event handler to stop the hide. Listeners will be called with the following arguments: | Component | | beforerender :
+ ( Ext.Component this )
+ Fires before the component is rendered. Return false from an
event handler to stop the render. Fires before the component is rendered. Return false from an
-event handler to stop the render. Listeners will be called with the following arguments: | Component | | beforeshow :
- ( Ext.Component this )
- Fires before the component is shown by calling the show method.
+event handler to stop the render. Listeners will be called with the following arguments: | 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 )
+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:this : Ext.Componentstate : ObjectThe hash of state values returned from the StateProvider. If this
event is not vetoed, then the state object is passed to applyState. By default,
that simply copies property values into this Component. The method maybe overriden to
-provide custom state restoration.
| Component | | beforestatesave :
- ( Ext.Component this , Object state )
+provide custom state restoration. | 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:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
| Component | | click :
- ( Button this , EventObject e )
- Fires when this button is clicked Fires when this button is clicked Listeners will be called with the following arguments:this : Buttone : EventObjectThe click event
| Button | | 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.
+has a null implementation. | Component | | click :
+ ( Button this , EventObject e )
+ Fires when this button is clicked Fires when this button is clicked Listeners will be called with the following arguments:this : Buttone : EventObjectThe click event
| Button | | 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 | | menuhide :
- ( Button this , Menu menu )
- If this button has a menu, this event fires when it is hidden If this button has a menu, this event fires when it is hidden Listeners will be called with the following arguments: | Button | | menushow :
- ( Button this , Menu menu )
- If this button has a menu, this event fires when it is shown If this button has a menu, this event fires when it is shown Listeners will be called with the following arguments: | Button | | menutriggerout :
- ( Button this , Menu menu , EventObject e )
- If this button has a menu, this event fires when the mouse leaves the menu triggering element If this button has a menu, this event fires when the mouse leaves the menu triggering element Listeners will be called with the following arguments:this : Buttonmenu : Menue : EventObject
| Button | | menutriggerover :
- ( Button this , Menu menu , EventObject e )
- If this button has a menu, this event fires when the mouse enters the menu triggering element If this button has a menu, this event fires when the mouse enters the menu triggering element Listeners will be called with the following arguments:this : Buttonmenu : Menue : EventObject
| Button | | mouseout :
- ( Button this , Event e )
- Fires when the mouse exits the button Fires when the mouse exits the button Listeners will be called with the following arguments:this : Buttone : EventThe event object
| Button | | mouseover :
- ( Button this , Event e )
- Fires when the mouse hovers over the button Fires when the mouse hovers over the button Listeners will be called with the following arguments:this : Buttone : EventThe event object
| 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 :
- ( 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:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| 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 component is hidden when calling the hide method.Listeners will be called with the following arguments: | Component | | menuhide :
+ ( Button this , Menu menu )
+ If this button has a menu, this event fires when it is hidden If this button has a menu, this event fires when it is hidden Listeners will be called with the following arguments: | Button | | menushow :
+ ( Button this , Menu menu )
+ If this button has a menu, this event fires when it is shown If this button has a menu, this event fires when it is shown Listeners will be called with the following arguments: | Button | | menutriggerout :
+ ( Button this , Menu menu , EventObject e )
+ If this button has a menu, this event fires when the mouse leaves the menu triggering element If this button has a menu, this event fires when the mouse leaves the menu triggering element Listeners will be called with the following arguments:this : Buttonmenu : Menue : EventObject
| Button | | menutriggerover :
+ ( Button this , Menu menu , EventObject e )
+ If this button has a menu, this event fires when the mouse enters the menu triggering element If this button has a menu, this event fires when the mouse enters the menu triggering element Listeners will be called with the following arguments:this : Buttonmenu : Menue : EventObject
| Button | | mouseout :
+ ( Button this , Event e )
+ Fires when the mouse exits the button Fires when the mouse exits the button Listeners will be called with the following arguments:this : Buttone : EventThe event object
| Button | | mouseover :
+ ( Button this , Event e )
+ Fires when the mouse hovers over the button Fires when the mouse hovers over the button Listeners will be called with the following arguments:this : Buttone : EventThe event object
| 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 :
+ ( 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:this : Ext.ComponentadjWidth : NumberThe box-adjusted width that was set adjHeight : NumberThe box-adjusted height that was set rawWidth : NumberThe width that was originally specified rawHeight : NumberThe height that was originally specified
| 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 )
+Component. The method maybe overriden to provide custom state restoration. | 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:this : Ext.Componentstate : ObjectThe hash of state values. This is determined by calling
getState() on the Component. This method must be provided by the
developer to return whetever representation of state is required, by default, Ext.Component
-has a null implementation.
| Component | | toggle :
- ( Button this , Boolean pressed )
+has a null implementation. | Component | | toggle :
+ ( Button this , Boolean pressed )
Fires when the 'pressed' state of this button changes (only if enableToggle = true) Fires when the 'pressed' state of this button changes (only if enableToggle = true) Listeners will be called with the following arguments:this : Buttonpressed : Boolean
| Button |
\ No newline at end of file
|