Ext.form.CheckboxGroupxtype: checkboxgroup

Adds Component(s) to this Container.

Description:

• Fires the beforeadd event before adding.
• The Container's default config values will be applied accordingly (see defaults for details).
• Fires the add event after the component has been added.

Notes:

If the Container is already rendered when add is called, it will render the newly added Component into its content area.

If the Container was configured with a size-managing layout manager, the Container will recalculate its internal layout at this time too.

Note that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.

If adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.

tb = new Ext.toolbar.Toolbar({
    renderTo: document.body
});  // toolbar is rendered
tb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. (defaultType for Toolbar is 'button')

Warning:##

Components directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for BorderLayout for more details.

Parameters

• Component : ...Object/Array

  Either one or more Components to add or an Array of Components to add. See items for additional information.

Returns

• Ext.Component/Array   

  The Components that were added.

@deprecated 4.0 Replaced by {link:#addCls} Adds a CSS class to the top level element representing this component.

Parameters

• cls : String

  The CSS class name to add

Returns

• Ext.Component   

  Returns the Component to allow method chaining.

Adds a CSS class to the top level element representing this component.

Parameters

• cls : String

  The CSS class name to add

Returns

• Ext.Component   

  Returns the Component to allow method chaining.

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component.

Parameters

• cls : String/Array

  A string or an array of strings to add to the uiCls

Returns

• void   

Adds the specified events to the list of events which this Observable may fire.

Parameters

• o : Object/String

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

• : String

  [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

  this.addEvents('storeloaded', 'storecleared');
  

Returns

• void   

Appends an event handler to this object.

Parameters

• eventName : String

  The name of the event to listen for. May also be an object who's property names are event names. See

• handler : Function

  The 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:

  • scope : Object
    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
  • delay : Number
    The number of milliseconds to delay the invocation of the handler after the event fires.
  • single : Boolean
    True to add a handler to handle just the next firing of the event, and then remove itself.
  • buffer : Number
    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
  • target : Observable
    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
  • element : String
    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

    new Ext.panel.Panel({
        title: 'The title',
        listeners: {
            click: this.handlePanelClick,
            element: 'body'
        }
    });
    

    When added in this way, the options available are the options applicable to Ext.core.Element.addListener

  
  

  Combining Options
  Using the options argument, it is possible to combine different types of listeners:
  
  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, this, {
  single: true,
  delay: 100
  });

  Attaching multiple handlers in 1 call
  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

  myGridPanel.on({
      cellClick: this.onCellClick,
      mouseover: this.onMouseOver,
      mouseout: this.onMouseOut,
      scope: this // Important. Ensure "this" is correct during handler execution
  });
  

  .

Returns

• void   

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

• item : Observable/Element

  The item to which to add a listener/listeners.

• ename : Object/String

  The event name, or an object containing event name properties.

• fn : Function

  Optional. If the ename parameter was an event name, this is the handler function.

• scope : Object

  Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• opt : Object

  Optional. If the ename parameter was an event name, this is the addListener options.

Returns

• void   

Add events that will trigger the state to be saved.

Parameters

• events : String/Array

  The event name or an array of event names.

Returns

• void   

Parameters

• adjWidth : Number

  The box-adjusted width that was set

• adjHeight : Number

  The box-adjusted height that was set

• isSetSize : Boolean

  Whether or not the height/width are stored on the component permanently

• layoutOwner : Ext.Component

  Component which sent the layout. Only used when isSetSize is false.

Returns

• void   

Aligns this floating Component to the specified element

Parameters

• element : Mixed

  The element or Ext.Component to align to. If passing a component, it must be a omponent instance. If a string id is passed, it will be used as an element id.

• position : String

  (optional, defaults to "tl-bl?") The position to align to (see Ext.core.Element.alignTo for more details).

• offsets : Array

  (optional) Offset the positioning by [x, y]

Returns

• Component   

  this

Perform custom animation on this object.

This method is applicable to both the the Component class and the Element class. It performs animated transitions of certain properties of this object over a specified timeline.

The sole parameter is an object which specifies start property values, end property values, and properties which describe the timeline. Of the properties listed below, only to is mandatory.

Properties include

• from
  An object which specifies start values for the properties being animated. If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon ths object being animated. See the sections below on Element and Component animation.
• to
  An object which specifies end values for the properties being animated.
• duration
  The duration in milliseconds for which the animation will run.
• easing
  A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:

  • ease
  • easeIn
  • easeOut
  • easeInOut
  • backIn
  • backOut
  • elasticIn
  • elasticOut
  • bounceIn
  • bounceOut
• keyframes
  This is an object which describes the state of animated properties at certain points along the timeline. it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
• listeners
  This is a standard listeners configuration object which may be used to inject behaviour at either the beforeanimate event or the afteranimate event.

Animating an Element

• x
  The page X position in pixels.
• y
  The page Y position in pixels
• left
  The element's CSS left value. Units must be supplied.
• top
  The element's CSS top value. Units must be supplied.
• width
  The element's CSS width value. Units must be supplied.
• height
  The element's CSS height value. Units must be supplied.
• scrollLeft
  The element's scrollLeft value.
• scrollTop
  The element's scrollLeft value.
• opacity
  The element's opacity value. This must be a value between 0 and 1.

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to directly animate certain properties of Components.

Animating a Component

• x
  The Component's page X position in pixels.
• y
  The Component's page Y position in pixels
• left
  The Component's left value in pixels.
• top
  The Component's top value in pixels.
• width
  The Component's width value in pixels.
• width
  The Component's width value in pixels.
• dynamic
  Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:

myWindow = Ext.create('Ext.window.Window', {
    title: 'Test Component animation',
    width: 500,
    height: 300,
    layout: {
        type: 'hbox',
        align: 'stretch'
    },
    items: [{
        title: 'Left: 33%',
        margins: '5 0 5 5',
        flex: 1
    }, {
        title: 'Left: 66%',
        margins: '5 5 5 5',
        flex: 2
    }]
});
myWindow.show();
myWindow.header.el.on('click', function() {
    myWindow.animate({
        to: {
            width: (myWindow.getWidth() == 500) ? 700 : 500,
            height: (myWindow.getHeight() == 300) ? 400 : 300,
        }
    });
});

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

Parameters

• config : Object

  An object containing properties which describe the animation's start and end states, and the timeline of the animation.

Returns

• Object   

  this

Applies the state to the object. This should be overridden in subclasses to do more complex state operations. By default it applies the state properties onto the current object.

Parameters

• state : Object

  The state

Returns

• void   

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to prevent excessive firing of change events. This is useful for instance if the field has sub-fields which are being updated as a group; you don't want the container field to check its own changed state for each subfield change.

Parameters

• fn : Object

  A function containing the transaction code

Returns

• void   

Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from being executed.

Parameters

• adjWidth : Number

  The box-adjusted width that was set

• adjHeight : Number

  The box-adjusted height that was set

• isSetSize : Boolean

  Whether or not the height/width are stored on the component permanently

• layoutOwner : Ext.Component

  Component which sent the layout. Only used when isSetSize is false.

Returns

• void   

Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout from being executed.

Returns

• void   

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 : Function

  The function to call

• scope : 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

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

• o : Observable

  The Observable to capture events from.

• fn : Function

  The function to call when an event is fired.

• scope : Object

  (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

• void   

Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with each component. The scope (this reference) of the 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 cascade is stopped on that branch.

Parameters

• fn : Function

  The function to call

• scope : Object

  (optional) The scope of the function (defaults to current component)

• args : Array

  (optional) The args to call the function with. The current component always passed as the last argument.

Returns

• Ext.Container   

  this

Center this Component in its container.

Returns

• Component   

  this

Checks whether the value of the field has changed since the last time it was checked. If the value has changed, it:

1. Fires the change event,
2. Performs validation if the validateOnChange config is enabled, firing the validationchange event if the validity has changed, and
3. Checks the dirty state of the field and fires the dirtychange event if it has changed.

Returns

• void   

Checks the isDirty state of the field and if it has changed since the last time it was checked, fires the dirtychange event.

Returns

• void   

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

• selector : String

  An Ext.ComponentQuery selector

Returns

• void   

  Ext.Component

Removes all listeners for this object including the managed listeners

Returns

• void   

Removes all managed listeners for this object.

Returns

• void   

Clone the current component using the original config values passed into this instance by default.

Parameters

• overrides : Object

  A 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

Destroys this stateful object.

Returns

• void   

Disable the component.

Parameters

• silent : Boolean

  Passing true, will supress the 'disable' event from being fired.

Returns

• void   

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

Returns

• void   

This method needs to be called whenever you change something on this component that requires the Component's layout to be recalculated.

Parameters

• width : Object
• height : Object
• isSetSize : Object
• ownerCt : Object

Returns

• Ext.container.Container   

  this

Moves this floating Component into a constrain region.

By default, this Component is constrained to be within the container it was added to, or the element it was rendered to.

An alternative constraint may be passed.

Parameters

• constrainTo : Mixed

  Optional. The Element or Region into which this Component is to be constrained.

Returns

• void   

Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts form most cases.

Returns

• Ext.container.Container   

  this

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector.

Parameters

• selector : String

  An Ext.ComponentQuery selector

Returns

• void   

  Ext.Component

Enable the component

Parameters

• silent : Boolean

  Passing false will supress the 'enable' event from being fired.

Returns

• void   

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.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, 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/Array

  The event name to bubble, or an Array of event names.

Returns

• void   

Only relevant if the instance's isFileUpload method returns true. Returns a reference to the file input DOM element holding the user's selected file. The input will be appended into the submission form and will not be returned, so this method should also create a replacement.

Returns

• HTMLInputElement   

This method finds the topmost active layout who's processing will eventually determine the size and position of this Component.

This method is useful when dynamically adding Components into Containers, and some processing must take place after the final sizing and positioning of the Component has been performed.

Returns

• void   

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 : Function

  The custom function to call with the arguments (container, this component).

Returns

• Ext.container.Container   

  The first Container for which the custom function returns true

Find a container above this component at any level by xtype or class

See also the up method.

Parameters

• xtype : String/Class

  The xtype string for a component, or the class of the component directly

Returns

• Ext.container.Container   

  The first Container which matches the given xtype or class

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 : String

  The 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.

Try to focus this component.

Parameters

• selectText : Boolean

  (optional) If applicable, true to also select the text in this component

• delay : Boolean/Number

  (optional) Delay the focus this number of milliseconds (true for 10 milliseconds).

Returns

• Ext.Component   

  this

Returns thq current animation if this object has any effects actively running or queued, else returns false.

Returns

• Mixed   

  anim if element has active effects, else false

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.

Returns

• String   

  The active error message on the component; if there is no error, an empty string is returned.

Gets an Array of any active error messages currently applied to the field. This does not trigger validation on its own, it merely returns any messages that the component may already hold.

Returns

• Array   

  The active error messages on the component; if there are no errors, an empty Array is returned.

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}

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

Returns

• Ext.container.Container   

  the Container which owns this Component.

Return the immediate child Component in which the passed element is located.

Parameters

• el : Object

  The element to test.

Returns

• Component   

  The child item which contains the passed element.

Takes an Array of invalid Ext.form.field.Field objects and builds a combined list of error messages from them. Defaults to prepending each message by the field name and a colon. This can be overridden to provide custom combined error message handling, for instance changing the format of each message or sorting the array (it is sorted in order of appearance by default).

Parameters

• invalidFields : Array

  An Array of the sub-fields which are currently invalid.

Returns

• Array   

  The combined list of error messages

Examines this container's items property and gets a direct child component of this container.

Parameters

• comp : String/Number

  This parameter may be any of the following:

  • a String : representing the itemId or id of the child component
  • a Number : representing the position of the child component within the items property

  For additional information see Ext.util.MixedCollection.get.

Returns

• void   

  Ext.Component The component (if found).

Retrieves the top level element representing this component.

Returns

• void   

Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be overridden to provide

Returns

• String   

  The configured field label, or empty string if not defined

Gets the current height of the component's underlying element.

Returns

• Number   

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

• void   

Get the input id, if any, for this component. This is used as the "for" attribute on the label element. Implementing subclasses may also use this as e.g. the id for their own input element.

Returns

• String   

  The input id

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insertBefore.

Parameters

• position : String/Number/Element/HTMLElement

  Index, element id or element you want to put this component before.

Returns

• HTMLElement   

  DOM element that you can use in the insertBefore

Returns the layout instance currently associated with this Container. If a layout has not been instantiated yet, that is done first

Returns

• Ext.layout.container.AbstractContainer   

  The layout

Gets the Ext.ComponentLoader for this Component.

Returns

• Ext.ComponentLoader   

  The loader instance, null if it doesn't exist.

Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRecord is called. Typically this will be an object with a single name-value pair, the name being this field's name and the value being its current data value. More advanced field implementations may return more than one name-value pair. The returned values will be saved to the corresponding field names in the Model.

Note that the values returned from this method are not guaranteed to have been successfully validated.

Returns

• Object   

  A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted.

Returns the name attribute of the field. This is used as the parameter name when including the field value in a form submit().

Returns

• String   

  name The field name

Retrieves a plugin by its pluginId which has been bound to this component.

Parameters

• pluginId : Object

Returns

• Ext.AbstractPlugin   

  pluginInstance

Gets the current XY position 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

• Array   

  The XY position of the element (e.g., [100, 200])

Gets the current size of the component's underlying element.

Returns

• Object   

  An object containing the element's size {width: (element width), height: (element height)}

Gets the current state of the object. By default this function returns null, it should be overridden in subclasses to implement methods for getting the state.

Returns

• Object   

  The current state

Gets the state id for this object.

Returns

• String   

  The state id, null if not found.

Returns the parameter(s) that would be included in a standard form submit for this field. Typically this will be an object with a single name-value pair, the name being this field's name and the value being its current stringified value. More advanced field implementations may return more than one name-value pair.

Note that the values returned from this method are not guaranteed to have been successfully validated.

Returns

• Object   

  A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be submitted.

Gets the current width of the component's underlying element.

Returns

• Number   

Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all available xtypes, see the Ext.Component header. Example usage:

var t = new Ext.form.field.Text();
alert(t.getXType());  // alerts 'textfield'

Returns

• String   

  The xtype

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.field.Text();
alert(t.getXTypes());  // alerts 'component/field/textfield'

Returns

• String   

  The xtype hierarchy string

Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely looks for any message that the component may already hold.

Returns

• Boolean   

Checks to see if this object has any listeners for a specified event

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean   

  True if the event is being listened for, else false

Checks if there is currently a specified uiCls

Parameters

• cls : String

  The cls to check

Returns

• void   

Hides this Component, setting it to invisible using the configured hideMode.

Parameters

• animateTarget : String/Element/Component

  Optional, and only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding (defaults to null with no animation)

• callback : Function

  (optional) A callback function to call after the Component is hidden.

• scope : Object

  (optional) The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

• Ext.Component   

  this

Initializes this Field mixin on the current instance. Components using this mixin should call this method during their own initialization process.

Returns

• void   

Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

Returns

• void   

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

• index : Number

  The index at which the Component will be inserted into the Container's items collection

• component : Ext.Component

  The child Component to insert.
  
  Ext uses lazy rendering, and will only render the inserted Component should it become necessary.
  
  A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component.xtype config property to the registered type of the Component wanted.
  
  For a list of all available xtypes, see Ext.Component.

Returns

• Ext.Component   

  component The Component (or config object) that was inserted with the Container's default config values applied.

Tests whether this Component matches the selector string.

Parameters

• selector : String

  The selector string to test against.

Returns

• Boolean   

  True if this Component matches the selector.

Determines whether this component is the descendant of a particular container.

Parameters

• container : Ext.Container

Returns

• Boolean   

  isDescendant

Returns true if the value of this Field has been changed from its originalValue. Will always return false if the field is disabled.

Note that if the owning form was configured with trackResetOnLoad then the originalValue is updated when the values are loaded by Ext.form.Basic.setValues.

Returns

• Boolean   

  True if this field has been changed from its original value (and is not disabled), false otherwise.

Method to determine whether this Component is currently disabled.

Returns

• Boolean   

  the disabled state of this Component.

Method to determine whether this Component is draggable.

Returns

• Boolean   

  the draggable state of this component.

Method to determine whether this Component is droppable.

Returns

• Boolean   

  the droppable state of this component.

Returns whether two field values are logically equal. Field implementations may override this to provide custom comparison logic appropriate for the particular field's data type.

Parameters

• value1 : Mixed

  The first value to compare

• value2 : Mixed

  The second value to compare

Returns

• Boolean   

  True if the values are equal, false if inequal.

Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for submitting the form via AJAX. See Ext.form.Basic.hasUpload for details. If this returns true, the extractFileInput method must also be implemented to return the corresponding file input element.

Returns

• Boolean   

Method to determine whether this Component is floating.

Returns

• Boolean   

  the floating state of this component.

Method to determine whether this Component is currently set to hidden.

Returns

• Boolean   

  the hidden state of this Component.

Returns whether or not the field value is currently valid by validating the field's current value. The validitychange event will not be fired; use validate instead if you want the event to fire. Note: disabled fields are always treated as valid.

Implementations are encouraged to ensure that this method does not have side-effects such as triggering error message display.

Returns

• Boolean   

  True if the value is valid, else false

Returns true if this component is visible.

Parameters

• deep : Boolean

  .

  Optional. Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user.

  Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

Returns

• Boolean   

  True if this component is visible, false otherwise.

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:

var t = new Ext.form.field.Text();
var isText = t.isXType('textfield');        // true
var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance

Parameters

• xtype : String

  The 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

• Boolean   

  True if this component descends from the specified xtype, false otherwise.

Moves a Component within the Container

Parameters

• fromIdx : Number

  The index the Component you wish to move is currently at.

• toIdx : Number

  The new index for the Component.

Returns

• Ext.Component   

  component The Component (or config object) that was moved.

Returns the next node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with pnextSibling.

Parameters

• selector : String

  Optional A ComponentQuery selector to filter the following nodes.

• includeSelf : Object

Returns

• void   

  The next node (or the next node which matches the selector). Returns null if there is no matching node.

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed ComponentQuery selector.

May also be refered to as next()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

Parameters

• selector : String

  Optional A ComponentQuery selector to filter the following items.

Returns

• void   

  The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

• c : Function

  The class constructor to make observable.

• listeners : Object

  An object containing a series of listeners to add. See addListener.

Returns

• void   

Appends an event handler to this object (shorthand for addListener.)

Parameters

• eventName : String

  The type of event to listen for

• handler : Function

  The 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

• void   

Returns the previous node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

• selector : String

  Optional. A ComponentQuery selector to filter the preceding nodes.

• includeSelf : Object

Returns

• void   

  The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed ComponentQuery selector.

May also be refered to as prev()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

Parameters

• selector : String

  Optional. A ComponentQuery selector to filter the preceding items.

Returns

• void   

  The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.

Parameters

• selector : String

  Selector complying to an Ext.ComponentQuery selector

Returns

• Array   

  Ext.Component's which matched the selector

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

• origin : Object

  The Observable whose events this object is to relay.

• events : Array

  Array of event names to relay.

• prefix : Object

Returns

• void   

Removes all added captures from the Observable.

Parameters

• o : Observable

  The Observable to release

Returns

• void   

Removes a component from this container. Fires the beforeremove event before removing, then fires the remove event after the component has been removed.

Parameters

• component : Component/String

  The component reference or id to remove.

• autoDestroy : Boolean

  (optional) True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config.

Returns

• Ext.Component   

  component The Component that was removed.

Removes all components from this container.

Parameters

• autoDestroy : Boolean

  (optional) True to automatically invoke the removed Component's Ext.Component.destroy function. Defaults to the value of this Container's autoDestroy config.

Returns

• Array   

  Array of the destroyed components

Removes a CSS class from the top level element representing this component.

Parameters

• className : Object

Returns

• Ext.Component   

  Returns the Component to allow method chaining.

Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes it from all elements of this component.

Parameters

• cls : String/Array

  A string or an array of strings to remove to the uiCls

Returns

• void   

Removes an event handler.

Parameters

• eventName : String

  The type of event the handler was associated with.

• handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object

  (optional) The scope originally specified for the handler.

Returns

• void   

Removes listeners that were added by the mon method.

Parameters

• item : Observable|Element

  The item from which to remove a listener/listeners.

• ename : Object|String

  The event name, or an object containing event name properties.

• fn : Function

  Optional. If the ename parameter was an event name, this is the handler function.

• scope : Object

  Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

• void   

Resets the field's originalValue property so it matches the current value. This is called by Ext.form.Basic.setValues if the form's trackResetOnLoad property is set to true.

Returns

• void   

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.

Returns

• void   

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the opposite of syncFx.

Returns

• Ext.core.Element   

  The Element

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

If a Window is superceded by another Window, deactivating it hides its shadow.

This method also fires the activate or deactivate event depending on which action occurred.

Parameters

• active : Boolean

  True to activate the Component, false to deactivate it (defaults to false)

• newActive : Component

  The newly active Component which is taking over topmost zIndex position.

Returns

• void   

Sets the active error message to the given string. This replaces the entire error message contents with the given string. Also see setActiveErrors which accepts an Array of messages and formats them according to the activeErrorsTpl.

Parameters

• msg : String

  The error message

Returns

• void   

Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string.

Parameters

• errors : Array

  The error messages

Returns

• void   

Sets the overflow on the content element of the component.

Parameters

• scroll : Boolean

  True to allow the Component to auto scroll.

Returns

• Ext.Component   

  this

Enable or disable the component.

Parameters

• disabled : Boolean

Returns

• void   

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

• dock : Object
• layoutParent : Object

Returns

• Component   

  this

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given object, check if this component hasOwnProperty that config; if not then it's inheriting a default value from its prototype and we should apply the default value.

Parameters

• defaults : Object

  The defaults to apply to the object.

Returns

• void   

Sets the height of the component. This method fires the resize event.

Parameters

• height : Number

  The new height to set. This may be one of:

  • A Number specifying the new height in the Element's Ext.core.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS height style.
  • undefined to leave the height unchanged.

Returns

• Ext.Component   

  this

This method allows you to show or hide a LoadMask on top of this component.

Parameters

• load : Boolean/Object/String

  True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask.

• targetEl : Boolean

  True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)

Returns

• Ext.LoadMask   

  The LoadMask instance that has just been shown.

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 : Number

  The new x position

• y : Number

  The new y position

• animate : Mixed

  If passed, the Component is animated into its new position. If this parameter is a number, it is used as the animation duration in milliseconds.

Returns

• Ext.Component   

  this

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 : Number

  The new left

• top : Number

  The new top

• animate : Mixed

  If true, the Component is animated into its new position. You may also pass an animation configuration.

Returns

• Ext.Component   

  this

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

• width : Mixed

  The new width to set. This may be one of:

  • A Number specifying the new width in the Element's Ext.core.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS width style.
  • A size object in the format {width: widthValue, height: heightValue}.
  • undefined to leave the width unchanged.

• height : Mixed

  The new height to set (not required if a size object is passed as the first arg). This may be one of:

  • A Number specifying the new height in the Element's Ext.core.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

• Ext.Component   

  this

Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any uiCls set on the component and rename them so they include the new UI

Parameters

• ui : String

  The new UI for the component

Returns

• void   

Convenience function to hide or show this component by boolean.

Parameters

• visible : Boolean

  True to show, false to hide

Returns

• Ext.Component   

  this

Sets the width of the component. This method fires the resize event.

Parameters

• width : Number

  The new width to setThis may be one of:

  • A Number specifying the new width in the Element's Ext.core.Element.defaultUnits (by default, pixels).
  • A String used to set the CSS width style.

Returns

• Ext.Component   

  this

Shows this Component, rendering it first if autoRender or {"floating are true.

After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

Parameters

• animateTarget : String/Element

  Optional, and only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening (defaults to null with no animation)

• callback : Function

  (optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.

• scope : Object

  (optional) The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

• Component   

  this

@deprecated 4.0 Replaced by stopAnimation Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

Returns

• Ext.core.Element   

  The Element

Suspend the firing of all events. (see resumeEvents)

Parameters

• queueSuspended : Boolean

  Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

• void   

Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite of sequenceFx.

Returns

• Ext.core.Element   

  The Element

Sends this Component to the back of (lower z-index than) any other visible windows

Returns

• Component   

  this

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

• preventFocus : Boolean

  (optional) Specify true to prevent the Component from being focused.

Returns

• Component   

  this

Removes an event handler (shorthand for removeListener.)

Parameters

• eventName : String

  The type of event the handler was associated with.

• handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

• scope : Object

  (optional) The scope originally specified for the handler.

Returns

• void   

Clears the active error.

Returns

• void   

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

• selector : String

  Optional. The simple selector to test.

Returns

• Container   

  The matching ancestor Container (or undefined if no match was found).

Update the content area of a component.

Parameters

• htmlOrData : Mixed

  If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.core.Element update

• loadScripts : Boolean

  (optional) Only legitimate when using the html configuration. Defaults to false

• callback : Function

  (optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading

Returns

• void   

Sets the current box measurements of the component's underlying element.

Parameters

• box : Object

  An object in the format {x, y, width, height}

Returns

• Ext.Component   

  this

Returns whether or not the field value is currently valid by validating the field's current value, and fires the validitychange event if the field's validity has changed since the last validation. Note: disabled fields are always treated as valid.

Custom implementations of this method are allowed to have side-effects such as triggering error message display. To validate without side-effects, use isValid.

Returns

• Boolean   

  True if the value is valid, else false