Observable Component Component Container Container SegmentedButton
Package: | Ext |
Defined In: | SegmentedButton.js |
Class: | SegmentedButton |
Extends: | Container |
SegmentedButton is a container for a group of Ext.Buttons. Generally a SegmentedButton would be a child of a Ext.Toolbar and would be used to switch between different views.
var segmentedButton = new Ext.SegmentedButton({
allowMultiple: true,
items: [
{
text: 'Option 1'
},
{
text : 'Option 2',
pressed: true,
handler: tappedFn
},
{
text: 'Option 3'
}
],
listeners: {
toggle: function(container, button, pressed){
console.log("User toggled the '" + button.text + "' button: " + (pressed ? 'on' : 'off'));
}
}
});
Config Options | Defined By | |
---|---|---|
activeItem : String/Number A string component id or the numeric index of the component that should be initially activated within the
container's... A string component id or the numeric index of the component that should be initially activated within the
container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
item in the container's collection). activeItem only applies to layout styles that can display
items one at a time (like Ext.layout.CardLayout and
Ext.layout.FitLayout). Related to Ext.layout.ContainerLayout.activeItem. | Container | |
allowDepress : Boolean Allow to depress a pressed button. (defaults to true when allowMultiple is true) | SegmentedButton | |
allowMultiple : Boolean Allow multiple pressed buttons (defaults to false). | SegmentedButton | |
autoDestroy : Boolean If true the container will automatically destroy any contained component that is removed from it, else
destruction mu... If true the container will automatically destroy any contained component that is removed from it, else
destruction must be handled manually (defaults to true). | Container | |
baseCls : String The base CSS class to apply to this components's element. This will also be prepended to
elements within this compone... The base CSS class to apply to this components's element. This will also be prepended to
elements within this component like Panel's body will get a class x-panel-body. This means
that if you create a subclass of Panel, and you want it to get all the Panels styling for the
element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
component. | Component | |
border : Number/String Specifies the border for this component. The border can be a single numeric value to apply to all sides or
it can be ... Specifies the border for this component. The border can be a single numeric value to apply to all sides or
it can be a CSS style specification for each style, for example: '10 5 3 10'. | Component | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container.
See Ext.util.Observable.enableBubble.
Defaults to | Container | |
cardSwitchAnimation : String/Mixed Animation to be used during transitions of cards. Note this only works when this container has a CardLayout.
Any vali... Animation to be used during transitions of cards. Note this only works when this container has a CardLayout.
Any valid value from Ext.anims can be used ('fade', 'slide', 'flip', 'cube', 'pop', 'wipe').
Defaults to null. | Container | |
centered : Boolean Center the Component. Defaults to false. | Component | |
cls : String An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for ... An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
useful for adding customized styles to the component or any of its children using standard CSS rules. | Component | |
componentCls : String CSS Class to be added to a components root level element to give distinction to it
via styling. | Component | |
componentLayout : String/Object The sizing and positioning of the component Elements is the responsibility of
the Component's layout manager which cr... The sizing and positioning of the component Elements is the responsibility of the Component's layout manager which creates and manages the type of layout specific to the component. If the layout configuration is not explicitly specified for a general purpose compopnent the default layout manager will be used. | Component | |
contentEl : String Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
for this comp... Optional. Specify an existing HTML element, or the
| Component | |
data : Mixed The initial set of data to apply to the tpl to
update the content area of the Component. | Component | |
defaultType : String The default xtype of child Components to create in this Container when
a child item is specified as a raw configurati... The default xtype of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component. Defaults to | Container | |
defaults : Object|Function This option is a means of applying default settings to all added items whether added through the items
config or via ... This option is a means of applying default settings to all added items whether added through the items config or via the add or insert methods. If an added item is a config object, and not an instantiated Component, then the default properties are unconditionally applied. If the added item is an instantiated Component, then the default properties are applied conditionally so as not to override existing properties in the item. If the defaults option is specified as a function, then the function will be called using this Container as the
scope ( For example, to automatically apply padding to the body of each of a set of
contained Ext.Panel items, you could pass: Usage:
| Container | |
disabled : Boolean Defaults to false. | Component | |
disabledCls : String CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'. | Component | |
draggable : Boolean Allows the component to be dragged via the touch event. | Component | |
floating : Boolean Create the Component as a floating and use absolute positioning.
Defaults to false. | Component | |
floatingCls : Boolean The class that is being added to this component when its floating.
(defaults to x-floating) | Component | |
height : Number The height of this component in pixels. | Component | |
hidden : Boolean Defaults to false. | Component | |
hideOnMaskTap : Boolean True to automatically bind a tap listener to the mask that hides the window.
Defaults to true. Note: if you set this ... True to automatically bind a tap listener to the mask that hides the window.
Defaults to true. Note: if you set this property to false you have to programmaticaly
hide the overlay. | Component | |
html : String/Object An HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML conten... An HTML fragment, or a DomHelper specification to use as the layout element
content (defaults to ''). The HTML content is added after the component is rendered,
so the document will not contain this HTML at the time the render event is fired.
This content is inserted into the body before any configured contentEl is appended. | Component | |
items : Object/Array ** IMPORTANT: be sure to specify a layout if needed ! **
A single item, or an array of child Components to be added t... ** IMPORTANT: be sure to specify a
A single item, or an array of child Components to be added to this container, for example:
Each item may be:
Notes: | Container | |
layout : String/Object *Important: In order for child items to be correctly sized and
positioned, typically a layout manager must be specifi... *Important: In order for child items to be correctly sized and
positioned, typically a layout manager must be specified through
the The sizing and positioning of child items is the responsibility of the Container's layout manager which creates and manages the type of layout you have in mind. For example: If the layout configuration is not explicitly specified for a general purpose container (e.g. Container or Panel) the default layout manager will be used which does nothing but render child components sequentially into the Container (no sizing or positioning will be performed in this situation).
The layout type to be used for this container. If not specified, a default Ext.layout.ContainerLayout will be created and used. Valid layout Additional layout specific configuration properties may also be
specified. For complete details regarding the valid config options for
each layout type, see the layout class corresponding to the
The layout Additional layout specific configuration properties. For complete
details regarding the valid config options for each layout type, see the
layout class corresponding to the | Container | |
listeners : Object A config object containing one or more event handlers to be added to this
object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
is usually only done when extra value can be added. For example the DataView's
| Observable | |
margin : Number/String Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
it can be ... Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or
it can be a CSS style specification for each style, for example: '10 5 3 10'. | Component | |
maxHeight : Number The maximum value in pixels which this Component will set its height to.
Warning: This will override any size managem... The maximum value in pixels which this Component will set its height to. Warning: This will override any size management applied by layout managers. | Component | |
maxWidth : Number The maximum value in pixels which this Component will set its width to.
Warning: This will override any size manageme... The maximum value in pixels which this Component will set its width to. Warning: This will override any size management applied by layout managers. | Component | |
minHeight : Number The minimum value in pixels which this Component will set its height to.
Warning: This will override any size managem... The minimum value in pixels which this Component will set its height to. Warning: This will override any size management applied by layout managers. | Component | |
minWidth : Number The minimum value in pixels which this Component will set its width to.
Warning: This will override any size manageme... The minimum value in pixels which this Component will set its width to. Warning: This will override any size management applied by layout managers. | Component | |
modal : Boolean True to make the Component modal and mask everything behind it when displayed, false to display it without
restrictin... True to make the Component modal and mask everything behind it when displayed, false to display it without
restricting access to other UI elements (defaults to false). | Component | |
monitorOrientation : Boolean Monitor Orientation change | Component | |
padding : Number/String Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
it can b... Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or
it can be a CSS style specification for each style, for example: '10 5 3 10'. | Component | |
plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only
requirement for a ... An object or array of objects that will provide custom functionality for this component. The only
requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
When a component is created, if any plugins are available, the component will call the init method on each
plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the
component as needed to provide its functionality. | Component | |
renderTo : Mixed Specify the id of the element, a DOM element or an existing Element that this component
will be rendered into.
Notes ... Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.
See render also. | Component | |
renderTpl : Mixed An XTemplate used to create the Element which will
encapsulate this Component.
You do not normally need to specify th... An XTemplate 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.Component, and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex DOM structure. This is intended to allow the developer to create application-specific utility Components encapsulated by different DOM elements. | Component | |
scroll : Mixed Configure the component to be scrollable. Acceptable values are:
'horizontal', 'vertical', 'both' to enabling scroll... | Component | |
showAnimation : Object/String/Boolean The type of animation you want to use when this component is shown. If you set this
this hide animation will automati... The type of animation you want to use when this component is shown. If you set this
this hide animation will automatically be the opposite. | Component | |
stopMaskTapEvent : Boolean True to stop the event that fires when you click outside the floating component.
Defalts to true. | Component | |
style : String A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.ap... A custom style specification to be applied to this component's Element. Should be a valid argument to
Ext.Element.applyStyles.
| Component | |
styleHtmlCls : String The class that is added to the content target when you set styleHtmlContent to true.
Defaults to 'x-html' | Component | |
styleHtmlContent : String True to automatically style the html inside the content target of this component (body for panels).
Defaults to false... True to automatically style the html inside the content target of this component (body for panels).
Defaults to false. | Component | |
tpl : Mixed An Ext.Template, Ext.XTemplate
or an array of strings to form an Ext.XTemplate.
Used in conjunction with the data and... An data and
tplWriteMode configurations. | Component | |
tplWriteMode : String The Ext.(X)Template method to use when
updating the content area of the Component. Defaults to 'overwrite'
(see Ext.X... The Ext.(X)Template method to use when
updating the content area of the Component. Defaults to 'overwrite'
(see Ext.XTemplate.overwrite ). | Component | |
ui : String A set of predefined ui styles for individual components.
Most components support 'light' and 'dark'.
Extra string add... A set of predefined ui styles for individual components.
Most components support 'light' and 'dark'.
Extra string added to the baseCls with an extra '-'.
The ui configuration in this example would add 'x-component-green' as an additional class. | Component | |
width : Number The width of this component in pixels. | Component |
Property | Defined By | |
---|---|---|
draggable : Boolean Read-only property indicating whether or not the component can be dragged | Component | |
items : Ext.util.MixedCollection The MixedCollection containing all the child items of this container. | Container | |
rendered : Boolean Read-only property indicating whether or not the component has been rendered. | Component |
Method | Defined By | |
---|---|---|
SegmentedButton( Object config )
Parameters:
| SegmentedButton | |
add( ...Object/Array component )
:
Ext.Component/ArrayAdds Component(s) to this Container.
Description :
<ul class="mdetail-params">
Fires the beforeadd event before addin... Adds Component(s) to this Container. Description :
Notes :
Parameters:
| Container | |
addCls()
:
void Adds a CSS class to the top level element representing this component. Adds a CSS class to the top level element representing this component. Parameters:
| Component | |
addEvents( Object|String o , string Optional. )
:
voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
addManagedListener( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
:
voidAdds listeners to any Observable object (or Element) which are automatically removed when this Component
is destroyed... Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. Parameters:
| Observable | |
child( String selector )
:
Ext.ComponentRetrieves the first direct child of this container which matches the passed selector.
The passed in selector must com... Retrieves the first direct child of this container which matches the passed selector.
The passed in selector must comply with an Ext.ComponentQuery selector. Parameters:
| Container | |
clearListeners()
:
void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters:
| Observable | |
clearManagedListeners()
:
void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters:
| Observable | |
destroy()
:
void Destroys the Component. Destroys the Component. Parameters:
| Component | |
disable()
:
void Disables all buttons Disables all buttons Parameters:
| SegmentedButton | |
doComponentLayout()
:
Ext.Container This method needs to be called whenever you change something on this component that requires the components
layout to... This method needs to be called whenever you change something on this component that requires the components
layout to be recalculated. An example is adding, showing or hiding a docked item to a Panel, or changing the
label of a form field. After a component layout, the container layout will automatically be run. So you could
be on the safe side and always call doComponentLayout instead of doLayout. Parameters:
| Component | |
doLayout()
:
Ext.Container Force this container's layout to be recalculated. A call to this function is required after adding a new component
to... Force this container's layout to be recalculated. A call to this function is required after adding a new component
to an already rendered container, or possibly after changing sizing/position properties of child components. Parameters:
| Container | |
down( String selector )
:
Ext.ComponentRetrieves the first descendant of this container which matches the passed selector.
The passed in selector must compl... Retrieves the first descendant of this container which matches the passed selector.
The passed in selector must comply with an Ext.ComponentQuery selector. Parameters:
| Container | |
enable()
:
void Enables all buttons Enables all buttons Parameters:
| SegmentedButton | |
enableBubble( String/Array events )
:
voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example:
Parameters:
| Observable | |
fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters:
| Observable | |
getActiveItem()
:
activeItem Returns the current activeItem for the layout (only for a card layout) Returns the current activeItem for the layout (only for a card layout) Parameters:
| Container | |
getBubbleTarget()
:
Ext.Container Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. Parameters:
| Component | |
getComponent( String/Number comp )
:
Ext.ComponentExamines this container's items property
and gets a direct child component of this container. Examines this container's items property
and gets a direct child component of this container.Parameters:
| Container | |
getEl()
:
void Retrieves the top level element representing this component. Retrieves the top level element representing this component. Parameters:
| Component | |
getHeight()
:
Number Gets the current height of the component's underlying element. Gets the current height of the component's underlying element. Parameters:
| Component | |
getId()
:
void Retrieves the id of this component.
Will autogenerate an id if one has not already been set. Retrieves the id of this component.
Will autogenerate an id if one has not already been set. Parameters:
| Component | |
getInsertPosition( String/Number/Element/HTMLElement position )
:
HTMLElementThis function takes the position argument passed to onRender and returns a
DOM element that you can use in the insert... This function takes the position argument passed to onRender and returns a
DOM element that you can use in the insertBefore. Parameters:
| Component | |
getLayout()
:
Ext.layout.ContainerLayout Returns the layout instance currently associated with this Container.
If a layout has not been instantiated yet, that... Returns the layout instance currently associated with this Container.
If a layout has not been instantiated yet, that is done first Parameters:
| Container | |
getPressed()
:
void Gets the pressed button(s) Gets the pressed button(s) Parameters:
| SegmentedButton | |
getSize()
:
Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters:
| Component | |
getWidth()
:
Number Gets the current width of the component's underlying element. Gets the current width of the component's underlying element. Parameters:
| Component | |
getXTypes()
:
String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage:
Parameters:
| Component | |
hasListener( String eventName )
:
BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
hide( [Object/String/Boolean animation ] )
:
voidHide the component Hide the component Parameters:
| Component | |
insert( Number index , Ext.Component component )
:
Ext.ComponentInserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires ... Inserts a Component into this Container at a specified index. Fires the
beforeadd event before inserting, then fires the add event after the
Component has been inserted. Parameters:
| Container | |
isDisabled()
:
Boolean Method to determine whether this Component is currently disabled. Method to determine whether this Component is currently disabled. Parameters:
| Component | |
isDraggable()
:
Boolean Method to determine whether this Component is draggable. Method to determine whether this Component is draggable. Parameters:
| Component | |
isDroppable()
:
Boolean Method to determine whether this Component is droppable. Method to determine whether this Component is droppable. Parameters:
| Component | |
isFloating()
:
Boolean Method to determine whether this Component is floating. Method to determine whether this Component is floating. Parameters:
| Component | |
isHidden()
:
Boolean Method to determine whether this Component is currently set to hidden. Method to determine whether this Component is currently set to hidden. Parameters:
| Component | |
isVisible()
:
Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
:
BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. For a list of all available xtypes, see the Ext.Component header. Example usage:
Parameters:
| Component | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
:
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
query( String selector )
:
ArrayRetrieves all descendant components which match the passed selector.
Executes an Ext.ComponentQuery.query using this ... Retrieves all descendant components which match the passed selector.
Executes an Ext.ComponentQuery.query using this container as its root. Parameters:
| Container | |
relayEvents( Object o , Array events )
:
voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
remove( Component/String component , [Boolean autoDestroy ] )
:
Ext.ComponentRemoves a component from this container. Fires the beforeremove event before removing, then fires
the remove event a... Removes a component from this container. Fires the beforeremove event before removing, then fires
the remove event after the component has been removed. Parameters:
| Container | |
removeAll( [Boolean autoDestroy ] )
:
ArrayRemoves all components from this container. Removes all components from this container. Parameters:
| Container | |
removeCls()
:
void Removes a CSS class from the top level element representing this component. Removes a CSS class from the top level element representing this component. Parameters:
| Component | |
removeListener( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
removeManagedListener( Observable|Element item , Object|String ename , Function fn , Object scope )
:
voidRemoves listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters:
| Observable | |
resumeEvents()
:
void Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setActiveItem( Ext.Component/Number/Object card , [String/Object cardSwitchAnimation ] )
:
Ext.ContainerAllows you to set the active card in this container. This
method is only available if the container uses a CardLayout... Allows you to set the active card in this container. This
method is only available if the container uses a CardLayout.
Note that a Carousel and TabPanel both get a CardLayout
automatically, so both of those components are able to use this method. Parameters:
| Container | |
setCentered( Boolean centered )
:
voidShow this component centered of its parent or the window
This only applies when the component is floating. Show this component centered of its parent or the window
This only applies when the component is floating. Parameters:
| Component | |
setDisabled( Boolean disabled )
:
voidEnable or disable the component. Enable or disable the component. Parameters:
| Component | |
setDocked()
:
Component Sets the dock position of this component in its parent panel. Note that
this only has effect if this item is part of ... Sets the dock position of this component in its parent panel. Note that
this only has effect if this item is part of the dockedItems collection
of a parent that has a DockLayout (note that any Panel has a DockLayout
by default) Parameters:
| Component | |
setDraggable( Boolean/Mixed draggable , Boolean autoShow )
:
voidSets a Component as draggable. Sets a Component as draggable. Parameters:
| Component | |
setFloating( Boolean floating , Boolean autoShow )
:
voidSets a Component as floating. Sets a Component as floating. Parameters:
| Component | |
setHeight( Number height )
:
Ext.ComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| Component | |
setLoading( Boolean/Object load , Boolean targetEl )
:
Ext.LoadMaskThis method allows you to show or hide a LoadMask on top of this component. This method allows you to show or hide a LoadMask on top of this component. Parameters:
| Component | |
setOrientation( String orientation , Number/String width , Number/String height )
:
voidSets the orientation for the Panel. Sets the orientation for the Panel. Parameters:
| Component | |
setPosition( Number left , Number top )
:
Ext.ComponentSets 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:
| Component | |
setPressed( Number/String/Button position/id/button. , Boolean pressed , Boolean suppressEvents )
:
voidActivates a button Activates a button Parameters:
| SegmentedButton | |
setScrollable( Mixed config )
:
voidSets a Component as scrollable. Sets a Component as scrollable. Parameters:
| Component | |
setSize( Mixed width , Mixed height )
:
Ext.ComponentSets the width and height of this Component. This method fires the resize event. This method can accept
either width ... Sets the width and height of this Component. 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:
| Component | |
setVisible( Boolean visible )
:
Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
:
Ext.ComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| Component | |
show( [Object/String/Boolean animation ] )
:
voidShow the component. Show the component. Parameters:
| Component | |
showBy( Mixed alignTo , Object/String/Boolean animation , Boolean allowOnSide )
:
voidShow this component relative another component or element. Show this component relative another component or element. Parameters:
| Component | |
suspendEvents( Boolean queueSuspended )
:
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
:
voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
:
voidUpdate the content area of a component. Update the content area of a component. Parameters:
| Component |
Event | Defined By | |
---|---|---|
activate :
( Ext.Component this )
Fires after a Component has been visually activated. Fires after a Component has been visually activated. Listeners will be called with the following arguments:
| Component | |
add :
( Ext.Container this , Ext.Component component , Number index )
Listeners will be called with the following arguments:
| Container | |
added :
( Ext.Component this , Ext.Container container , Number pos )
Fires after a Component had been added to a Container. Fires after a Component had been added to a Container. Listeners will be called with the following arguments:
| Component | |
afterlayout :
( Ext.Container this , ContainerLayout layout )
Fires when the components in this container are arranged by the associated layout manager. Fires when the components in this container are arranged by the associated layout manager. Listeners will be called with the following arguments:
| Container | |
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 | |
beforeactivate :
( Ext.Component this )
Fires before a Component has been visually activated.
Returning false from an event listener can prevent the activate... Fires before a Component has been visually activated.
Returning false from an event listener can prevent the activate
from occurring. Listeners will be called with the following arguments:
| Component | |
beforeadd :
( Ext.Container this , Ext.Component component , Number index )
Fires before any Ext.Component is added or inserted into the container.
A handler can return false to cancel the add. Fires before any Ext.Component is added or inserted into the container.
A handler can return false to cancel the add. Listeners will be called with the following arguments:
| Container | |
beforecardswitch :
( Ext.Container this , Ext.Component newCard , Ext.Component oldCard , Number index , Boolean animated )
Fires before this container switches the active card. This event
is only available if this container uses a CardLayou... Fires before this container switches the active card. This event
is only available if this container uses a CardLayout. Note that
TabPanel and Carousel both get a CardLayout by default, so both
will have this event.
A handler can return false to cancel the card switch. Listeners will be called with the following arguments:
| Container | |
beforedeactivate :
( Ext.Component this )
Fires before a Component has been visually deactivated.
Returning false from an event listener can prevent the deacti... Fires before a Component has been visually deactivated.
Returning false from an event listener can prevent the deactivate
from occurring. Listeners will be called with the following arguments:
| Component | |
beforedestroy :
( Ext.Component this )
| Component | |
beforehide :
( Ext.Component this )
Fires before the component is hidden when calling the hide method.
Return false from an event handler to stop the hid... Fires before the component is hidden when calling the hide method.
Return false from an event handler to stop the hide. Listeners will be called with the following arguments:
| Component | |
beforeorientationchange :
( Ext.Panel this , String orientation , Number width , Number height )
Fires before the orientation changes, if the monitorOrientation
configuration is set to true. Return false to stop th... Fires before the orientation changes, if the monitorOrientation
configuration is set to true. Return false to stop the orientation change. Listeners will be called with the following arguments:
| Component | |
beforeremove :
( Ext.Container this , Ext.Component component )
Fires before any Ext.Component is removed from the container. A handler can return
false to cancel the remove. Fires before any Ext.Component is removed from the container. A handler can return
false to cancel the remove. Listeners will be called with the following arguments:
| Container | |
beforerender :
( Ext.Component this )
| Component | |
beforeshow :
( Ext.Component this )
Fires before the component is shown when calling the show method.
Return false from an event handler to stop the show... Fires before the component is shown when calling the show method.
Return false from an event handler to stop the show. Listeners will be called with the following arguments:
| Component | |
cardswitch :
( Ext.Container this , Ext.Component newCard , Ext.Component oldCard , Number index , Boolean animated )
Fires after this container switches the active card. If the card
is switched using an animation, this event will fire... Fires after this container switches the active card. If the card
is switched using an animation, this event will fire after the
animation has finished. This event is only available if this container
uses a CardLayout. Note that TabPanel and Carousel both get a CardLayout
by default, so both will have this event. Listeners will be called with the following arguments:
| Container | |
deactivate :
( Ext.Component this )
Fires after a Component has been visually deactivated. Fires after a Component has been visually deactivated. Listeners will be called with the following arguments:
| Component | |
destroy :
( Ext.Component this )
Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments:
| Component | |
disable :
( Ext.Component this )
Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments:
| Component | |
enable :
( Ext.Component this )
Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments:
| Component | |
hide :
( Ext.Component this )
Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Fires after the component is hidden.
Fires after the component is hidden when calling the hide method. Listeners will be called with the following arguments:
| Component | |
move :
( Ext.Component this , Number x , Number y )
Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments:
| Component | |
orientationchange :
( Ext.Panel this , String orientation , Number width , Number height )
Fires when the orientation changes, if the monitorOrientation
configuration is set to true. Fires when the orientation changes, if the monitorOrientation
configuration is set to true. Listeners will be called with the following arguments:
| Component | |
remove :
( Ext.Container this , Ext.Component component )
Listeners will be called with the following arguments:
| Container | |
removed :
( Ext.Component this , Ext.Container ownerCt )
Fires when a component is removed from an Ext.Container Fires when a component is removed from an Ext.Container Listeners will be called with the following arguments:
| Component | |
render :
( Ext.Component this )
Fires after the component markup is rendered. Fires after the component markup is rendered. Listeners will be called with the following arguments:
| Component | |
resize :
( Ext.Component this , Number adjWidth , Number adjHeight , Number rawWidth , Number rawHeight )
Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments:
| Component | |
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 | |
toggle :
( Ext.SegmentedButton this , Ext.Button button , Boolean pressed )
Fires when any child button's pressed state has changed. Fires when any child button's pressed state has changed. Listeners will be called with the following arguments:
| SegmentedButton |