X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6:/docs/output/Ext.SplitButton.html diff --git a/docs/output/Ext.SplitButton.html b/docs/output/Ext.SplitButton.html index 48ebea83..d706face 100644 --- a/docs/output/Ext.SplitButton.html +++ b/docs/output/Ext.SplitButton.html @@ -1,27 +1,31 @@ -
Observable Component BoxComponent Button SplitButton
Package: | Ext |
Defined In: | SplitButton.js |
Class: | SplitButton |
Subclasses: | CycleButton |
Extends: | Button |
// display a dropdown menu:
-new Ext.SplitButton({
- renderTo: 'button-ct', // the container id
- text: 'Options',
- handler: optionsHandler, // handle a click on the button itself
- menu: new Ext.menu.Menu({
- items: [
- // these items will render as dropdown menu items when the arrow is clicked:
- {text: 'Item 1', handler: item1Handler},
- {text: 'Item 2', handler: item2Handler}
- ]
- })
-});
-
-// Instead of showing a menu, you provide any type of custom
-// functionality you want when the dropdown arrow is clicked:
-new Ext.SplitButton({
- renderTo: 'button-ct',
- text: 'Options',
- handler: optionsHandler,
- arrowHandler: myCustomHandler
+Observable
+ Component
+ BoxComponent
+ Button
+ SplitButton
Class Ext.SplitButton
Package: Ext Defined In: SplitButton.js Class: SplitButton Subclasses: CycleButton Extends: Button
A split button that provides a built-in dropdown arrow that can fire an event separately from the default
+click event of the button. Typically this would be used to display a dropdown menu that provides additional
+options to the primary button action, but any custom handler can provide the arrowclick implementation. Example usage:
+// display a dropdown menu:
+new Ext.SplitButton({
+ renderTo: 'button-ct', // the container id
+ text: 'Options',
+ handler: optionsHandler, // handle a click on the button itself
+ menu: new Ext.menu.Menu({
+ items: [
+ // these items will render as dropdown menu items when the arrow is clicked:
+ {text: 'Item 1', handler: item1Handler},
+ {text: 'Item 2', handler: item2Handler}
+ ]
+ })
+});
+
+// Instead of showing a menu, you provide any type of custom
+// functionality you want when the dropdown arrow is clicked:
+new Ext.SplitButton({
+ renderTo: 'button-ct',
+ text: 'Options',
+ handler: optionsHandler,
+ arrowHandler: myCustomHandler
});
Config Options
Config Options Defined By allowDepress : BooleanFalse to not allow a pressed Button to be depressed (defaults to undefined). Only valid when enableToggle is true. Button allowDomMove : BooleanWhether 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 (or subclass thereof).
@@ -43,14 +47,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.
-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:
-
-- 'right'
-- 'bottom'
-
-Defaults to 'right'.
Button arrowHandler : FunctionA function called when the arrow button is clicked (can be used instead of click event) SplitButton arrowTooltip : StringThe 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
+ 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:
+
+- 'right'
+- 'bottom'
+
+Defaults to 'right'.
Button arrowHandler : FunctionA function called when the arrow button is clicked (can be used instead of click event) SplitButton arrowTooltip : StringThe 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
@@ -86,37 +119,11 @@ result in elements needing to be synchronized with the new height. Example:
<
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
-Container's layout manager. Defaults to false.
-Note: Although many components inherit this config option, not all will
-function as expected with a width of 'auto'. Setting autoWidth:true means that the
-browser will manage width based on the element's contents, and that Ext will not manage it at all.
-If the browser is managing the width, be aware that resizes performed by the browser in response
-to changes within the structure of the Component cannot be detected. Therefore changes to the width might
-result in elements needing to be synchronized with the new width. For example, where the target element is:
<div id='grid-container' style='margin-left:25%;width:50%'></div>
-A Panel rendered into that target element must listen for browser window resize in order to relay its
-child items when the browser changes its width:var myPanel = new Ext.Panel({
- renderTo: 'grid-container',
- monitorResize: true, // relay on browser resize
- title: 'Panel',
- height: 400,
- autoWidth: true,
- layout: 'hbox',
- layoutConfig: {
- align: 'stretch'
- },
- defaults: {
- flex: 1
- },
- items: [{
- title: 'Box 1',
- }, {
- title: 'Box 2'
- }, {
- title: 'Box 3'
- }],
-});
BoxComponent boxMaxHeight : NumberThe maximum value in pixels which this BoxComponent will set its height to.
+them on render (defaults to false). Component autoWidth : BooleanBy default, if a width is not specified the button will attempt to stretch horizontally to fit its content.
+If the bu...By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.
+If the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent
+the button from doing this automatic sizing.
+Defaults to undefined. Button 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.
@@ -124,11 +131,14 @@ Warning: This will override any size manag...The maxi
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.
+Warning: This will override any size management applied by layout managers.
BoxComponent bubbleEvents : ArrayAn array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble....An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.
+Defaults to [].
Component buttonSelector : String(Optional) A DomQuery selector which is used to extract the active, clickable element from the
+DOM structure created.... 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
@@ -137,9 +147,23 @@ 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 : 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 : StringA 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
+See Ext.layout.FormLayout.fieldTpl also.
Component clickEvent : StringThe DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).
+Def...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 : StringA CSS class string to apply to the button's main element. Button contentEl : StringOptional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
+for this comp...Optional. Specify an existing HTML element, or the id
of an existing HTML element to use as the content
+for this component.
+
+- Description :
+This config option is used to take an existing HTML element and place it in the layout element
+of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
+- Notes :
+The specified HTML element is appended to the layout element of the component after any configured
+HTML has been inserted, and so the document will not contain this element at the time the render event is fired.
+The specified HTML element used will not participate in any
layout
+scheme that the Component may use. It is just HTML. Layouts operate on child items
.
+Add either the x-hidden
or the x-hide-display
CSS class to
+prevent a brief flicker of the content before it is rendered to the panel.
+
Component 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.
@@ -150,7 +174,8 @@ 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 : BooleanTrue to start disabled (defaults to false) Button disabledClass : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component enableToggle : BooleanTrue to enable pressed/not pressed toggling (defaults to false) Button fieldLabel : StringThe label text to display next to this Component (defaults to '').
+ Component data : MixedThe initial set of data to apply to the tpl
to
+update the content area of the Component. Component disabled : BooleanTrue to start disabled (defaults to false) Button disabledClass : StringCSS class added to the component when it is disabled (defaults to 'x-item-disabled'). Component enableToggle : BooleanTrue 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.
@@ -170,11 +195,11 @@ by a Container which has been configured to use a BoxComponent
handleMouseEvents : BooleanFalse 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.
+either a flex = 0
or flex = undefined
will not be 'flexed' (the initial size will not be changed).
BoxComponent handleMouseEvents : BooleanFalse 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).
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 : BooleanTrue to start hidden (defaults to false) Button hideLabel : Booleantrue to completely hide the label element
@@ -201,17 +226,21 @@ 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 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'
-
+button on a window by setting hide:true on the button when adding it to its parent container. Component html : String/ObjectAn HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML conten...An HTML fragment, or a DomHelper specification to use as the layout element
+content (defaults to ''). The HTML content is added after the component is rendered,
+so the document will not contain this HTML at the time the render event is fired.
+This content is inserted into the body before any configured contentEl is appended. Component 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'
+
Defaults to 'left'.
Button iconCls : StringA 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
@@ -400,14 +429,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.ove...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.overf...If used in a Toolbar, the
+text to be used if this item is shown in the overflow menu. See also
Ext.Toolbar.Item.overflowText
. Button pageX : NumberThe page level x coordinate for this component if contained within a positioning container. BoxComponent pageY : NumberThe 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.
@@ -462,18 +491,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 (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 : Object 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 : 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
@@ -548,15 +577,22 @@ Ext.Element.ap...
A custom style specification to be appl
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 : StringThe button text to be used as innerHTML (html tags are accepted) Button toggleGroup : StringThe 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 : Ext.Buttonthis Button object
-- state : BooleanThe next state of the Button, true means pressed.
-
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 : StringThe type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. Button type : Stringsubmit, reset or button - defaults to 'button' Button width : NumberThe width of this component in pixels (defaults to auto).
+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 : StringThe button text to be used as innerHTML (html tags are accepted) Button toggleGroup : StringThe 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 : Ext.Buttonthis Button object
+- state : BooleanThe next state of the Button, true means pressed.
+
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 : StringThe type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute. Button tpl : MixedAn Ext.Template, Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data and...An Ext.Template , Ext.XTemplate
+or an array of strings to form an Ext.XTemplate.
+Used in conjunction with the data
and
+tplWriteMode
configurations. Component tplWriteMode : StringThe Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.X...The Ext.(X)Template method to use when
+updating the content area of the Component. Defaults to 'overwrite'
+(see Ext.XTemplate.overwrite
). Component type : Stringsubmit, 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 : NumberThe 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
@@ -569,8 +605,8 @@ The predefined xtypes are listed Ext.ComponentMgr.registerType in order to be able to
-take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By 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,
+take advantage of lazy instantiation and rendering. Component y : NumberThe local y (top) coordinate for this component if contained within a positioning container. BoxComponent
Public Properties
Property Defined By 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 : BooleanRead-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
@@ -588,7 +624,7 @@ config for a suggestion, or use a render listener directly:
new
single: true // Remove the listener after first invocation
}
});
-See also getEl
Component hidden : BooleanRead-only. True if this button is hidden Button initialConfig : ObjectThis Component's initial configuration specification. Read-only. Component menu : Menu
+See also getEl
Component hidden : BooleanRead-only. True if this button is hidden Button initialConfig : ObjectThis 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.
@@ -654,7 +690,12 @@ Or a shorthand syntax:
scope: this
});Returns:- void
Observable applyToMarkup( String/HTMLElement el
)
:
- voidApply this component to existing markup that is valid. With this function, no call to render() is required.Apply this component to existing markup that is valid. With this function, no call to render() is required.Parameters:el
: String/HTMLElement
Returns:- void
Component cloneConfig( Object overrides
)
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required.Apply this component to existing markup that is valid. With this function, no call to render() is required.Parameters:el
: String/HTMLElement
Returns:- void
Component bubble( Function fn
, [Object scope
], [Array args
] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped.Parameters:fn
: FunctionThe function to callscope
: Object(optional) The scope of the function (defaults to current node)args
: Array(optional) The args to call the function with (default to passing the current component)
Returns:Ext.Component
this
Component cloneConfig( Object overrides
)
:
Ext.ComponentClone the current component using the original config values passed into this instance by default.Clone the current component using the original config values passed into this instance by default.Parameters:overrides
: ObjectA new config containing any properties to override in the cloned version.
An id property can be passed on this object, otherwise one will be generated to avoid duplicates.
Returns:Ext.Component
clone The cloned copy of this component
Component destroy()
@@ -669,52 +710,54 @@ should usually not need to be called directly.Enable this component and fire the 'enable' event.Enable this component and fire the 'enable' event.Parameters:- None.
Returns:Ext.Component
this
Component enableBubble( String/Array events
)
:
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present...Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
-This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
-access the required target more quickly.
-Example:
Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Observable findParentBy( Function fn
)
:
Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
true, the con...Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned.Parameters:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Class xtype
)
+true, the container will be returned.Parameters:fn
: FunctionThe custom function to call with the arguments (container, this component).
Returns:Ext.Container
The first Container for which the custom function returns true
Component findParentByType( String/Ext.Component/Class xtype
, [Boolean shallow
] )
:
- Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/ClassThe xtype string for a component, or the class of the component directly
Returns:Ext.Container
The first Container which matches the given xtype or class
Component fireEvent( String eventName
, Object... args
)
+ Ext.ContainerFind a container above this component at any level by xtype or classFind a container above this component at any level by xtype or classParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class:shallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
+the default), or true to check whether this Component is directly of the specified xtype.
Returns:Ext.Container
The first Container which matches the given 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...Fires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)
-by calling enableBubble.
Parameters:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus()
+by calling enableBubble.Parameters:eventName
: StringThe name of the event to fire.args
: Object...Variable number of parameters are passed to handlers.
Returns:Boolean
returns false if any of the handlers return false otherwise it returns true.
Observable focus( [Boolean selectText
], [Boolean/Number delay
] )
:
- voidFocus the buttonFocus the buttonParameters:- None.
Returns:- void
Button getBox( [Boolean local
] )
+ Ext.ComponentTry to focus this component.Try to focus this component.Parameters:selectText
: Boolean(optional) If applicable, true to also select the text in this componentdelay
: Boolean/Number(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)
Returns:Ext.Component
this
Component getBox( [Boolean local
] )
:
ObjectGets the current box measurements of the component's underlying element.Gets the current box measurements of the component's underlying element.Parameters:local
: Boolean(optional) If true the element's left and top are returned instead of page XY (defaults to false)
Returns:Object
box An object in the format {x, y, width, height}
BoxComponent getBubbleTarget()
:
@@ -768,18 +811,18 @@ This Element is returned as the resizeEl
.Gets the current size of the component's underlying element.Gets the current size of the component's underlying element.Parameters:- None.
Returns:Object
An object containing the element's size {width: (element width), height: (element height)}
BoxComponent getTemplateArgs()
:
- 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.
+ ArrayThis method returns an Array which provides substitution parameters for the Template used
+to create this Button's DOM...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.
Parameters:- None.
Returns:Array
Substitution data for a Template.
Button getText()
:
StringGets the text for this ButtonGets the text for this ButtonParameters:- None.
Returns:String
The button text
Button getWidth()
@@ -813,7 +856,7 @@ the component is configured to be Hide this button's menu (if it has one)Hide this button's menu (if it has one)Parameters:- None.
Returns:- void
Button isVisible()
:
- BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String xtype
, [Boolean shallow
] )
+ BooleanReturns true if this component is visible.Returns true if this component is visible.Parameters:- None.
Returns:Boolean
True if this component is visible, false otherwise.
Component isXType( String/Ext.Component/Class xtype
, [Boolean shallow
] )
:
BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th...Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
@@ -825,7 +868,11 @@ to participate in determination of inherited xtypes.
var t = new Ext.form.TextField();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent
-var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
Parameters:xtype
: StringThe xtype to check for this Componentshallow
: Boolean(optional) False to check whether this Component is descended from the xtype (this is
+var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instanceParameters:xtype
: String/Ext.Component/ClassThe xtype to check for this Component. Note that the the component can either be an instance
+or a component class:
+var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.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:Boolean
True if this component descends from the specified xtype, false otherwise.
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
@@ -898,21 +945,21 @@ events fired during event suspension will be sent to any listeners now.Convenience function for setting disabled/enabled by boolean.Convenience function for setting disabled/enabled by boolean.Parameters:disabled
: Boolean
Returns:Ext.Component
this
Component setHandler( Function handler
, [Object scope
] )
:
- Ext.ButtonAssigns this Button's click handlerAssigns this Button's click handlerParameters:handler
: FunctionThe function to call when the button is clickedscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
-Defaults to this Button.
Returns:Ext.Button
this
Button setHeight( Number height
)
+ Ext.ButtonAssigns this Button's click handlerAssigns this Button's click handlerParameters:handler
: FunctionThe function to call when the button is clickedscope
: Object(optional) The scope (this
reference) in which the handler function is executed.
+Defaults to this Button.
Returns:Ext.Button
this
Button setHeight( Mixed height
)
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event.Sets the height of the component. This method fires the resize event.Parameters: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).
+ 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
: MixedThe new height to set. This may be one of:
+- A Number specifying the new height in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
Returns:Ext.BoxComponent
this
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
+ Ext.ButtonSets the background image (inline style) of the button. This method also changes
+the value of the icon config intern...Sets the background image (inline style) of the button. This method also changes
the value of the icon config internally.Parameters:icon
: StringThe path to an image to display in the button
Returns:Ext.Button
this
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.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.Parameters:cls
: StringThe CSS class providing the icon image
Returns:Ext.Button
this
Button setPagePosition( Number x
, Number y
)
:
Ext.BoxComponentSets the page XY position of the component. To set the left and top instead, use setPosition.
@@ -939,15 +986,15 @@ This may be one of:
:
Ext.ButtonSets this Button's textSets this Button's textParameters:text
: StringThe button text
Returns:Ext.Button
this
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.
+ 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:Ext.Button
this
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.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Number width
)
+ Ext.ComponentConvenience function to hide or show this component by boolean.Convenience function to hide or show this component by boolean.Parameters:visible
: BooleanTrue to show, false to hide
Returns:Ext.Component
this
Component setWidth( Mixed width
)
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event.Sets the width of the component. This method fires the resize event.Parameters:width
: NumberThe new width to setThis may be one of:
-- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
+ 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
: MixedThe new width to set. This may be one of:
+- A Number specifying the new width in the Element's defaultUnits (by default, pixels).
- A String used to set the CSS width style.
Returns:Ext.BoxComponent
this
BoxComponent show()
: