allowDomMove : Boolean

Whether the component can move the Dom node when rendering (defaults to true). ...

Whether the component can move the Dom node when rendering (defaults to true).

Defaults to: true

anchor : String

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use an Anc...

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use an AnchorLayout (or subclass thereof).\nbased layout manager, for example:

Ext.form.FormPanel
specifying layout: 'anchor' // or 'form', or 'absolute'

\n\n\n

See Ext.layout.AnchorLayout.anchor also.

\n\n

applyTo : Mixed

Specify the id of the element, a DOM element or an existing Element corresponding to a DIV\nthat is already present in...

Specify the id of the element, a DOM element or an existing Element corresponding to a DIV\nthat is already present in the document that specifies some structural markup for this\ncomponent.

\n\n\n

Description :
Notes :

\n\n

autoCreate : String/Object

A DomHelper element spec, or true for a default element spec (defaults to\n{tag: 'input', type: 'checkbox', autocomple...

A DomHelper element spec, or true for a default element spec (defaults to\n{tag: 'input', type: 'checkbox', autocomplete: 'off'})

Overrides: Ext.form.Field.autoCreate

autoScroll : Boolean

true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false to clip any overflowing content (defaults to false).

autoShow : Boolean

True if the component should check for hidden classes (e.g. ...

True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove\nthem on render (defaults to false).

Defaults to: false

boxLabel : String

The text that appears beside the checkbox ...

The text that appears beside the checkbox

Defaults to: ' '

boxMaxHeight : Number

The maximum value in pixels which this BoxComponent will set its height to. ...

The maximum value in pixels which this BoxComponent will set its height to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMaxWidth : Number

The maximum value in pixels which this BoxComponent will set its width to. ...

The maximum value in pixels which this BoxComponent will set its width to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMinHeight : Number

The minimum value in pixels which this BoxComponent will set its height to. ...

The minimum value in pixels which this BoxComponent will set its height to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

boxMinWidth : Number

The minimum value in pixels which this BoxComponent will set its width to. ...

The minimum value in pixels which this BoxComponent will set its width to.

\n\n\n

Warning: This will override any size management applied by layout managers.

\n\n

bubbleEvents : Array

An array of events that, when fired, should be bubbled to any parent container. ...

An array of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble.\nDefaults to [].\n\n

Defaults to: []

checked : Boolean

true if the checkbox should render initially checked (defaults to false) ...

true if the checkbox should render initially checked (defaults to false)

Defaults to: false

clearCls : String

The CSS class used to to apply to the special clearing div rendered\ndirectly after each form field wrapper to provide...

The CSS class used to to apply to the special clearing div rendered\ndirectly after each form field wrapper to provide field clearing (defaults to\n'x-form-clear-left').

\n\n\n

Note: this config is only used when this Component is rendered by a Container\n\n\n

which has been configured to use the FormLayout layout\nmanager (e.g. Ext.form.FormPanel or specifying layout:'form') and either a\nfieldLabel is specified or isFormField=true is specified.

\n\n

See Ext.layout.FormLayout.fieldTpl also.

\n\n

cls : String

A custom CSS class to apply to the field's underlying element (defaults to '').

Overrides: Ext.Component.cls

contentEl : String

Optional. ...

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content\nfor this component.

\n\n\n

Description :\n
This config option is used to take an existing HTML element and place it in the layout element\nof a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
Notes :\n
The specified HTML element is appended to the layout element of the component after any configured\nHTML has been inserted, and so the document will not contain this element at the time the render event is fired.
\n
The specified HTML element used will not participate in any layout\nscheme that the Component may use. It is just HTML. Layouts operate on child items.
\n
Add either the x-hidden or the x-hide-display CSS class to\nprevent a brief flicker of the content before it is rendered to the panel.

\n\n

ctCls : String

An optional extra CSS class that will be added to this component's container. ...

An optional extra CSS class that will be added to this component's container. This can be useful for\nadding customized styles to the container or any of its children using standard CSS rules. See\nExt.layout.ContainerLayout.extraCls also.

\n\n\n

Note: ctCls defaults to '' except for the following class\nwhich assigns a value by default:\n

Box Layout : 'x-box-layout-ct'

\nTo configure the above Class with an extra CSS class append to the default. For example,\nfor BoxLayout (Hbox and Vbox):\n

ctCls: 'x-box-layout-ct custom-class'\n

\n\n

data : Mixed

The initial set of data to apply to the tpl to\nupdate the content area of the Component.

disabled : Boolean

True to disable the field (defaults to false). ...

True to disable the field (defaults to false).

\n\n

Be aware that conformant with the HTML specification,\ndisabled Fields will not be submitted.

\n\n

Defaults to: false

Overrides: Ext.Component.disabled

disabledClass : String

CSS class added to the component when it is disabled (defaults to 'x-item-disabled'). ...

CSS class added to the component when it is disabled (defaults to 'x-item-disabled').

Defaults to: 'x-item-disabled'

fieldClass : String

The default CSS class for the checkbox (defaults to 'x-form-field') ...

The default CSS class for the checkbox (defaults to 'x-form-field')

Defaults to: 'x-form-field'

Overrides: Ext.form.Field.fieldClass

fieldLabel : String

The label text to display next to this Component (defaults to ''). ...

The label text to display next to this Component (defaults to '').

\n\n\n

Note: this config is only used when this Component is rendered by a Container which\n\n\n

has been configured to use the FormLayout layout manager (e.g.\nExt.form.FormPanel or specifying layout:'form').

\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name'\n    }]\n});\n

\n\n

flex : Number

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use a BoxL...

Note: this config is only used when this Component is rendered\nby a Container which has been configured to use a BoxLayout.\nEach child Component with a flex property will be flexed either vertically (by a VBoxLayout)\nor horizontally (by an HBoxLayout) according to the item's relative flex value\ncompared to the sum of all Components with flex value specified. Any child items that have\neither a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed).\n\n

focusClass : String

The CSS class to use when the checkbox receives focus (defaults to undefined)

Overrides: Ext.form.Field.focusClass

handler : Function

A function called when the checked value changes (can be used instead of\nhandling the check event). ...

A function called when the checked value changes (can be used instead of\nhandling the check event). The handler is passed the following parameters:

\n\n

checkbox : Ext.form.Checkbox
The Checkbox being toggled.
checked : Boolean
The new checked state of the checkbox.

\n\n

height : Number

The height of this component in pixels (defaults to auto). ...

The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

hidden : Boolean

Render this component hidden (default is false). ...

Render this component hidden (default is false). If true, the\nhide method will be called internally.

Defaults to: false

hideLabel : Boolean

true to completely hide the label element\n(label and separator). ...

true to completely hide the label element\n(label and separator). Defaults to false.\nBy default, even if you do not specify a fieldLabel the space will still be\nreserved so that the field will line up with other fields that do have labels.\nSetting this to true will cause the field to not reserve that space.

\n\n\n

Note: see the note for clearCls.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield'\n        hideLabel: true\n    }]\n});\n

\n\n

hideMode : String

How this component should be hidden. ...

How this component should be hidden. Supported values are 'visibility'\n(css visibility), 'offsets' (negative offset position) and 'display'\n(css display).

\n\n\n

Note: the default of 'display' is generally preferred\n\n\n

since items are automatically laid out when they are first shown (no sizing\nis done while hidden).

Defaults to: 'display'

hideParent : Boolean

True to hide and show the component's container when hide/show is called on the component, false to hide\nand show the...

True to hide and show the component's container when hide/show is called on the component, false to hide\nand show the component itself (defaults to false). For example, this can be used as a shortcut for a hide\nbutton on a window by setting hide:true on the button when adding it to its parent container.

Defaults to: false

html : String/Object

An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). ...

An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML content is added after the component is rendered,\nso the document will not contain this HTML at the time the render event is fired.\nThis content is inserted into the body before any configured contentEl is appended.

id : String

The unique id of this component (defaults to an auto-assigned id). ...

The unique id of this component (defaults to an auto-assigned id).\nYou should assign an id if you need to be able to access the component later and you do\nnot have an object reference available (e.g., using Ext.getCmp).

\n\n\n

Note that this id will also be used as the element id for the containing HTML element\nthat is rendered to the page for this component. This allows you to write id-based CSS\nrules to style the specific instance of this component uniquely, and also to select\nsub-elements using this component's id as the parent.

\n\n\n

Note: to avoid complications imposed by a unique id also see\nitemId and ref.

\n\n\n

Note: to access the container of an item see ownerCt.

\n\n

Ext.form.Radio
view source

inputType : String

The type attribute for input fields -- e.g. ...

The type attribute for input fields -- e.g. radio, text, password, file (defaults\nto 'text'). The types 'file' and 'password' must be used to render those field types currently -- there are\nno separate Ext components for those. Note that if you use inputType:'file', emptyText\nis not supported and should be avoided.

Defaults to: 'radio'

Overrides: Ext.form.Field.inputType

inputValue : String

The value that should go into the generated input element's value attribute

invalidClass : String

The CSS class to use when marking a field invalid (defaults to 'x-form-invalid') ...

The CSS class to use when marking a field invalid (defaults to 'x-form-invalid')

Defaults to: 'x-form-invalid'

invalidText : String

The error text to use when marking a field invalid and no message is provided\n(defaults to 'The value in this field i...

The error text to use when marking a field invalid and no message is provided\n(defaults to 'The value in this field is invalid')

Defaults to: 'The value in this field is invalid'

itemCls : String

Note: this config is only used when this Component is rendered by a Container which\nhas been configured to use the Fo...

Note: this config is only used when this Component is rendered by a Container which\nhas been configured to use the FormLayout layout manager (e.g.\nExt.form.FormPanel or specifying layout:'form').

\n\n\n
\n\n\n

An additional CSS class to apply to the div wrapping the form item\nelement of this field. If supplied, itemCls at the field level will override\nthe default itemCls supplied at the container level. The value specified for\nitemCls will be added to the default class ('x-form-item').

\n\n\n

Since it is applied to the item wrapper (see\nExt.layout.FormLayout.fieldTpl), it allows\nyou to write standard CSS rules that can apply to the field, the label (if specified), or\nany other element within the markup for the field.

\n\n\n

Note: see the note for fieldLabel.

\n\n\n

Example use:

\n\n

// Apply a style to the field's label:\n<style>\n    .required .x-form-item-label {font-weight:bold;color:red;}\n</style>\n\nnew Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name',\n        itemCls: 'required' //this label will be styled\n    },{\n        xtype: 'textfield',\n        fieldLabel: 'Favorite Color'\n    }]\n});\n

\n\n

itemId : String

An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. ...

An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. Instead of using an id with\nExt.getCmp, use itemId with\nExt.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the\ncontainer's internal MixedCollection, the itemId is scoped locally to the container --\navoiding potential conflicts with Ext.ComponentMgr which requires a unique\nid.

\n\n\n

var c = new Ext.Panel({ //\n    height: 300,\n    renderTo: document.body,\n    layout: 'auto',\n    items: [\n        {\n            itemId: 'p1',\n            title: 'Panel 1',\n            height: 150\n        },\n        {\n            itemId: 'p2',\n            title: 'Panel 2',\n            height: 150\n        }\n    ]\n})\np1 = c.getComponent('p1'); // not the same as Ext.getCmp()\np2 = p1.ownerCt.getComponent('p2'); // reference via a sibling\n

\n\n\n

Also see id and ref.

\n\n\n

Note: to access the container of an item see ownerCt.

\n\n

labelSeparator : String

The separator to display after the text of each\nfieldLabel. ...

The separator to display after the text of each\nfieldLabel. This property may be configured at various levels.\nThe order of precedence is:\n

field / component level
container level
layout level (defaults to colon ':')

\nTo display no separator for this field's label specify empty string ''.

\n\n\n

Note: see the note for clearCls.

\n\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    layoutConfig: {\n        labelSeparator: '~'   // layout config has lowest priority (defaults to ':')\n    },\n    labelSeparator: '>>',     // config at container level\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Field 1',\n        labelSeparator: '...' // field/component level config supersedes others\n    },{\n        xtype: 'textfield',\n        fieldLabel: 'Field 2' // labelSeparator will be '='\n    }]\n});\n

\n\n

labelStyle : String

A CSS style specification string to apply directly to this field's\nlabel. ...

A CSS style specification string to apply directly to this field's\nlabel. Defaults to the container's labelStyle value if set (e.g.,\nExt.layout.FormLayout.labelStyle , or '').

\n\n\n

Note: see the note for clearCls.

\n\n\n

Also see hideLabel and\nExt.layout.FormLayout.fieldTpl.

\n\n\n

Example use:

\n\n

new Ext.FormPanel({\n    height: 100,\n    renderTo: Ext.getBody(),\n    items: [{\n        xtype: 'textfield',\n        fieldLabel: 'Name',\n        labelStyle: 'font-weight:bold;'\n    }]\n});\n

\n\n

listeners : Object

(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. ...

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a Component's HTMLElement, listeners must be added to the Element after the Component\nhas been rendered. A plugin can simplify this step:

\n\n

// Plugin is configured with a listeners config object.\n// The Component is appended to the argument list of all handler functions.\nExt.DomObserver = Ext.extend(Object, {\n    constructor: function(config) {\n        this.listeners = config.listeners ? config.listeners : config;\n    },\n\n    // Component passes itself into plugin's init method\n    init: function(c) {\n        var p, l = this.listeners;\n        for (p in l) {\n            if (Ext.isFunction(l[p])) {\n                l[p] = this.createHandler(l[p], c);\n            } else {\n                l[p].fn = this.createHandler(l[p].fn, c);\n            }\n        }\n\n        // Add the listeners to the Element immediately following the render call\n        c.render = c.render.createSequence(function() {\n            var e = c.getEl();\n            if (e) {\n                e.on(l);\n            }\n        });\n    },\n\n    createHandler: function(fn, c) {\n        return function(e) {\n            fn.call(this, e, c);\n        };\n    }\n});\n\nvar combo = new Ext.form.ComboBox({\n\n    // Collapse combo when its element is clicked on\n    plugins: [ new Ext.DomObserver({\n        click: function(evt, comp) {\n            comp.collapse();\n        }\n    })],\n    store: myStore,\n    typeAhead: true,\n    mode: 'local',\n    triggerAction: 'all'\n});\n

\n\n\n

margins : Object

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the...

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the BorderLayout\nor one of the two BoxLayout subclasses.

\n\n\n

An object containing margins to apply to this BoxComponent in the\nformat:

\n\n\n

{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}

\n\n\n

May also be a string containing space-separated, numeric margin values. The order of the\nsides associated with each value matches the way CSS processes margin values:

\n\n\n

If there is only one value, it applies to all sides.
If there are two values, the top and bottom borders are set to the first value and the\nright and left are set to the second.
If there are three values, the top is set to the first value, the left and right are set\nto 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.

\n\n\n

Defaults to:

\n\n\n

{top:0, right:0, bottom:0, left:0}\n

\n\n

msgFx : String

Experimental The effect used when displaying a validation message under the field\n(defaults to 'normal'). ...

Experimental The effect used when displaying a validation message under the field\n(defaults to 'normal').

Defaults to: 'normal'

msgTarget : String

The location where the message text set through markInvalid should display. ...

The location where the message text set through markInvalid should display.\nMust be one of the following values:

\n\n\n

qtip Display a quick tip containing the message when the user hovers over the field. This is the default.\n
Ext.QuickTips.init must have been called for this setting to work.\n
title Display the message in a default browser title attribute popup.
under Add a block div beneath the field containing the error message.
side Add an error icon to the right of the field, displaying the message in a popup on hover.
[element id] Add the error message directly to the innerHTML of the specified element.

\n\n

Defaults to: 'qtip'

name : String

The field's HTML name attribute (defaults to ''). ...

The field's HTML name attribute (defaults to '').\nNote: this property must be set if this field is to be automatically included with\nform submit().

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and...

An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and removed when the mouse moves out. (defaults to ''). This can be\nuseful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

pageX : Number

The page level x coordinate for this component if contained within a positioning container.

pageY : Number

The page level y coordinate for this component if contained within a positioning container.

plugins : Object/Array

An object or array of objects that will provide custom functionality for this component. ...

An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.

preventMark : Boolean

true to disable marking the field invalid. ...

true to disable marking the field invalid.\nDefaults to false.

ptype : String

The registered ptype to create. ...

The registered ptype to create. This config option is not used when passing\na config object into a constructor. This config option is used only when\nlazy instantiation is being used, and a Plugin is being\nspecified not as a fully instantiated Component, but as a Component config\nobject. The ptype will be looked up at render time up to determine what\ntype of Plugin to create.

\nIf you create your own Plugins, you may register them using\nExt.ComponentMgr.registerPlugin in order to be able to\ntake advantage of lazy instantiation and rendering.

readOnly : Boolean

true to mark the field as readOnly in HTML\n(defaults to false). ...

true to mark the field as readOnly in HTML\n(defaults to false).

\n\n

Note: this only sets the element's readOnly DOM attribute.\n\n\n

Setting readOnly=true, for example, will not disable triggering a\nComboBox or DateField; it gives you the option of forcing the user to choose\nvia the trigger without typing in the text box. To hide the trigger use\nhideTrigger.

Defaults to: false

ref : String

A path specification, relative to the Component's ownerCt\nspecifying into which ancestor Container to place a named r...

A path specification, relative to the Component's ownerCt\nspecifying into which ancestor Container to place a named reference to this Component.

\n\n\n

The ancestor axis can be traversed by using '/' characters in the path.\nFor example, to put a reference to a Toolbar Button into the Panel which owns the Toolbar:

\n\n\n

var myGrid = new Ext.grid.EditorGridPanel({\n    title: 'My EditorGridPanel',\n    store: myStore,\n    colModel: myColModel,\n    tbar: [{\n        text: 'Save',\n        handler: saveChanges,\n        disabled: true,\n        ref: '../saveButton'\n    }],\n    listeners: {\n        afteredit: function() {\n//          The button reference is in the GridPanel\n            myGrid.saveButton.enable();\n        }\n    }\n});\n

\n\n\n

In the code above, if the ref had been 'saveButton'\nthe reference would have been placed into the Toolbar. Each '/' in the ref\nmoves up one level from the Component's ownerCt.

\n\n\n

Also see the added and removed events.

\n\n

region : String

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the...

Note: this config is only used when this BoxComponent is rendered\nby a Container which has been configured to use the BorderLayout\nlayout manager (e.g. specifying layout:'border').

\n\n\n
\n\n\n

See Ext.layout.BorderLayout also.

\n\n

renderTo : Mixed

Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into. ...

Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.

\n\n\n

Notes :

\n\n\n

See render also.

\n\n

scope : Object

An object to use as the scope ('this' reference) of the handler function\n(defaults to this Checkbox).

stateEvents : Array

An array of events that, when fired, should trigger this component to\nsave its state (defaults to none). ...

An array of events that, when fired, should trigger this component to\nsave its state (defaults to none). stateEvents may be any type\nof event supported by this component, including browser or custom events\n(e.g., ['click', 'customerchange']).

\n\n\n

See stateful for an explanation of saving and\nrestoring Component state.

\n\n

stateId : String

The unique id for this component to use for state management purposes\n(defaults to the component id if one was set, o...

The unique id for this component to use for state management purposes\n(defaults to the component id if one was set, otherwise null if the\ncomponent is using a generated id).

\n\n

See stateful for an explanation of saving and\nrestoring Component state.

\n\n

stateful : Boolean

A flag which causes the Component to attempt to restore the state of\ninternal properties from a saved state on startup. ...

A flag which causes the Component to attempt to restore the state of\ninternal properties from a saved state on startup. The component must have\neither a stateId or id assigned\nfor state to be managed. Auto-generated ids are not guaranteed to be stable\nacross page loads and cannot be relied upon to save and restore the same\nstate for a component.

For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({\n    expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\n

A stateful Component attempts to save state when one of the events\nlisted in the stateEvents configuration fires.

To save state, a stateful Component first serializes its state by\ncalling getState. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the Component's restorable state.

The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the Component's stateId, or, if that is not\nspecified, its id.

During construction, a stateful Component attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId, or, if that is not specified, the\nid.

The resulting object is passed to applyState.\nThe default implementation of applyState simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.

You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.

\n\n

style : String

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.Element.applyStyles.

\n\n

new Ext.Panel({\n    title: 'Some Title',\n    renderTo: Ext.getBody(),\n    width: 400, height: 300,\n    layout: 'form',\n    items: [{\n        xtype: 'textarea',\n        style: {\n            width: '95%',\n            marginBottom: '10px'\n        }\n    },\n        new Ext.Button({\n            text: 'Send',\n            minWidth: '100',\n            style: {\n                marginBottom: '10px'\n            }\n        })\n    ]\n});\n

\n\n

submitValue : Boolean

False to clear the name attribute on the field so that it is not submitted during a form post. ...

False to clear the name attribute on the field so that it is not submitted during a form post.\nDefaults to true.

Defaults to: true

tabIndex : Number

The tabIndex for this field. ...

The tabIndex for this field. Note this only applies to fields that are rendered,\nnot those which are built via applyTo (defaults to undefined).

tabTip : String

Note: this config is only used when this BoxComponent is a child item of a TabPanel. ...

Note: this config is only used when this BoxComponent is a child item of a TabPanel.

\n\n\n

A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over\nthe associated tab selector element. Ext.QuickTips.init()\nmust be called in order for the tips to render.

tpl : Mixed

An Ext.Template, Ext.XTemplate\nor an array of strings to form an Ext.XTemplate. ...

An Ext.Template, Ext.XTemplate\nor an array of strings to form an Ext.XTemplate.\nUsed in conjunction with the data and\ntplWriteMode configurations.

tplWriteMode : String

The Ext.(X)Template method to use when\nupdating the content area of the Component. ...

The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.XTemplate.overwrite).

Defaults to: 'overwrite'

validateOnBlur : Boolean

Whether the field should validate when it loses focus (defaults to true). ...

Whether the field should validate when it loses focus (defaults to true).

Defaults to: true

validationDelay : Number

The length of time in milliseconds after user input begins until validation\nis initiated (defaults to 250) ...

The length of time in milliseconds after user input begins until validation\nis initiated (defaults to 250)

Defaults to: 250

validationEvent : String/Boolean

The event that should initiate field validation. ...

The event that should initiate field validation. Set to false to disable

\n\n

  automatic validation (defaults to 'keyup').\n

Defaults to: 'keyup'

value : Mixed

A value to initialize this field with (defaults to undefined).

width : Number

The width of this component in pixels (defaults to auto). ...

The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

x : Number

The local x (left) coordinate for this component if contained within a positioning container.

xtype : String

The registered xtype to create. ...

The registered xtype to create. This config option is not used when passing\na config object into a constructor. This config option is used only when\nlazy instantiation is being used, and a child item of a Container is being\nspecified not as a fully instantiated Component, but as a Component config\nobject. The xtype will be looked up at render time up to determine what\ntype of child Component to create.

\nThe predefined xtypes are listed here.

\n\n

\n\n\n

If you subclass Components to create your own Components, you may register\nthem using Ext.ComponentMgr.registerType in order to be able to\ntake advantage of lazy instantiation and rendering.

y : Number

The local y (top) coordinate for this component if contained within a positioning container.

Defined By

Properties

actionMode : Stringprivate

private ...

private

Defaults to: 'wrap'

boxReady : Booleanprivate

private, set in afterRender to signify that the component has been rendered ...

private, set in afterRender to signify that the component has been rendered

Defaults to: false

deferHeight : Booleanprivate

private, used to defer height settings to subclasses ...

private, used to defer height settings to subclasses

Defaults to: false

disabled : Boolean

True if this component is disabled. ...

True if this component is disabled. Read-only.

el : Ext.Element

The Ext.Element which encapsulates this Component. ...

The Ext.Element which encapsulates this Component. Read-only.

\n\n\n

This will usually be a <DIV> element created by the class's onRender method, but\nthat may be overridden using the autoEl config.

\n\n\n

Note: this element will not be available until this Component has been rendered.

\n\n\n

To add listeners for DOM events to this Component (as opposed to listeners\nfor this Component's own Observable events), see the listeners\nconfig for a suggestion, or use a render listener directly:

\n\n\n

new Ext.Panel({\n    title: 'The Clickable Panel',\n    listeners: {\n        render: function(p) {\n            // Append the Panel to the click handler's argument list.\n            p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));\n        },\n        single: true  // Remove the listener after first invocation\n    }\n});\n

\n\n\n

Methods

Ext.form.Radio
view source

newExt.form.Radio( config ) : Ext.form.Radio

Creates a new Radio ...

Creates a new Radio

Parameters

config : Object
Configuration options
\n

Returns

Ext.form.Radio
\n

Overrides: Ext.form.Checkbox.constructor

addClass( cls ) : Ext.Componentchainable

Adds a CSS class to the component's underlying element. ...

Adds a CSS class to the component's underlying element.

Parameters

cls : string
The CSS class name to add
\n

Returns

Ext.Component
this
\n

addEvents( o, Optional )

Adds 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

o : Object|String
Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
\n
Optional : string
. Event name if multiple event names are being passed as separate parameters.\nUsage:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n\n

addListener( eventName, handler, [scope], [options] )

Appends an event handler to this object. ...

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for.
\n
handler : Function
The method the event invokes.
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.\nproperties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed.\nIf 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\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler 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\nif the event was bubbled up from a child Observable.
\n\n
\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
```
myDataView.on('click', this.onClick, this, {\nsingle: true,\ndelay: 100\n});
```
\n
\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n
\n
```
myGridPanel.on({\n'click' : {\n    fn: this.onClick,\n    scope: this,\n    delay: 100\n},\n'mouseover' : {\n    fn: this.onMouseOver,\n    scope: this\n},\n'mouseout' : {\n    fn: this.onMouseOut,\n    scope: this\n}\n});
```
\n
\nOr a shorthand syntax:
\n
```
myGridPanel.on({\n'click' : this.onClick,\n'mouseover' : this.onMouseOver,\n'mouseout' : this.onMouseOut,\n scope: this\n});
```
\n\n

adjustPosition( x, y )private

private ...

private

Parameters

x : Object
\n
y : Object
\n

adjustSize( w, h )private

private ...

private

Parameters

w : Object
\n
h : Object
\n

afterRender( )private

private ...

private

Overrides: Ext.BoxComponent.afterRender

alignErrorEl( )private

Alignment for 'under' target ...

Alignment for 'under' target

alignErrorIcon( )private

Alignment for 'side' target ...

Alignment for 'side' target

append( v )private

private, does not work for all fields ...

private, does not work for all fields

Parameters

v : Object
\n

applyToMarkup( el )

Apply this component to existing markup that is valid. ...

Apply this component to existing markup that is valid. With this function, no call to render() is required.

Parameters

el : String/HTMLElement
\n

beforeBlur( )private

private ...

private

bubble( fn, [scope], [args] ) : Ext.Componentchainable

Bubbles up the component/container heirarchy, calling the specified function with each component. ...

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe bubble is stopped.

Parameters

fn : Function
The function to call
\n
scope : Object (optional)
The scope of the function (defaults to current node)
\n
args : Array (optional)
The args to call the function with (default to passing the current component)
\n

Returns

Ext.Component
this
\n

cloneConfig( overrides ) : Ext.Component

Clone 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 : Object
A new config containing any properties to override in the cloned version.\nAn id property can be passed on this object, otherwise one will be generated to avoid duplicates.
\n

Returns

Ext.Component
clone The cloned copy of this component
\n

destroy( )

Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the c...

Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its Ext.Container (if applicable) and unregistering it from\nExt.ComponentMgr. Destruction is generally handled automatically by the framework and this method\nshould usually not need to be called directly.

disable( silent ) : Ext.Componentchainable

Disable this component and fire the 'disable' event. ...

Disable this component and fire the 'disable' event.

Parameters

silent : Object
\n

Returns

Ext.Component
this
\n

enable( ) : Ext.Componentchainable

Enable this component and fire the 'enable' event. ...

Enable this component and fire the 'enable' event.

Returns

Ext.Component
this
\n

enableBubble( events )

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. ...

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n

Ext.override(Ext.form.Field, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

\n\n

Parameters

events : String/Array
The event name to bubble, or an Array of event names.
\n

findParentBy( fn ) : Ext.Container

Find a container above this component at any level by a custom function. ...

Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the container will be returned.

Parameters

fn : Function
The custom function to call with the arguments (container, this component).
\n

Returns

Ext.Container
The first Container for which the custom function returns true
\n

findParentByType( xtype, [shallow] ) : Ext.Container

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

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

Parameters

xtype : String/Ext.Component/Class
The xtype to check for this Component. Note that the the component can either be an instance\nor a component class:
\n
shallow : Boolean (optional)
False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n

Returns

Ext.Container
The first Container which matches the given xtype or class
\n

fireEvent( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name). ...

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

fireKey( e )private

private ...

private

Parameters

e : Object
\n

focus( [selectText], [delay] ) : Ext.Componentchainable

Try to focus this component. ...

Try to focus this component.

Parameters

selectText : Boolean (optional)
If applicable, true to also select the text in this component
\n
delay : Boolean/Number (optional)
Delay the focus this number of milliseconds (true for 10 milliseconds)
\n

Returns

Ext.Component
this
\n

getActiveError( ) : String

Gets the active error message for this field. ...

Gets the active error message for this field.

Returns

String
Returns the active error message on the field, if there is no error, an empty string is returned.
\n

getBox( [local] ) : Object

Gets 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)
\n

Returns

Object
box An object in the format {x, y, width, height}
\n

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.

Returns

Ext.Container
the Container which owns this Component.
\n

Ext.form.Radio
view source

getCheckEl( )private

private ...

private

getEl( ) : Ext.Element

Returns the Ext.Element which encapsulates this Component. ...

Returns the Ext.Element which encapsulates this Component.

\n\n\n

This will usually be a <DIV> element created by the class's onRender method, but\nthat may be overridden using the autoEl config.

\n\n\n

Note: this element will not be available until this Component has been rendered.

\n\n\n

To add listeners for DOM events to this Component (as opposed to listeners\nfor this Component's own Observable events), see the listeners config for a suggestion,\nor use a render listener directly:

\n\n\n

new Ext.Panel({\n    title: 'The Clickable Panel',\n    listeners: {\n        render: function(p) {\n            // Append the Panel to the click handler's argument list.\n            p.getEl().on('click', handlePanelClick.createDelegate(null, [p], true));\n        },\n        single: true  // Remove the listener after first invocation\n    }\n});\n

\n\n

Returns

Ext.Element
The Element which encapsulates this Component.
\n

getErrorCt( )private

private ...

private

getErrors( ) : Array

Runs this field's validators and returns an array of error messages for any validation failures. ...

Runs this field's validators and returns an array of error messages for any validation failures.\nThis is called internally during validation and would not usually need to be used manually.\nEach subclass should override or augment the return value to provide their own errors

Returns

Array
All error messages for this field
\n

Ext.form.Radio
view source

getGroupValue( ) : String

If this radio is part of a group, it will return the selected value ...

If this radio is part of a group, it will return the selected value

Returns

String
\n

getHeight( ) : Number

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

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

Returns

Number
\n

getId( ) : String

Returns the id of this component or automatically generates and\nreturns an id if an id is not defined yet:\n\n'ext-comp...

Returns the id of this component or automatically generates and\nreturns an id if an id is not defined yet:

\n\n

'ext-comp-' + (++Ext.Component.AUTO_ID)\n

\n\n

Returns

String
id
\n

getItemCt( )private

private ...

private

getItemId( ) : String

Returns the itemId of this component. ...

Returns the itemId of this component. If an\nitemId was not assigned through configuration the\nid is returned using getId.

Returns

String
\n

getMessageHandler( )private

private ...

private

getName( ) : String

Returns the name or hiddenName\nattribute of the field if available. ...

Returns the name or hiddenName\nattribute of the field if available.

Returns

String
name The field name or hiddenName
\n\n

getOuterSize( ) : Object

Gets the current size of the component's underlying element, including space taken by its margins. ...

Gets the current size of the component's underlying element, including space taken by its margins.

Returns

Object
An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}
\n

getPosition( [local] ) : Array

Gets the current XY position of the component's underlying element. ...

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)
\n

Returns

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

getRawValue( ) : Mixed

Returns the raw data value which may or may not be a valid, defined value. ...

Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.

Returns

Mixed
value The field value
\n

getResizeEl( ) : Ext.Element

Returns the outermost Element of this Component which defines the Components overall size. ...

Returns the outermost Element of this Component which defines the Components overall size.

\n\n\n

Usually this will return the same Element as getEl,\nbut in some cases, a Component may have some more wrapping Elements around its main\nactive Element.

\n\n\n

An example is a ComboBox. It is encased in a wrapping Element which\ncontains both the <input> Element (which is what would be returned\nby its getEl method, and the trigger button Element.\nThis Element is returned as the resizeEl.\n\n

Returns

Ext.Element
The Element which is to be resized by size managing layouts.
\n

getSize( ) : Object

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

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)}
\n

getValue( ) : Boolean

Returns the checked state of the checkbox. ...

Returns the checked state of the checkbox.

Returns

Boolean
True if checked, else false
\n

Overrides: Ext.form.Field.getValue

getWidth( ) : Number

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

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

Returns

Number
\n

getXType( ) : String

Gets the xtype for this component as registered with Ext.ComponentMgr. ...

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

\n\n

var t = new Ext.form.TextField();\nalert(t.getXType());  // alerts 'textfield'\n

\n\n

Returns

String
The xtype
\n

getXTypes( ) : String

Returns this Component's xtype hierarchy as a slash-delimited string. ...

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext.Component header.

\n\n\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

Example usage:

\n\n\n

var t = new Ext.form.TextField();\nalert(t.getXTypes());  // alerts 'component/box/field/textfield'\n

\n\n

Returns

String
The xtype hierarchy string
\n

hasListener( eventName ) : Boolean

Checks 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

eventName : String
The name of the event to check for
\n

Returns

Boolean
True if the event is being listened for, else false
\n

hide( ) : Ext.Componentchainable

Hide this component. ...

Hide this component. Listen to the 'beforehide' event and return\nfalse to cancel hiding the component. Fires the 'hide'\nevent after hiding the component. Note this method is called internally if\nthe component is configured to be hidden.

Returns

Ext.Component
this
\n

initComponent( )private

private ...

private

Overrides: Ext.form.Field.initComponent

initEvents( )private

private ...

private

Overrides: Ext.form.Field.initEvents

initRef( )private

Method to establish a reference to a component. ...

Method to establish a reference to a component.

initValue( )private

private ...

private

Overrides: Ext.form.Field.initValue

isDirty( ) : Boolean

Returns true if the value of this Field has been changed from its original value. ...

Returns true if the value of this Field has been changed from its original value.\nWill return false if the field is disabled or has not been rendered yet.

\n\n\n

Note that if the owning form was configured with\nExt.form.BasicForm.trackResetOnLoad\nthen the original value is updated when the values are loaded by\nExt.form.BasicForm.setValues.

\n\n

Returns

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

isValid( preventMark ) : Boolean

Returns whether or not the field value is currently valid by\nvalidating the processed value\nof the field. ...

Returns whether or not the field value is currently valid by\nvalidating the processed value\nof the field. Note: disabled fields are ignored.

Parameters

preventMark : Boolean
True to disable marking the field invalid
\n

Returns

Boolean
True if the value is valid, else false
\n

isVisible( ) : Boolean

Returns true if this component is visible. ...

Returns true if this component is visible.

Returns

Boolean
True if this component is visible, false otherwise.
\n

isXType( xtype, [shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. ...

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom the xtype (default) or whether it is directly of the xtype specified (shallow = true).

\n\n\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

For a list of all available xtypes, see the Ext.Component header.

\n\n\n

Example usage:

\n\n\n

var t = new Ext.form.TextField();\nvar isText = t.isXType('textfield');        // true\nvar isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent\nvar isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance\n

\n\n

Parameters

xtype : String/Ext.Component/Class
The xtype to check for this Component. Note that the the component can either be an instance\nor a component class:
\n\n
```
var c = new Ext.Component();\nconsole.log(c.isXType(c));\nconsole.log(c.isXType(Ext.Component));\n
```
\n\n
shallow : Boolean (optional)
False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n

Returns

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

mon( item, ename, fn, scope, opt )

Adds listeners to any Observable object (or Elements) which are automatically removed when this Component\nis destroyed. ...

Adds listeners to any Observable object (or Elements) which are automatically removed when this Component\nis destroyed. Usage:

\n\n\n

\n\nmyGridPanel.mon(myGridPanel.getSelectionModel(), 'selectionchange', handleSelectionChange, null, {buffer: 50});\n
\n\n\n

\n\n

or:

\n\n\n

\n\nmyGridPanel.mon(myGridPanel.getSelectionModel(), {\n    selectionchange: handleSelectionChange,\n    buffer: 50\n});\n
\n\n\n

Parameters

item : Observable|Element
The item to which to add a listener/listeners.
\n
ename : Object|String
The event name, or an object containing event name properties.
\n
fn : Function
Optional. If the ename parameter was an event name, this\nis the handler function.
\n
scope : Object
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
\n
opt : Object
Optional. If the ename parameter was an event name, this\nis the addListener options.
\n

mun( item, ename, fn, scope )

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

item : Observable|Element
The item from which to remove a listener/listeners.
\n
ename : Object|String
The event name, or an object containing event name properties.
\n
fn : Function
Optional. If the ename parameter was an event name, this\nis the handler function.
\n
scope : Object
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
\n

nextSibling( ) : Object

Returns the next component in the owning container ...

Returns the next component in the owning container

Returns

Object
Ext.Component
\n

on( eventName, handler, [scope], [options] )

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

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

Parameters

eventName : String
The type of event to listen for
\n
handler : Function
The method the event invokes
\n
scope : Object (optional)
The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
\n
options : Object (optional)
An object containing handler configuration.
\n

onAdded( container, pos )private

Method to manage awareness of when components are added to their\nrespective Container, firing an added event. ...

Method to manage awareness of when components are added to their\nrespective Container, firing an added event.\nReferences are established at add time rather than at render time.

Parameters

container : Ext.Container
Container which holds the component
\n
pos : number
Position at which the component was added
\n

onBlur( )private

private ...

private

onClick( )private

private ...

private

onDestroy( )private

private ...

private

onFocus( )private

private ...

private

onPosition( x, y )private

// protected\nCalled after the component is moved, this method is empty by default but can be implemented by any\nsubcl...

// protected\nCalled after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n

onRemoved( )private

Method to manage awareness of when components are removed from their\nrespective Container, firing an removed event. ...

Method to manage awareness of when components are removed from their\nrespective Container, firing an removed event. References are properly\ncleaned up after removing a component from its owning container.

onRender( ct, position )private

private ...

private

Parameters

ct : Object
\n
position : Object
\n

Overrides: Ext.form.Field.onRender

onResize( )private

private ...

private

Overrides: Ext.BoxComponent.onResize

postBlur( )private

private ...

private

preFocus( )private

private ...

private

previousSibling( ) : Object

Returns the previous component in the owning container ...

Returns the previous component in the owning container

Returns

Object
Ext.Component
\n

processValue( value )

This method should only be overridden if necessary to prepare raw values\nfor validation (see validate and isValid). ...

This method should only be overridden if necessary to prepare raw values\nfor validation (see validate and isValid). This method\nis expected to return the processed value for the field which will\nbe used for validation (see validateValue method).

Parameters

value : Mixed
\n

purgeListeners( )

Removes all listeners for this object ...

Removes all listeners for this object

relayEvents( o, events )

Relays 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

o : Object
The Observable whose events this object is to relay.
\n
events : Array
Array of event names to relay.
\n

removeClass( cls ) : Ext.Componentchainable

Removes a CSS class from the component's underlying element. ...

Removes a CSS class from the component's underlying element.

Parameters

cls : string
The CSS class name to remove
\n

Returns

Ext.Component
this
\n

removeListener( eventName, handler, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

render( [container], [position] ) : Ext.Componentchainable

Render this Component into the passed HTML element. ...

Render this Component into the passed HTML element.

\n\n\n

If you are using a Container object to house this Component, then\ndo not use the render method.

\n\n\n

A Container's child Components are rendered by that Container's\nlayout manager when the Container is first rendered.

\n\n\n

Certain layout managers allow dynamic addition of child components. Those that do\ninclude Ext.layout.CardLayout, Ext.layout.AnchorLayout,\nExt.layout.FormLayout, Ext.layout.TableLayout.

\n\n\n

If the Container is already rendered when a new child Component is added, you may need to call\nthe Container's doLayout to refresh the view which causes any\nunrendered child Components to be rendered. This is required so that you can add multiple\nchild components if needed while only refreshing the layout once.

\n\n\n

When creating complex UIs, it is important to remember that sizing and positioning\nof child items is the responsibility of the Container's layout manager.\nIf you expect child items to be sized in response to user interactions, you must\nconfigure the Container with a layout manager which creates and manages the type of layout you\nhave in mind.

\n\n\n

Omitting the Container's layout config means that a basic\nlayout manager is used which does nothing but render child components sequentially into the\nContainer. No sizing or positioning will be performed in this situation.

\n\n

Parameters

container : Element/HTMLElement/String (optional)
The element this Component should be\nrendered into. If it is being created from existing markup, this should be omitted.
\n
position : String/Number (optional)
The element ID or DOM node index within the container before\nwhich this component will be inserted (defaults to appending to the end of the container)
\n

Returns

Ext.Component
this
\n

reset( )

Resets the current field value to the originally loaded value and clears any validation messages. ...

Resets the current field value to the originally loaded value and clears any validation messages.\nSee Ext.form.BasicForm.trackResetOnLoad

resumeEvents( )

Resume firing events. ...

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

setActiveError( msg, suppressEvent )

Sets the current activeError to the given string. ...

Sets the current activeError to the given string. Fires the 'invalid' event.\nThis does not set up the error icon, only sets the message and fires the event. To show the error icon,\nuse markInvalid instead, which calls this method internally

Parameters

msg : String
The error message
\n
suppressEvent : Boolean
True to suppress the 'invalid' event from being fired
\n

setAutoScroll( scroll ) : Ext.BoxComponentchainable

Sets the overflow on the content element of the component. ...

Sets the overflow on the content element of the component.

Parameters

scroll : Boolean
True to allow the Component to auto scroll.
\n

Returns

Ext.BoxComponent
this
\n

setDisabled( disabled ) : Ext.Componentchainable

Convenience function for setting disabled/enabled by boolean. ...

Convenience function for setting disabled/enabled by boolean.

Parameters

disabled : Boolean
\n

Returns

Ext.Component
this
\n

setHeight( height ) : Ext.BoxComponentchainable

Sets the height of the component. ...

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

Parameters

height : Mixed
The 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.
\n

Returns

Ext.BoxComponent
this
\n

setPagePosition( x, y ) : Ext.BoxComponentchainable

Sets the page XY position of the component. ...

Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n

Returns

Ext.BoxComponent
this
\n

setPosition( left, top ) : Ext.BoxComponentchainable

Sets the left and top of the component. ...

Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires the move event.

Parameters

left : Number
The new left
\n
top : Number
The new top
\n

Returns

Ext.BoxComponent
this
\n

setRawValue( value ) : Mixed

Sets the underlying DOM field's value directly, bypassing validation. ...

Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.

Parameters

value : Mixed
The value to set
\n

Returns

Mixed
value The field value that is set
\n

setReadOnly( readOnly )

Sets the read only state of this field. ...

Sets the read only state of this field.

Parameters

readOnly : Boolean
Whether the field should be read only.
\n

setSize( width, height ) : Ext.BoxComponentchainable

Sets the width and height of this BoxComponent. ...

Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept\neither 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.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.
\n
height : Mixed
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
- undefined to leave the height unchanged.
\n

Returns

Ext.BoxComponent
this
\n

Ext.form.Radio
view source

setValue( value ) : Ext.form.Fieldchainable

Sets either the checked/unchecked status of this Radio, or, if a string value\nis passed, checks a sibling Radio of th...

Sets either the checked/unchecked status of this Radio, or, if a string value\nis passed, checks a sibling Radio of the same name whose value is the value specified.

Parameters

value : Object
{String/Boolean} Checked value, or the value of the sibling radio button to check.
\n

Returns

Ext.form.Field
this
\n

Overrides: Ext.form.Checkbox.setValue

setVisible( visible ) : Ext.Componentchainable

Convenience function to hide or show this component by boolean. ...

Convenience function to hide or show this component by boolean.

Parameters

visible : Boolean
True to show, false to hide
\n

Returns

Ext.Component
this
\n

setWidth( width ) : Ext.BoxComponentchainable

Sets the width of the component. ...

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

Parameters

width : Mixed
The 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.
\n

Returns

Ext.BoxComponent
this
\n

show( ) : Ext.Componentchainable

Show this component. ...

Show this component. Listen to the 'beforeshow' event and return\nfalse to cancel showing the component. Fires the 'show'\nevent after showing the component.

Returns

Ext.Component
this
\n

suspendEvents( queueSuspended )

Suspend the firing of all events. ...

Suspend the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n

syncSize( ) : Ext.BoxComponentchainable

Force the component's size to recalculate based on the underlying element's current height and width. ...

Force the component's size to recalculate based on the underlying element's current height and width.

Returns

Ext.BoxComponent
this
\n

un( eventName, handler, [scope] )

Removes an event handler (shorthand for removeListener.) ...

Removes an event handler (shorthand for removeListener.)

Parameters

eventName : String
The type of event the handler was associated with.
\n
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
\n
scope : Object (optional)
The scope originally specified for the handler.
\n

unsetActiveError( suppressEvent )

Clears the activeError and fires the 'valid' event. ...

Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not\nusually need to be called manually

Parameters

suppressEvent : Boolean
True to suppress the 'invalid' event from being fired
\n

update( htmlOrData, loadScripts, callback )

Update the content area of a component. ...

Update the content area of a component.

Parameters

htmlOrData : Mixed
If this component has been configured with a template via the tpl config\nthen it will use this argument as data to populate the template.\nIf this component was not configured with a template, the components\ncontent area will be updated via Ext.Element update
\n
loadScripts : Boolean
(optional) Only legitimate when using the html configuration. Defaults to false
\n
callback : Function
(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n

updateBox( box ) : Ext.BoxComponentchainable

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

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

Parameters

box : Object
An object in the format {x, y, width, height}
\n

Returns

Ext.BoxComponent
this
\n

validate( ) : Boolean

Validates the field value ...

Validates the field value

Returns

Boolean
True if the value is valid, else false
\n

validateValue( The ) : Boolean

Uses getErrors to build an array of validation errors. ...

Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called\nwith the first and false is returned, otherwise true is returned. Previously, subclasses were invited\nto provide an implementation of this to process validations - from 3.2 onwards getErrors should be\noverridden instead.

Parameters

The : Mixed
current value of the field
\n

Returns

Boolean
True if all validations passed, false if one or more failed
\n

Defined By

Events

added( this, ownerCt, index )

Fires when a component is added to an Ext.Container ...

Fires when a component is added to an Ext.Container

Parameters

this : Ext.Component
\n
ownerCt : Ext.Container
Container which holds the component
\n
index : number
Position at which the component was added
\n

afterrender( this )

Fires after the component rendering is finished. ...

Fires after the component rendering is finished.

\n\n\n

The afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component, and, if stateful, after state\nhas been restored.

\n\n

Parameters

this : Ext.Component
\n

beforedestroy( this )

Fires before the component is destroyed. ...

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

Parameters

this : Ext.Component
\n

beforehide( this )

Fires before the component is hidden by calling the hide method. ...

Fires before the component is hidden by calling the hide method.\nReturn false from an event handler to stop the hide.

Parameters

this : Ext.Component
\n

beforerender( this )

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an\nevent handler to stop the render.

Parameters

this : Ext.Component
\n

beforeshow( this )

Fires before the component is shown by calling the show method. ...

Fires before the component is shown by calling the show method.\nReturn false from an event handler to stop the show.

Parameters

this : Ext.Component
\n

beforestaterestore( this, state )

Fires before the state of the component is restored. ...

Fires before the state of the component is restored. Return false from an event handler to stop the restore.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to applyState. By default,\nthat simply copies property values into this Component. The method maybe overriden to\nprovide custom state restoration.
\n

beforestatesave( this, state )

Fires before the state of the component is saved to the configured state provider. ...

Fires before the state of the component is saved to the configured state provider. Return false to stop the save.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values. This is determined by calling\ngetState() on the Component. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.Component\nhas a null implementation.
\n

blur( this )

Fires when this field loses input focus. ...

Fires when this field loses input focus.

Parameters

this : Ext.form.Field
\n

change( this, newValue, oldValue )

Fires just before the field blurs if the field value has changed. ...

Fires just before the field blurs if the field value has changed.

Parameters

this : Ext.form.Field
\n
newValue : Mixed
The new value
\n
oldValue : Mixed
The original value
\n

check( this, checked )

Fires when the checkbox is checked or unchecked. ...

Fires when the checkbox is checked or unchecked.

Parameters

this : Ext.form.Checkbox
This checkbox
\n
checked : Boolean
The new checked value
\n

destroy( this )

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Parameters

this : Ext.Component
\n

disable( this )

Fires after the component is disabled. ...

Fires after the component is disabled.

Parameters

this : Ext.Component
\n

enable( this )

Fires after the component is enabled. ...

Fires after the component is enabled.

Parameters

this : Ext.Component
\n

focus( this )

Fires when this field receives input focus. ...

Fires when this field receives input focus.

Parameters

this : Ext.form.Field
\n

hide( this )

Fires after the component is hidden. ...

Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.

Parameters

this : Ext.Component
\n

invalid( this, msg )

Fires after the field has been marked as invalid. ...

Fires after the field has been marked as invalid.

Parameters

this : Ext.form.Field
\n
msg : String
The validation message
\n

move( this, x, y )

Fires after the component is moved. ...

Fires after the component is moved.

Parameters

this : Ext.Component
\n
x : Number
The new x position
\n
y : Number
The new y position
\n

removed( this, ownerCt )

Fires when a component is removed from an Ext.Container ...

Fires when a component is removed from an Ext.Container

Parameters

this : Ext.Component
\n
ownerCt : Ext.Container
Container which holds the component
\n

render( this )

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Parameters

this : Ext.Component
\n

resize( this, adjWidth, adjHeight, rawWidth, rawHeight )

Fires after the component is resized. ...

Fires after the component is resized.

Parameters

this : Ext.Component
\n
adjWidth : Number
The box-adjusted width that was set
\n
adjHeight : Number
The box-adjusted height that was set
\n
rawWidth : Number
The width that was originally specified
\n
rawHeight : Number
The height that was originally specified
\n

show( this )

Fires after the component is shown when calling the show method. ...

Fires after the component is shown when calling the show method.

Parameters

this : Ext.Component
\n

specialkey( this, e )

Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. ...

Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.\nTo handle other keys see Ext.Panel.keys or Ext.KeyMap.\nYou can check Ext.EventObject.getKey to determine which key was pressed.\nFor example:

\n\n

var form = new Ext.form.FormPanel({\n    ...\n    items: [{\n            fieldLabel: 'Field 1',\n            name: 'field1',\n            allowBlank: false\n        },{\n            fieldLabel: 'Field 2',\n            name: 'field2',\n            listeners: {\n                specialkey: function(field, e){\n                    // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,\n                    // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN\n                    if (e.getKey() == e.ENTER) {\n                        var form = field.ownerCt.getForm();\n                        form.submit();\n                    }\n                }\n            }\n        }\n    ],\n    ...\n});\n

\n\n

Parameters

this : Ext.form.Field
\n
e : Ext.EventObject
The event object
\n

staterestore( this, state )

Fires after the state of the component is restored. ...

Fires after the state of the component is restored.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values returned from the StateProvider. This is passed\nto applyState. By default, that simply copies property values into this\nComponent. The method maybe overriden to provide custom state restoration.
\n

statesave( this, state )

Fires after the state of the component is saved to the configured state provider. ...

Fires after the state of the component is saved to the configured state provider.

Parameters

this : Ext.Component
\n
state : Object
The hash of state values. This is determined by calling\ngetState() on the Component. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.Component\nhas a null implementation.
\n