activeError : String

If specified, then the component will be displayed with this value as its active error when first rendered. ...

If specified, then the component will be displayed with this value as its active error when first rendered. Use\nsetActiveError or unsetActiveError to change it after component creation.

activeErrorsTpl : String/String[]/Ext.XTemplate

The template used to format the Array of error messages passed to setActiveErrors into a single HTML\nstring. ...

The template used to format the Array of error messages passed to setActiveErrors into a single HTML\nstring. By default this renders each message as an item in an unordered list.

Defaults to: ["<tpl if="errors && errors.length">", "<ul><tpl for="errors"><li>{.}</li></tpl></ul>", "</tpl>"]

afterBodyEl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nat the end of the input containing element. ...

An optional string or XTemplate configuration to insert in the field markup\nat the end of the input containing element. If an XTemplate is used, the component's render data\nserves as the context.

afterLabelTextTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nafter the label text. ...

An optional string or XTemplate configuration to insert in the field markup\nafter the label text. If an XTemplate is used, the component's render data\nserves as the context.

afterLabelTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nafter the label element. ...

An optional string or XTemplate configuration to insert in the field markup\nafter the label element. If an XTemplate is used, the component's render data\nserves as the context.

afterSubTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nafter the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup\nafter the subTpl markup. If an XTemplate is used, the\ncomponent's render data serves as the context.

allowBlank : Boolean

Specify false to validate that the value's length is > 0 ...

Specify false to validate that the value's length is > 0

Defaults to: true

autoEl : String/Object

A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component. ...

A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.

\n\n

You do not normally need to specify this. For the base classes Ext.Component and\nExt.container.Container, this defaults to 'div'. The more complex Sencha classes use a more\ncomplex DOM structure specified by their own renderTpls.

\n\n

This is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:

\n\n

{\n    xtype: 'component',\n    autoEl: {\n        tag: 'img',\n        src: 'http://www.example.com/example.jpg'\n    }\n}, {\n    xtype: 'component',\n    autoEl: {\n        tag: 'blockquote',\n        html: 'autoEl is cool!'\n    }\n}, {\n    xtype: 'container',\n    autoEl: 'ul',\n    cls: 'ux-unordered-list',\n    items: {\n        xtype: 'component',\n        autoEl: 'li',\n        html: 'First list item'\n    }\n}\n

autoFitErrors : Boolean

Whether to adjust the component's body area to make room for 'side' or 'under' error messages. ...

Whether to adjust the component's body area to make room for 'side' or 'under' error messages.

Defaults to: true

autoLoad : Ext.ComponentLoader/Object/String/Booleandeprecated

An alias for loader config which also allows to specify just a string which will be\nused as the url that's automatica...

An alias for loader config which also allows to specify just a string which will be\nused as the url that's automatically loaded:

\n\n

Ext.create('Ext.Component', {\n    autoLoad: 'content.html',\n    renderTo: Ext.getBody()\n});\n

\n\n

The above is the same as:

\n\n

Ext.create('Ext.Component', {\n    loader: {\n        url: 'content.html',\n        autoLoad: true\n    },\n    renderTo: Ext.getBody()\n});\n

\n\n

Don't use it together with loader config.

This cfg has been deprecated since 4.1.1

Use loader config instead.

\n\n

autoRender : Boolean/String/HTMLElement/Ext.Element

This config is intended mainly for non-floating Components which may or may not be shown. ...

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using\nrenderTo in the configuration, and rendering upon construction, this allows a Component to render itself\nupon first show. If floating is true, the value of this config is omited as if it is true.

\n\n

Specify as true to have this Component render to the document body upon first show.

\n\n

Specify as an element, or the ID of an element to have this Component render to a specific element upon first\nshow.

Defaults to: false

autoScroll : Boolean

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

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary,\nfalse to clip any overflowing content.\nThis should not be combined with overflowX or overflowY.

Defaults to: false

autoShow : Boolean

True to automatically show the component upon creation. ...

True to automatically show the component upon creation. This config option may only be used for\nfloating components or components that use autoRender. Defaults to false.

Defaults to: false

baseBodyCls : String

The CSS class to be applied to the body content element. ...

The CSS class to be applied to the body content element.

Defaults to: "x-form-item-body"

baseCls : String

The base CSS class to apply to this components's element. ...

The base CSS class to apply to this components's element. This will also be prepended to elements within this\ncomponent like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and\nyou want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use\ncomponentCls to add specific styling for this component.

Defaults to: "x-component"

beforeBodyEl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nat the beginning of the input containing ...

An optional string or XTemplate configuration to insert in the field markup\nat the beginning of the input containing element. If an XTemplate is used, the component's render data\nserves as the context.

beforeLabelTextTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nbefore the label text. ...

An optional string or XTemplate configuration to insert in the field markup\nbefore the label text. If an XTemplate is used, the component's render data\nserves as the context.

beforeLabelTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nbefore the label element. ...

An optional string or XTemplate configuration to insert in the field markup\nbefore the label element. If an XTemplate is used, the component's render data\nserves as the context.

beforeSubTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\nbefore the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup\nbefore the subTpl markup. If an XTemplate is used, the\ncomponent's render data serves as the context.

blankText : String

The error text to display if the allowBlank validation fails ...

The error text to display if the allowBlank validation fails

Defaults to: "This field is required"

border : Number/String/Boolean

Specifies the border size for this component. ...

Specifies the border size for this component. The border can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.

\n\n

For components that have no border by default, setting this won't make the border appear by itself.\nYou also need to specify border color and style:

\n\n

border: 5,\nstyle: {\n    borderColor: 'red',\n    borderStyle: 'solid'\n}\n

\n\n

To turn off the border, use border: false.

checkChangeBuffer : Number

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession. ...

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession.\nDefaults to 50 milliseconds.

Defaults to: 50

checkChangeEvents : String[]

A list of event names that will be listened for on the field's input element, which will cause\nthe field's value to b...

A list of event names that will be listened for on the field's input element, which will cause\nthe field's value to be checked for changes. If a change is detected, the change event will be\nfired, followed by validation if the validateOnChange option is enabled.

\n\n

Defaults to ['change', 'propertychange'] in Internet Explorer, and ['change', 'input', 'textInput', 'keyup',\n'dragdrop'] in other browsers. This catches all the ways that field values can be changed in most supported\nbrowsers; the only known exceptions at the time of writing are:

\n\n

Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas
Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text fields\nand textareas
Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas

\n\n\n

If you need to guarantee on-the-fly change notifications including these edge cases, you can call the\ncheckChange method on a repeating interval, e.g. using Ext.TaskManager, or if the field is within\na Ext.form.Panel, you can use the FormPanel's Ext.form.Panel.pollForChanges configuration to set up\nsuch a task automatically.

childEls : Object[]

An array describing the child elements of the Component. ...

An array describing the child elements of the Component. Each member of the array\nis an object with these properties:

\n\n

name - The property name on the Component for the child element.
itemId - The id to combine with the Component's id that is the id of the child element.
id - The id of the child element.

\n\n\n

If the array member is a string, it is equivalent to { name: m, itemId: m }.

\n\n

For example, a Component which renders a title and body text:

\n\n

Ext.create('Ext.Component', {\n    renderTo: Ext.getBody(),\n    renderTpl: [\n        '<h1 id=\"{id}-title\">{title}</h1>',\n        '<p>{msg}</p>',\n    ],\n    renderData: {\n        title: \"Error\",\n        msg: \"Something went wrong\"\n    },\n    childEls: [\"title\"],\n    listeners: {\n        afterrender: function(cmp){\n            // After rendering the component will have a title property\n            cmp.title.setStyle({color: \"red\"});\n        }\n    }\n});\n

\n\n

A more flexible, but somewhat slower, approach is renderSelectors.

clearCls : String

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to\nprovide...

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to\nprovide field clearing.

Defaults to: "x-clear"

cls : String

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

An optional extra CSS class that will be added to this component's Element. This can be useful\nfor adding customized styles to the component or any of its children using standard CSS rules.

Defaults to: ""

columnWidth : Number/String

Defines the column width inside column layout. ...

Defines the column width inside column layout.

\n\n

Can be specified as a number or as a percentage.

componentCls : String

CSS Class to be added to a components root level element to give distinction to it via styling.

componentLayout : String/Object

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout\nmanager...

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout\nmanager which sizes a Component's internal structure in response to the Component being sized.

\n\n

Generally, developers will not use this configuration as all provided Components which need their internal\nelements sizing (Such as input fields) come with their own componentLayout managers.

\n\n

The default layout manager will be used on instances of the base Ext.Component\nclass which simply sizes the Component's encapsulating element to the height and width specified in the\nsetSize method.

contentEl : String

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

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

\n\n

This config option is used to take an existing HTML element and place it in the layout element of a new component\n(it simply moves the specified DOM element after the Component is rendered to use as the content.

\n\n

Notes:

\n\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\nthe render event is fired.

\n\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\nitems.

\n\n

Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it\nis rendered to the panel.

data : Object

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

dirtyCls : String

The CSS class to use when the field value is dirty. ...

The CSS class to use when the field value is dirty.

Defaults to: "x-form-dirty"

disableKeyFilter : Boolean

Specify true to disable input keystroke filtering ...

Specify true to disable input keystroke filtering

Defaults to: false

disabled : Boolean

True to disable the field. ...

True to disable the field. Disabled Fields will not be submitted.

Defaults to: false

Overrides: Ext.AbstractComponent.disabled

disabledCls : String

CSS class to add when the Component is disabled. ...

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

Defaults to: "x-item-disabled"

draggable : Boolean/Object

Specify as true to make a floating Component draggable using the Component's encapsulating element as\nthe drag handle. ...

Specify as true to make a floating Component draggable using the Component's encapsulating element as\nthe drag handle.

\n\n

This may also be specified as a config object for the ComponentDragger which is\ninstantiated to perform dragging.

\n\n

For example to create a Component which may only be dragged around using a certain internal element as the drag\nhandle, use the delegate option:

\n\n

new Ext.Component({\n    constrain: true,\n    floating: true,\n    style: {\n        backgroundColor: '#fff',\n        border: '1px solid black'\n    },\n    html: '<h1 style=\"cursor:move\">The title</h1><p>The content</p>',\n    draggable: {\n        delegate: 'h1'\n    }\n}).show();\n

Defaults to: false

Overrides: Ext.AbstractComponent.draggable

Ext.form.field.Trigger
view source

editable : Boolean

false to prevent the user from typing text directly into the field; the field can only have its value set via an\nacti...

false to prevent the user from typing text directly into the field; the field can only have its value set via an\naction invoked by the trigger.

Defaults to: true

emptyCls : String

The CSS class to apply to an empty field to style the emptyText. ...

The CSS class to apply to an empty field to style the emptyText.\nThis class is automatically added and removed as needed depending on the current field value.

Defaults to: "x-form-empty-field"

emptyText : String

The default text to place into an empty field. ...

The default text to place into an empty field.

\n\n

Note that normally this value will be submitted to the server if this field is enabled; to prevent this you can\nset the submitEmptyText option of Ext.form.Basic.submit to\nfalse.

\n\n

Also note that if you use inputType:'file', emptyText is not supported and should be\navoided.

\n\n

Note that for browsers that support it, setting this property will use the HTML 5 placeholder attribute, and for\nolder browsers that don't support the HTML 5 placeholder attribute the value will be placed directly into the input\nelement itself as the raw value. This means that older browsers will obfuscate the emptyText value for\npassword input fields.

enableKeyEvents : Boolean

true to enable the proxying of key events for the HTML input field ...

true to enable the proxying of key events for the HTML input field

Defaults to: false

enforceMaxLength : Boolean

True to set the maxLength property on the underlying input field. ...

True to set the maxLength property on the underlying input field. Defaults to false

errorMsgCls : String

The CSS class to be applied to the error message element. ...

The CSS class to be applied to the error message element.

Defaults to: "x-form-error-msg"

fieldBodyCls : String

An extra CSS class to be applied to the body content element in addition to baseBodyCls. ...

An extra CSS class to be applied to the body content element in addition to baseBodyCls.

Defaults to: ""

fieldCls : String

The default CSS class for the field input ...

The default CSS class for the field input

Defaults to: "x-form-field"

fieldLabel : String

The label for the field. ...

The label for the field. It gets appended with the labelSeparator, and its position and sizing is\ndetermined by the labelAlign, labelWidth, and labelPad configs.

fieldStyle : String

Optional CSS style(s) to be applied to the field input element. ...

Optional CSS style(s) to be applied to the field input element. Should be a valid argument to\nExt.Element.applyStyles. Defaults to undefined. See also the setFieldStyle method for changing\nthe style after initialization.

fieldSubTpl : Ext.XTemplateprivate

The content of the field body is defined by this config option. ...

The content of the field body is defined by this config option.

Defaults to: ["<input id="{id}" type="{type}" {inputAttrTpl}", " size="1"", "<tpl if="name"> name="{name}"</tpl>", "<tpl if="value"> value="{[Ext.util.Format.htmlEncode(values.value)]}"</tpl>", "<tpl if="placeholder"> placeholder="{placeholder}"</tpl>", "{%if (values.maxLength !== undefined){%} maxlength="{maxLength}"{%}%}", "<tpl if="readOnly"> readonly="readonly"</tpl>", "<tpl if="disabled"> disabled="disabled"</tpl>", "<tpl if="tabIdx"> tabIndex="{tabIdx}"</tpl>", "<tpl if="fieldStyle"> style="{fieldStyle}"</tpl>", " class="{fieldCls} {typeCls} {editableCls}" autocomplete="off"/>", {disableFormats: true}]

floating : Boolean

Specify as true to float the Component outside of the document flow using CSS absolute positioning. ...

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

\n\n

Components such as Windows and Menus are floating by default.

\n\n

Floating Components that are programatically rendered will register\nthemselves with the global ZIndexManager

\n\n

Floating Components as child items of a Container

\n\n

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek\na ZIndexManager by examining the ownerCt chain.

\n\n

When configured as floating, Components acquire, at render time, a ZIndexManager which\nmanages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top\nof its stack when the Component's toFront method is called.

\n\n

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is\nfloating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown\nwithin a Window) can have its zIndex managed relative to any siblings, but always above that floating\nancestor Container.

\n\n

If no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.

\n\n

Floating components do not participate in the Container's layout. Because of this, they are not rendered until\nyou explicitly show them.

\n\n

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found\nfloating ancestor Container. If no floating ancestor Container was found the floatParent property will\nnot be set.

Defaults to: false

Overrides: Ext.AbstractComponent.floating

focusCls : String

The CSS class to use when the field receives focus ...

The CSS class to use when the field receives focus

Defaults to: "x-form-focus"

focusOnToFront : Boolean

Specifies whether the floated component should be automatically focused when\nit is brought to the front. ...

Specifies whether the floated component should be automatically focused when\nit is brought to the front.

Defaults to: true

formBind : Boolean

When inside FormPanel, any component configured with formBind: true will\nbe enabled/disabled depending on the validit...

When inside FormPanel, any component configured with formBind: true will\nbe enabled/disabled depending on the validity state of the form.\nSee Ext.form.Panel for more information and example.

Defaults to: false

formItemCls : String

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout. ...

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout.

Defaults to: "x-form-item"

frame : Boolean

Specify as true to have the Component inject framing elements within the Component at render time to provide a\ngraphi...

Specify as true to have the Component inject framing elements within the Component at render time to provide a\ngraphical rounded frame around the Component content.

\n\n

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet\nExplorer prior to version 9 which do not support rounded corners natively.

\n\n

The extra space taken up by this framing is available from the read only property frameSize.

Ext.form.field.Trigger
view source

grow : Booleanprivate

Overrides: Ext.form.field.Text.grow

growAppend : String

A string that will be appended to the field's current value for the purposes of calculating the target field\nsize. ...

A string that will be appended to the field's current value for the purposes of calculating the target field\nsize. Only used when the grow config is true. Defaults to a single capital \"W\" (the widest character in\ncommon fonts) to leave enough space for the next typed character and avoid the field value shifting before the\nwidth is adjusted.

Defaults to: "W"

Ext.form.field.Trigger
view source

growMax : Numberprivate

Overrides: Ext.form.field.Text.growMax

Ext.form.field.Trigger
view source

growMin : Numberprivate

Overrides: Ext.form.field.Text.growMin

height : Number

The height of this component in pixels.

hidden : Boolean

True to hide the component. ...

True to hide the component.

Defaults to: false

hideEmptyLabel : Boolean

When set to true, the label element (fieldLabel and labelSeparator) will be automatically\nhidden if the fieldLabel is...

When set to true, the label element (fieldLabel and labelSeparator) will be automatically\nhidden if the fieldLabel is empty. Setting this to false will cause the empty label element to be\nrendered and space to be reserved for it; this is useful if you want a field without a label to line up with\nother labeled fields in the same form.

\n\n

If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set the\nhideLabel config to true.

Defaults to: true

hideLabel : Boolean

Set to true to completely hide the label element (fieldLabel and labelSeparator). ...

Set to true to completely hide the label element (fieldLabel and labelSeparator). Also see\nhideEmptyLabel, which controls whether space will be reserved for an empty fieldLabel.

Defaults to: false

hideMode : String

A String which specifies how this Component's encapsulating DOM element will be hidden. ...

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:

\n\n

'display' : The Component will be hidden using the display: none style.
'visibility' : The Component will be hidden using the visibility: hidden style.
'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document.\nThis is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a\nComponent having zero dimensions.

\n\n

Defaults to: "display"

Ext.form.field.Trigger
view source

hideTrigger : Boolean

true to hide the trigger element and display only the base text field ...

true to hide the trigger element and display only the base text field

Defaults to: false

html : String/Object

An HTML fragment, or a DomHelper specification to use as the layout element content. ...

An HTML fragment, or a DomHelper specification to use as the layout element content.\nThe HTML content is added after the component is rendered, so the document will not contain this HTML at the time\nthe render event is fired. This content is inserted into the body before any configured contentEl\nis appended.

Defaults to: ""

id : String

The unique id of this component instance. ...

The unique id of this component instance.

\n\n

It should not be necessary to use this configuration except for singleton objects in your application. Components\ncreated with an id may be accessed globally using Ext.getCmp.

\n\n

Instead of using assigned ids, use the itemId config, and ComponentQuery\nwhich provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query\nits descendant Components by selector.

\n\n

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

\n\n

Note: to avoid complications imposed by a unique id also see itemId.

\n\n

Note: to access the container of a Component see ownerCt.

\n\n

Defaults to an auto-assigned id.

inputAttrTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\ninside the input element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup\ninside the input element (as attributes). If an XTemplate is used, the component's\nsubTpl data serves as the context.

inputId : String

The id that will be given to the generated input DOM element. ...

The id that will be given to the generated input DOM element. Defaults to an automatically generated id. If you\nconfigure this manually, you must make sure it is unique in the document.

inputType : String

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

The type attribute for input fields -- e.g. radio, text, password, file. The extended types\nsupported by HTML5 inputs (url, email, etc.) may also be used, though using them will cause older browsers to\nfall back to 'text'.

\n\n

The type 'password' must be used to render that field type currently -- there is no separate Ext component for\nthat. You can use Ext.form.field.File which creates a custom-rendered file upload field, but if you want\na plain unstyled file input you can use a Base with inputType:'file'.

Defaults to: "text"

invalidCls : String

The CSS class to use when marking the component invalid. ...

The CSS class to use when marking the component invalid.

Defaults to: "x-form-invalid"

invalidText : String

The error text to use when marking a field invalid and no message is provided ...

The error text to use when marking a field invalid and no message is provided

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

itemId : String

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

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

\n\n

var c = new Ext.panel.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

Also see id, Ext.container.Container.query, Ext.container.Container.down and\nExt.container.Container.child.

\n\n

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

labelAlign : String

Controls the position and alignment of the fieldLabel. ...

Controls the position and alignment of the fieldLabel. Valid values are:

\n\n

\"left\" (the default) - The label is positioned to the left of the field, with its text aligned to the left.\nIts width is determined by the labelWidth config.
\"top\" - The label is positioned above the field.
\"right\" - The label is positioned to the left of the field, with its text aligned to the right.\nIts width is determined by the labelWidth config.

\n\n

Defaults to: "left"

labelAttrTpl : String/Array/Ext.XTemplate

An optional string or XTemplate configuration to insert in the field markup\ninside the label element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup\ninside the label element (as attributes). If an XTemplate is used, the component's\nrender data serves as the context.

labelCls : String

The CSS class to be applied to the label element. ...

The CSS class to be applied to the label element. This (single) CSS class is used to formulate the renderSelector\nand drives the field layout where it is concatenated with a hyphen ('-') and labelAlign. To add\nadditional classes, use labelClsExtra.

Defaults to: "x-form-item-label"

labelClsExtra : String

An optional string of one or more additional CSS classes to add to the label element. ...

An optional string of one or more additional CSS classes to add to the label element. Defaults to empty.

labelPad : Number

The amount of space in pixels between the fieldLabel and the input field. ...

The amount of space in pixels between the fieldLabel and the input field.

Defaults to: 5

labelSeparator : String

Character(s) to be inserted at the end of the label text. ...

Character(s) to be inserted at the end of the label text.

\n\n

Set to empty string to hide the separator completely.

Defaults to: ":"

labelStyle : String

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

labelWidth : Number

The width of the fieldLabel in pixels. ...

The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to \"left\" or\n\"right\".

Defaults to: 100

labelableRenderTpl : String/String[]/Ext.XTemplateprivate

The rendering template for the field decorations. ...

The rendering template for the field decorations. Component classes using this mixin\nshould include logic to use this as their renderTpl,\nand implement the getSubTplMarkup method to generate the field body content.

\n\n

The structure of a field is a table as follows:

\n\n

If labelAlign: 'left',msgTarget: 'side'`

\n\n

 +----------------------+----------------------+-------------+\n | Label:               | InputField           | sideErrorEl |\n +----------------------+----------------------+-------------+\n

\n\n

If labelAlign: 'left',msgTarget: 'under'`

\n\n

 +----------------------+------------------------------------+\n | Label:               | InputField      (colspan=2)        |\n |                      | underErrorEl                       |\n +----------------------+------------------------------------+\n

\n\n

If labelAlign: 'top',msgTarget: 'side'`

\n\n

 +---------------------------------------------+-------------+\n | label                                       |             |\n | InputField                                  | sideErrorEl |\n +---------------------------------------------+-------------+\n

\n\n

If labelAlign: 'top',msgTarget: 'under'`

\n\n

 +-----------------------------------------------------------+\n | label                                                     |\n | InputField                      (colspan=2)               |\n | underErrorEl                                              |\n +-----------------------------------------------------------+\n

\n\n

The total columns always the same for fields with each setting of labelAlign because when\nrendered into a Ext.layout.container.Form layout, just the TR of the table\nwill be placed into the form's main TABLE, and the columns of all the siblings\nmust match so that they all line up. In a Ext.layout.container.Form layout, different\nsettings of labelAlign are not supported because of the incompatible column structure.

\n\n

When the triggerCell or side error cell are hidden or shown, the input cell's colspan\nis recalculated to maintain the correct 3 visible column count.

Defaults to: ["<tr id="{id}-inputRow" <tpl if="inFormLayout">id="{id}"</tpl>>", "<tpl if="labelOnLeft">", "<td id="{id}-labelCell" style="{labelCellStyle}" {labelCellAttrs}>", "{beforeLabelTpl}", "<label id="{id}-labelEl" {labelAttrTpl}<tpl if="inputId"> for="{inputId}"</tpl> class="{labelCls}"", "<tpl if="labelStyle"> style="{labelStyle}"</tpl>>", "{beforeLabelTextTpl}", "<tpl if="fieldLabel">{fieldLabel}{labelSeparator}</tpl>", "{afterLabelTextTpl}", "</label>", "{afterLabelTpl}", "</td>", "</tpl>", "<td class="{baseBodyCls} {fieldBodyCls}" id="{id}-bodyEl" colspan="{bodyColspan}" role="presentation">", "{beforeBodyEl}", "<tpl if="labelAlign==\\'top\\'">", "{beforeLabelTpl}", "<div id="{id}-labelCell" style="{labelCellStyle}">", "<label id="{id}-labelEl" {labelAttrTpl}<tpl if="inputId"> for="{inputId}"</tpl> class="{labelCls}"", "<tpl if="labelStyle"> style="{labelStyle}"</tpl>>", "{beforeLabelTextTpl}", "<tpl if="fieldLabel">{fieldLabel}{labelSeparator}</tpl>", "{afterLabelTextTpl}", "</label>", "</div>", "{afterLabelTpl}", "</tpl>", "{beforeSubTpl}", "{[values.$comp.getSubTplMarkup()]}", "{afterSubTpl}", "<tpl if="msgTarget===\\'side\\'">", "{afterBodyEl}", "</td>", "<td id="{id}-sideErrorCell" vAlign="{[values.labelAlign===\\'top\\' && !values.hideLabel ? \\'bottom\\' : \\'middle\\']}" style="{[values.autoFitErrors ? \\'display:none\\' : \\'\\']}" width="{errorIconWidth}">", "<div id="{id}-errorEl" class="{errorMsgCls}" style="display:none;width:{errorIconWidth}px"></div>", "</td>", "<tpl elseif="msgTarget==\\'under\\'">", "<div id="{id}-errorEl" class="{errorMsgClass}" colspan="2" style="display:none"></div>", "{afterBodyEl}", "</td>", "</tpl>", "</tr>", {disableFormats: true}]

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. ...

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

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n

loader : Ext.ComponentLoader/Object

A configuration object or an instance of a Ext.ComponentLoader to load remote content\nfor this Component. ...

A configuration object or an instance of a Ext.ComponentLoader to load remote content\nfor this Component.

\n\n

Ext.create('Ext.Component', {\n    loader: {\n        url: 'content.html',\n        autoLoad: true\n    },\n    renderTo: Ext.getBody()\n});\n

margin : Number/String

Specifies the margin for this component. ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.

maskRe : RegExp

An input mask regular expression that will be used to filter keystrokes (character being\ntyped) that do not match. ...

An input mask regular expression that will be used to filter keystrokes (character being\ntyped) that do not match.\nNote: It does not filter characters already in the input.

maxHeight : Number

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

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

\n\n

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

maxLength : Number

Maximum input field length allowed by validation. ...

Maximum input field length allowed by validation. This behavior is intended to\nprovide instant feedback to the user by improving usability to allow pasting and editing or overtyping and back\ntracking. To restrict the maximum number of characters that can be entered into the field use the\nenforceMaxLength option.

\n\n

Defaults to Number.MAX_VALUE.

maxLengthText : String

Error text to display if the maximum length validation fails ...

Error text to display if the maximum length validation fails

Defaults to: "The maximum length for this field is {0}"

maxWidth : Number

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

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

\n\n

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

minHeight : Number

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

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

\n\n

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

minLength : Number

Minimum input field length required ...

Minimum input field length required

Defaults to: 0

minLengthText : String

Error text to display if the minimum length validation fails. ...

Error text to display if the minimum length validation fails.

Defaults to: "The minimum length for this field is {0}"

minWidth : Number

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

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

\n\n

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

msgTarget : String

The location where the error message text should display. ...

The location where the error message text should display. Must be one of the following values:

\n\n

qtip Display a quick tip containing the message when the user hovers over the field.\nThis is the default.
\n\n
Ext.tip.QuickTipManager.init must have been called for this setting to work.
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.
none Don't display any error message. This might be useful if you are implementing custom error display.
[element id] Add the error message directly to the innerHTML of the specified element.

\n\n

Defaults to: "qtip"

name : String

The name of the field. ...

The name of the field. This is used as the parameter name when including the field value\nin a form submit(). If no name is configured, it falls back to the inputId.\nTo prevent the field from being included in the form submit, set submitValue to false.

Overrides: Ext.form.field.Field.name

overCls : String

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

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

Defaults to: ""

overflowX : String

Possible values are:\n * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). ...

Possible values are:\n * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto').\n * 'scroll' to always enable horizontal scrollbar (overflow-x: 'scroll').\nThe default is overflow-x: 'hidden'. This should not be combined with autoScroll.

overflowY : String

Possible values are:\n * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). ...

Possible values are:\n * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto').\n * 'scroll' to always enable vertical scrollbar (overflow-y: 'scroll').\nThe default is overflow-y: 'hidden'. This should not be combined with autoScroll.

padding : Number/String

Specifies the padding for this component. ...

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it\ncan be a CSS style specification for each style, for example: '10 5 3 10'.

plugins : Object/Object[]

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 requirement for\na valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component\nis created, if any plugins are available, the component will call the init method on each plugin, passing a\nreference to itself. Each plugin can then call methods or respond to events on the component as needed to provide\nits functionality.

preventMark : Boolean

true to disable displaying any error message set on this object. ...

true to disable displaying any error message set on this object.

Defaults to: false

Ext.form.field.Trigger
view source

readOnly : Boolean

true to prevent the user from changing the field, and hides the trigger. ...

true to prevent the user from changing the field, and hides the trigger. Supercedes the editable and hideTrigger\noptions if the value is true.

Defaults to: false

Overrides: Ext.form.field.Base.readOnly

readOnlyCls : String

The CSS class applied to the component's main element when it is readOnly. ...

The CSS class applied to the component's main element when it is readOnly.

Defaults to: "x-form-readonly"

regex : RegExp

A JavaScript RegExp object to be tested against the field value during validation. ...

A JavaScript RegExp object to be tested against the field value during validation.\nIf the test fails, the field will be marked invalid using\neither regexText or invalidText.

regexText : String

The error text to display if regex is used and the test fails during validation ...

The error text to display if regex is used and the test fails during validation

Defaults to: ""

region : String

Defines the region inside border layout. ...

Defines the region inside border layout.

\n\n

Possible values:

\n\n

center
north
south
east
west

\n\n

renderData : Object

The data used by renderTpl in addition to the following property values of the component:\n\n\nid\nui\nuiCls\nbaseCls\ncompo...

The data used by renderTpl in addition to the following property values of the component:

\n\n

id
ui
uiCls
baseCls
componentCls
frame

\n\n\n

See renderSelectors and childEls for usage examples.

renderSelectors : Object

An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render pro...

An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render process.

\n\n

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through,\nand the found Elements are added as properties to the Component using the renderSelector property name.

\n\n

For example, a Component which renderes a title and description into its element:

\n\n

Ext.create('Ext.Component', {\n    renderTo: Ext.getBody(),\n    renderTpl: [\n        '<h1 class=\"title\">{title}</h1>',\n        '<p>{desc}</p>'\n    ],\n    renderData: {\n        title: \"Error\",\n        desc: \"Something went wrong\"\n    },\n    renderSelectors: {\n        titleEl: 'h1.title',\n        descEl: 'p'\n    },\n    listeners: {\n        afterrender: function(cmp){\n            // After rendering the component will have a titleEl and descEl properties\n            cmp.titleEl.setStyle({color: \"red\"});\n        }\n    }\n});\n

\n\n

For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the\nComponent after render), see childEls and addChildEls.

renderTo : String/HTMLElement/Ext.Element

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

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

\n\n

Notes:

\n\n

Do not use this option if the Component is to be a child item of a Container.\nIt is the responsibility of the Container's\nlayout manager to render and manage its child items.

\n\n

When using this config, a call to render() is not required.

\n\n

Parameters

value : Object
The current field value
\n

Returns

Boolean/String
- True if the value is valid
- An error message if the value is invalid
\n\n

value : Object

A value to initialize this field with.

vtype : String

A validation type name as defined in Ext.form.field.VTypes

vtypeText : String

A custom error message to display in place of the default message provided for the vtype currently\nset for this field. ...

A custom error message to display in place of the default message provided for the vtype currently\nset for this field. Note: only applies if vtype is set, else ignored.

width : Number

The width of this component in pixels.

xtype : String

This property provides a shorter alternative to creating objects than using a full\nclass name. ...

This property provides a shorter alternative to creating objects than using a full\nclass name. Using xtype is the most common way to define component instances,\nespecially in a container. For example, the items in a form containing text fields\ncould be created explicitly like so:

\n\n

 items: [\n     Ext.create('Ext.form.field.Text', {\n         fieldLabel: 'Foo'\n     }),\n     Ext.create('Ext.form.field.Text', {\n         fieldLabel: 'Bar'\n     }),\n     Ext.create('Ext.form.field.Number', {\n         fieldLabel: 'Num'\n     })\n ]\n

\n\n

But by using xtype, the above becomes:

\n\n

 items: [\n     {\n         xtype: 'textfield',\n         fieldLabel: 'Foo'\n     },\n     {\n         xtype: 'textfield',\n         fieldLabel: 'Bar'\n     },\n     {\n         xtype: 'numberfield',\n         fieldLabel: 'Num'\n     }\n ]\n

\n\n

When the xtype is common to many items, Ext.container.AbstractContainer.defaultType\nis another way to specify the xtype for all items that don't have an explicit xtype:

\n\n

 defaultType: 'textfield',\n items: [\n     { fieldLabel: 'Foo' },\n     { fieldLabel: 'Bar' },\n     { fieldLabel: 'Num', xtype: 'numberfield' }\n ]\n

\n\n

Each member of the items array is now just a \"configuration object\". These objects\nare used to create and configure component instances. A configuration object can be\nmanually used to instantiate a component using Ext.widget:

\n\n

 var text1 = Ext.create('Ext.form.field.Text', {\n     fieldLabel: 'Foo'\n });\n\n // or alternatively:\n\n var text1 = Ext.widget({\n     xtype: 'textfield',\n     fieldLabel: 'Foo'\n });\n

\n\n

This conversion of configuration objects into instantiated components is done when\na container is created as part of its {Ext.container.AbstractContainer.initComponent}\nprocess. As part of the same process, the items array is converted from its raw\narray form into a Ext.util.MixedCollection instance.

\n\n

You can define your own xtype on a custom component by specifying\nthe xtype property in Ext.define. For example:

\n\n

Ext.define('MyApp.PressMeButton', {\n    extend: 'Ext.button.Button',\n    xtype: 'pressmebutton',\n    text: 'Press Me'\n});\n

\n\n

Care should be taken when naming an xtype in a custom component because there is\na single, shared scope for all xtypes. Third part components should consider using\na prefix to avoid collisions.

\n\n

Ext.define('Foo.form.CoolButton', {\n    extend: 'Ext.button.Button',\n    xtype: 'ux-coolbutton',\n    text: 'Cool!'\n});\n

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: "Ext.Base"

_isLayoutRoot : Booleanprotected

Setting this property to true causes the isLayoutRoot method to return\ntrue and stop the search for the top-most comp...

Setting this property to true causes the isLayoutRoot method to return\ntrue and stop the search for the top-most component for a layout.

Defaults to: false

autoGenId : Booleanprivate

true indicates an id was auto-generated rather than provided by configuration. ...

true indicates an id was auto-generated rather than provided by configuration.

Defaults to: false

bodyEl : Ext.Element

The div Element wrapping the component's contents. ...

The div Element wrapping the component's contents. Only available after the component has been rendered.

componentLayoutCounter : Numberprivate

The number of component layout calls made on this object. ...

The number of component layout calls made on this object.

Defaults to: 0

configMap : Objectprivate

...

Defaults to: {}

draggable : Booleanreadonly

Indicates whether or not the component can be dragged. ...

Indicates whether or not the component can be dragged.

Defaults to: false

errorEl : Ext.Element

The div Element that will contain the component's error message(s). ...

The div Element that will contain the component's error message(s). Note that depending on the configured\nmsgTarget, this element may be hidden in favor of some other form of presentation, but will always\nbe present in the DOM for use by assistive technologies.

eventsSuspended : Numberprivate

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

floatParent : Ext.Containerreadonly

Only present for floating Components which were inserted as child items of Containers. ...

Only present for floating Components which were inserted as child items of Containers.

\n\n

Floating Components that are programatically rendered will not have a floatParent\nproperty.

\n\n

For floating Components which are child items of a Container, the floatParent will be the owning Container.

\n\n

For example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its floatParent

\n\n

See floating and zIndexManager

frameSize : Objectreadonly

Indicates the width of any framing elements which were added within the encapsulating element\nto provide graphical, r...

Indicates the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.

\n\n

This is an object containing the frame width in pixels for all four sides of the Component containing the\nfollowing properties:

Defaults to: {left: 0, top: 0, right: 0, bottom: 0, width: 0, height: 0}

top : Number (optional)
The width of the top framing element in pixels.
\n
Defaults to: 0
right : Number (optional)
The width of the right framing element in pixels.
\n
Defaults to: 0
bottom : Number (optional)
The width of the bottom framing element in pixels.
\n
Defaults to: 0
left : Number (optional)
The width of the left framing element in pixels.
\n
Defaults to: 0
width : Number (optional)
The total width of the left and right framing elements in pixels.
\n
Defaults to: 0
height : Number (optional)
The total height of the top and right bottom elements in pixels.
\n
Defaults to: 0

hasListeners : Objectreadonly

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

The intended use of this property is to avoid the expense of fireEvent calls when\nthere are no listeners. This can be particularly helpful when one would otherwise\nhave to call fireEvent hundreds or thousands of times. It is used like this:

\n\n

 if (this.hasListeners.foo) {\n     this.fireEvent('foo', this, arg1);\n }\n

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

Ext.form.field.Trigger
view source

inputCell : Ext.Element

A reference to the TD element wrapping the input element. ...

A reference to the TD element wrapping the input element. Only set after the field has been rendered.

inputEl : Ext.Element

The input Element for this Field. ...

The input Element for this Field. Only available after the field has been rendered.

isComponent : Boolean

true in this class to identify an object as an instantiated Component, or subclass thereof. ...

true in this class to identify an object as an instantiated Component, or subclass thereof.

Defaults to: true

isFieldLabelable : Boolean

Flag denoting that this object is labelable as a field. ...

Flag denoting that this object is labelable as a field. Always true.

Defaults to: true

isFormField : Boolean

Flag denoting that this component is a Field. ...

Flag denoting that this component is a Field. Always true.

Defaults to: true

isInstance : Booleanprivate

...

Defaults to: true

isObservable : Boolean

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

labelCell : Ext.Element

The <TD> Element which contains the label Element for this component. ...

The <TD> Element which contains the label Element for this component. Only available after the component has been rendered.

labelEl : Ext.Element

The label Element for this component. ...

The label Element for this component. Only available after the component has been rendered.

maskOnDisable : Boolean

This is an internal flag that you use when creating custom components. ...

This is an internal flag that you use when creating custom components. By default this is set to true which means\nthat every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab\noverride this property to false since they want to implement custom disable logic.

Defaults to: true

noWrap : Booleanprivate

Tells the layout system that the height can be measured immediately because the width does not need setting. ...

Tells the layout system that the height can be measured immediately because the width does not need setting.

Defaults to: true

originalValue : Object

The original value of the field as configured in the value configuration, or as loaded by the last\nform load operatio...

The original value of the field as configured in the value configuration, or as loaded by the last\nform load operation if the form's trackResetOnLoad setting is true.

ownerCt : Ext.Containerreadonly

This Component's owner Container (is set automatically\nwhen this Component is added to a Container). ...

This Component's owner Container (is set automatically\nwhen this Component is added to a Container).

\n\n

Note: to access items within the Container see itemId.

rendered : Booleanreadonly

Indicates whether or not the component has been rendered. ...

Indicates whether or not the component has been rendered.

Defaults to: false

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

triggerEl : Ext.CompositeElement

suspendCheckChange : Numberprivate

...

Defaults to: 0

Ext.form.field.Trigger
view source

A composite of all the trigger button elements. ...

A composite of all the trigger button elements. Only set after the field has been rendered.

Ext.form.field.Trigger
view source

triggerWidth : Numberprivate

Width of the trigger element. ...

Width of the trigger element. Unless set explicitly, it will be\nautomatically calculated through creating a temporary element\non page. (That will be done just once per app run.)

Ext.form.field.Trigger
view source

triggerWrap : Ext.Element

A reference to the TABLE element which encapsulates the input field and all trigger button(s). ...

A reference to the TABLE element which encapsulates the input field and all trigger button(s). Only set after the field has been rendered.

zIndexManager : Ext.ZIndexManagerreadonly

Only present for floating Components after they have been rendered. ...

Only present for floating Components after they have been rendered.

\n\n

A reference to the ZIndexManager which is managing this Component's z-index.

\n\n

The ZIndexManager maintains a stack of floating Component z-indices, and also provides\na single modal mask which is insert just beneath the topmost visible modal floating Component.

\n\n

Floating Components may be brought to the front or sent to the back of the\nz-index stack.

\n\n

This defaults to the global ZIndexManager for floating Components that are\nprogramatically rendered.

\n\n

For floating Components which are added to a Container, the ZIndexManager is acquired from the first\nancestor Container found which is floating. If no floating ancestor is found, the global ZIndexManager is\nused.

\n\n

See floating and zIndexParent

zIndexParent : Ext.Containerreadonly

Only present for floating Components which were inserted as child items of Containers, and which have a floating\nCont...

Only present for floating Components which were inserted as child items of Containers, and which have a floating\nContainer in their containment ancestry.

\n\n

For floating Components which are child items of a Container, the zIndexParent will be a floating\nancestor Container which is responsible for the base z-index value of all its floating descendants. It provides\na ZIndexManager which provides z-indexing services for all its descendant floating\nComponents.

\n\n

Floating Components that are programatically rendered will not have a zIndexParent\nproperty.

\n\n

For example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its zIndexParent, and will always show above that Window, wherever the Window is placed in the z-index stack.

\n\n

See floating and zIndexManager

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.util.ElementContainer
view source

newExt.form.field.Trigger( Ext.Element/String/Object config ) : Object

Creates new Component. ...

Creates new Component.

Parameters

config : Ext.Element/String/Object
The configuration options may be specified as either:
\n\n
- an element : it is set as the internal element and its id used as the component id
- a string : it is assumed to be the id of an existing element and is used as the component id
- anything else : it is assumed to be a standard config object and is applied to the component
\n\n

Returns

Object
\n

Overrides: Ext.AbstractComponent.constructor

addChildEls( )

Adds each argument passed to this method to the childEls array. ...

Adds each argument passed to this method to the childEls array.

addClass( String/String[] cls ) : Ext.Componentdeprecated

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

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

This method has been deprecated since 4.1

Use addCls instead.

\n\n

Parameters

cls : String/String[]
The CSS class name to add
\n\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n\n

addCls( String/String[] cls ) : Ext.Component

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

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

Parameters

cls : String/String[]
The CSS class name to add
\n\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n\n

addClsWithUI( String/String[] classes, Object skip )

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

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

Parameters

classes : String/String[]
A string or an array of strings to add to the uiCls
\n
skip : Object
(Boolean) skip True to skip adding it to the class and do it later (via the return)
\n

addEvents( Object/String... eventNames )

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

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

addFocusListener( )private

Sets up the focus listener on this Component's focusEl if it has one. ...

Sets up the focus listener on this Component's focusEl if it has one.

\n\n\n

Form Components which must implicitly participate in tabbing order usually have a naturally focusable\nelement as their focusEl, and it is the DOM event of that recieving focus which drives\nthe Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.

\n\n\n

If the focusEl is not naturally focusable, then the listeners are only added\nif the FocusManager is enabled.

\n\n

addListener( String/Object eventName, [Function fn], [Object scope], [Object options] )

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

addManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

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

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

Parameters

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

addPropertyToState( Object state, String propName, [String value] ) : Booleanprotected

Save a property to the given state object if it is not its default or configured\nvalue. ...

Save a property to the given state object if it is not its default or configured\nvalue.

Parameters

state : Object
The state object
\n
propName : String
The name of the property on this object to save.
\n
value : String (optional)
The value of the state property (defaults to this[propName]).
\n

Returns

Boolean
The state object or a new object if state was null and the property\nwas saved.
\n

addStateEvents( String/String[] events )

Add events that will trigger the state to be saved. ...

Add events that will trigger the state to be saved. If the first argument is an\narray, each element of that array is the name of a state event. Otherwise, each\nargument passed to this method is the name of a state event.

Parameters

events : String/String[]
The event name or an array of event names.
\n

addUIClsToElement( String ui )

Method which adds a specified UI + uiCls to the components element. ...

Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more\nthan just the components element.

Parameters

ui : String
The UI to remove from the element
\n

addUIToElement( )private

Method which adds a specified UI to the components element. ...

Method which adds a specified UI to the components element.

afterComponentLayout( Number width, Number height, Number oldWidth, Number oldHeight )protectedtemplate

Called by the layout system after the Component has been layed out. ...

Called by the layout system after the Component has been layed out.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

width : Number
The width that was set
\n
height : Number
The height that was set
\n
oldWidth : Number
The old width. undefined if this was the initial layout.
\n
oldHeight : Number
The old height. undefined if this was the initial layout.
\n

afterHide( [Function callback], [Object scope] )protectedtemplate

Invoked after the Component has been hidden. ...

Invoked after the Component has been hidden.

\n\n

Gets passed the same callback and scope parameters that onHide received.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

callback : Function (optional)
\n
scope : Object (optional)
\n

afterRender( )protectedtemplate

Allows addition of behavior after rendering is complete. ...

Allows addition of behavior after rendering is complete. At this stage the Component’s Element\nwill have been styled according to the configuration, will have had any configured CSS class\nnames added, and will be in the configured visibility and the configured enable state.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

afterSetPosition( Number x, Number y )protectedtemplate

Template method called after a Component has been positioned. ...

Template method called after a Component has been positioned.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

x : Number
\n
y : Number
\n

afterShow( [String/Ext.Element animateTarget], [Function callback], [Object scope] )protectedtemplate

Invoked after the Component is shown (after onShow is called). ...

Invoked after the Component is shown (after onShow is called).

\n\n

Gets passed the same parameters as show.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

alignTo( Ext.Component/Ext.Element/HTMLElement/String element, [String position], [Number[] offsets] ) : Ext.Component

Aligns this floating Component to the specified element ...

Aligns this floating Component to the specified element

Parameters

element : Ext.Component/Ext.Element/HTMLElement/String
The element or Ext.Component to align to. If passing a component, it must be a\ncomponent instance. If a string id is passed, it will be used as an element id.
\n
position : String (optional)
The position to align to\n(see Ext.Element.alignTo for more details).
\n
Defaults to: "tl-bl?"
offsets : Number[] (optional)
Offset the positioning by [x, y]
\n

Returns

Ext.Component
this
\n

Ext.util.ElementContainer
view source

animate( Object config ) : Object

Performs custom animation on this object. ...

Performs custom animation on this object.

\n\n

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

\n\n

Animating a Component

\n\n

When animating a Component, the following properties may be specified in from, to, and keyframe objects:

\n\n

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.\nUse sparingly as laying out on every intermediate size change is an expensive operation.

\n\n\n

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

\n\n

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

\n\n

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

Parameters

config : Object
Configuration for Ext.fx.Anim.\nNote that the to config is required.
\n

Returns

Object
this
\n

applyChildEls( Object el, Object id )private

Sets references to elements inside the component. ...

Sets references to elements inside the component.

Parameters

el : Object
\n
id : Object
\n

applyRenderSelectors( )private

Sets references to elements inside the component. ...

Sets references to elements inside the component. This applies renderSelectors\nas well as childEls.

applyState( Object state )

Applies the state to the object. ...

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

Parameters

state : Object
The state
\n

Ext.form.field.Trigger
view source

autoSize( )private

...

Overrides: Ext.form.field.Text.autoSize

batchChanges( Object fn )

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to\nprevent e...

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

Parameters

fn : Object
A function containing the transaction code
\n

beforeComponentLayout( Number adjWidth, Number adjHeight )protectedtemplate

Occurs before componentLayout is run. ...

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

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

adjWidth : Number
The box-adjusted width that was set
\n
adjHeight : Number
The box-adjusted height that was set
\n

beforeDestroy( )protectedtemplate

Invoked before the Component is destroyed. ...

Invoked before the Component is destroyed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

beforeReset( )protected

Template method before a field is reset. ...

Template method before a field is reset.

beforeSetPosition( Object x, Object y, Object animate )private

Template method called before a Component is positioned. ...

Template method called before a Component is positioned.

Parameters

x : Object
\n
y : Object
\n
animate : Object
\n

beforeShow( )protectedtemplate

Invoked before the Component is shown. ...

Invoked before the Component is shown.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

bubble( Function fn, [Object scope], [Array args] ) : Ext.Component

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\n(this) of function call will be the scope provided or the current component. The arguments to the function will\nbe 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
\n
scope : Object (optional)
The scope of the function. Defaults to current node.
\n
args : Array (optional)
The args to call the function with. Defaults to passing the current component.
\n

Returns

Ext.Component
this
\n

callOverridden( Array/Arguments args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( Array/Arguments args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

cancelFocus( )protected

Cancel any deferred focus on this component ...

Cancel any deferred focus on this component

cancelLayout( Ext.Component comp )

Cancels layout of a component. ...

Cancels layout of a component.

Parameters

comp : Ext.Component
\n

center( ) : Ext.Component

Center this Component in its container. ...

Center this Component in its container.

Returns

Ext.Component
this
\n

checkChange( )

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

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

\n\n

Fires the change event,
Performs validation if the validateOnChange config is enabled, firing the\nvaliditychange event if the validity has changed, and
Checks the dirty state of the field and fires the dirtychange event\nif it has changed.

\n\n

checkDirty( )

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

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

clearInvalid( )

Clear any invalid styles/messages for this field. ...

Clear any invalid styles/messages for this field.

\n\n

Note: this method does not cause the Field's validate or isValid methods to return true\nif the value does not pass validation. So simply clearing a field's errors will not necessarily allow\nsubmission of forms submitted with the Ext.form.action.Submit.clientValidation option set.

Overrides: Ext.form.field.Field.clearInvalid

clearListeners( )

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

cloneConfig( Object 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

configClass( )private

...

constructPlugins( )private

Returns an array of fully constructed plugin instances. ...

Returns an array of fully constructed plugin instances. This converts any configs into their\nappropriate instances.

\n\n

It does not mutate the plugins array. It creates a new array.

\n\n

This is borrowed by Lockable which clones and distributes Plugins\nto both child grids of a locking grid, so must keep to that contract.

continueFireEvent( String eventName, Array args, Boolean bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

convertPosition( Object pos, Object withUnits )private

This method converts an \"{x: x, y: y}\" object to a \"{left: x+'px', top: y+'px'}\" object. ...

This method converts an \"{x: x, y: y}\" object to a \"{left: x+'px', top: y+'px'}\" object.\nThe returned object contains the styles to set to effect the position. This is\noverridden in RTL mode to be \"{right: x, top: y}\".

Parameters

pos : Object
\n
withUnits : Object
\n

createRelayer( Object newName, [Array beginEnd] ) : Functionprivate

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

newName : Object
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice
\n

Returns

Function
\n

destroy( )private

...

Overrides: Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy, Ext.layout.Layout.destroy

disable( [Boolean silent] )

Disable the component. ...

Disable the component.

Parameters

silent : Boolean (optional)
Passing true will supress the 'disable' event from being fired.
\n
Defaults to: false

doApplyRenderTpl( Object out, Object values )private

Called from the selected frame generation template to insert this Component's inner structure inside the framing stru...

Called from the selected frame generation template to insert this Component's inner structure inside the framing structure.

\n\n

When framing is used, a selected frame generation template is used as the primary template of the #getElConfig instead\nof the configured renderTpl. The renderTpl is invoked by this method which is injected into the framing template.

Parameters

out : Object
\n
values : Object
\n

doAutoRender( )

Handles autoRender. ...

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

doComponentLayout( ) : Ext.container.Container

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

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

Returns

Ext.container.Container
this
\n

doConstrain( [String/HTMLElement/Ext.Element/Ext.util.Region constrainTo] )

Moves this floating Component into a constrain region. ...

Moves this floating Component into a constrain region.

\n\n

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

\n\n

An alternative constraint may be passed.

Parameters

constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region\ninto which this Component is to be constrained. Defaults to the element into which this floating Component\nwas rendered.
\n

enable( [Boolean silent] )

Enable the component ...

Enable the component

Parameters

silent : Boolean (optional)
Passing true will supress the 'enable' event from being fired.
\n
Defaults to: false

enableBubble( String/String[] eventNames )

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

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

\n\n

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

\n\n

Example:

\n\n

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

Parameters

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

ensureAttachedToBody( [Boolean runLayout] )

Ensures that this component is attached to document.body. ...

Ensures that this component is attached to document.body. If the component was\nrendered to Ext.getDetachedBody, then it will be appended to document.body.\nAny configured position is also restored.

Parameters

runLayout : Boolean (optional)
True to run the component's layout.
\n
Defaults to: false

extractFileInput( ) : HTMLElement

Only relevant if the instance's isFileUpload method returns true. ...

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

Returns

HTMLElement
\n

findParentBy( Function fn ) : Ext.container.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 true, the\ncontainer will be returned.

\n\n

Parameters

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

Returns

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

findParentByType( String/Ext.Class xtype ) : Ext.container.Container

Find a container above this component at any level by xtype or class\n\nSee also the up method. ...

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

\n\n

Parameters

xtype : String/Ext.Class
The xtype string for a component, or the class of the component directly
\n

Returns

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

finishRender( Number containerIdx )private

This method visits the rendered component tree in a \"top-down\" order. ...

This method visits the rendered component tree in a \"top-down\" order. That is, this\ncode runs on a parent component before running on a child. This method calls the\nonRender method of each component.

Parameters

containerIdx : Number
The index into the Container items of this Component.
\n

fireEvent( String eventName, Object... args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

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

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

focus( [Boolean selectText], [Boolean/Number delay] ) : Ext.Component

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
The focused Component. Usually this Component. Some Containers may\ndelegate focus to a descendant Component (Windows can do this through their\ndefaultFocus config option.
\n

forceComponentLayout( )deprecated

Forces this component to redo its componentLayout. ...

Forces this component to redo its componentLayout.

This method has been deprecated since 4.1.0

Use updateLayout instead.

\n\n

getActiveAnimation( ) : Ext.fx.Anim/Boolean

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

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

Returns

Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n

getActiveError( ) : String

Gets the active error message for this component, if any. ...

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely\nreturns 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.
\n

getActiveErrors( ) : String[]

Gets an Array of any active error messages currently applied to the field. ...

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

Returns

String[]
The active error messages on the component; if there are no errors, an empty Array is\nreturned.
\n

getAutoId( )private

...

getBodyColspan( )private

Calculates the colspan value for the body cell - the cell which contains the input field. ...

Calculates the colspan value for the body cell - the cell which contains the input field.

\n\n

The field table structure contains 4 columns:

getBox( [Boolean 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.
\n
Defaults to: false

Returns

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

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

getBubbleTarget( ) : Ext.container.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.Container
the Container which owns this Component.
\n

getConfig( Object name )private

...

Parameters

name : Object
\n

getConstrainVector( [String/HTMLElement/Ext.Element/Ext.util.Region constrainTo] ) : Number[]private

Gets the x/y offsets to constrain this float ...

Gets the x/y offsets to constrain this float

Parameters

constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region\ninto which this Component is to be constrained.
\n

Returns

Number[]
The x/y constraints
\n

getEl( ) : Ext.dom.Element

Retrieves the top level element representing this component. ...

Retrieves the top level element representing this component.

Returns

Ext.dom.Element
\n

getErrors( Object value ) : String[]

Validates a value according to the field's validation rules and returns an array of errors\nfor any failing validations. ...

Validates a value according to the field's validation rules and returns an array of errors\nfor any failing validations. Validation rules are processed in the following order:

\n\n

Field specific validator
\n\n
A validator offers a way to customize and reuse a validation specification.\n If a field is configured with a validator\n function, it will be passed the current field value. The validator\n function is expected to return either:
\n\n
- Boolean true if the value is valid (validation continues).
- a String to represent the invalid message if invalid (validation halts).
\n
Basic Validation
\n\n
If the validator has not halted validation,\n basic validation proceeds as follows:
\n\n
- allowBlank : (Invalid message = blankText)
  \n\n
  Depending on the configuration of allowBlank, a\n blank field will cause validation to halt at this step and return\n Boolean true or false accordingly.
- minLength : (Invalid message = minLengthText)
  \n\n
  If the passed value does not satisfy the minLength\n specified, validation halts.
- maxLength : (Invalid message = maxLengthText)
  \n\n
  If the passed value does not satisfy the maxLength\n specified, validation halts.
\n
Preconfigured Validation Types (VTypes)
\n\n
If none of the prior validation steps halts validation, a field\n configured with a vtype will utilize the\n corresponding VTypes validation function.\n If invalid, either the field's vtypeText or\n the VTypes vtype Text property will be used for the invalid message.\n Keystrokes on the field will be filtered according to the VTypes\n vtype Mask property.
Field specific regex test
\n\n
If none of the prior validation steps halts validation, a field's\n configured regex test will be processed.\n The invalid message for this test is configured with regexText

\n\n

Parameters

value : Object
The value to validate. The processed raw value will be used if nothing is passed.
\n

Returns

String[]
Array of any validation errors
\n

Overrides: Ext.form.field.Field.getErrors

getFieldLabel( ) : Stringtemplate

Returns the label for the field. ...

Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be overridden\nto provide a custom generated label.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Returns

String
The configured field label, or empty string if not defined
\n

getFocusEl( )private

Returns the focus holder element associated with this Component. ...

Returns the focus holder element associated with this Component. At the Component base class level, this function returns undefined.

\n\n\n

Subclasses which use embedded focusable elements (such as Window, Field and Button) should override this for use by the focus method.

\n\n\n

Containers which need to participate in the FocusManager's navigation and Container focusing scheme also\nneed to return a focusEl, although focus is only listened for in this case if the FocusManager is enabled.

\n\n

getFrameInfo( )private

On render, reads an encoded style attribute, \"background-position\" from the style of this Component's element. ...

On render, reads an encoded style attribute, \"background-position\" from the style of this Component's element.\nThis information is memoized based upon the CSS class name of this Component's element.\nBecause child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted\ninto the document to receive the document element's CSS class name, and therefore style attributes.

getFrameTpl( Object table )private

...

Parameters

table : Object
\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

Retrieves the id of this component. ...

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

Returns

String
\n

getInitialConfig( [String name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

getInputId( )

Returns the input id for this field. ...

Returns the input id for this field. If none was specified via the inputId config, then an id will be\nautomatically generated.

Overrides: Ext.form.Labelable.getInputId

getInsertPosition( String/Number/Ext.dom.Element/HTMLElement position ) : HTMLElement

This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insert...

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

Parameters

position : String/Number/Ext.dom.Element/HTMLElement
Index, element id or element you want\nto put this component before.
\n

Returns

HTMLElement
DOM element that you can use in the insertBefore
\n

getItemId( ) : String

Returns the value of itemId assigned to this component, or when that\nis not set, returns the value of id. ...

Returns the value of itemId assigned to this component, or when that\nis not set, returns the value of id.

Returns

String
\n

getLabelStyle( ) : Stringprivate

Gets any label styling for the labelEl ...

Gets any label styling for the labelEl

Returns

String
The label styling
\n

getLabelableRenderData( ) : Objectprotected

Generates the arguments for the field decorations rendering template. ...

Generates the arguments for the field decorations rendering template.

Returns

Object
The template arguments
\n

getLoader( ) : Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component. ...

Gets the Ext.ComponentLoader for this Component.

Returns

Ext.ComponentLoader
The loader instance, null if it doesn't exist.
\n

getModelData( ) : Object

Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRe...

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\nbeing this field's name and the value being its current data value. More advanced field\nimplementations may return more than one name-value pair. The returned values will be saved to the corresponding\nfield names in the Model.

\n\n

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\nstrings if that particular name has multiple values. It can also return null if there are no parameters to be\nsubmitted.
\n

getName( ) : String

Returns the name attribute of the field. ...

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

Returns

String
name The field name
\n

getOverflowStyle( )private

Returns the CSS style object which will set the Component's scroll styles. ...

Returns the CSS style object which will set the Component's scroll styles. This must be applied\nto the target element.

getPlugin( String pluginId ) : Ext.AbstractPlugin

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

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

Parameters

pluginId : String
\n

Returns

Ext.AbstractPlugin
plugin instance.
\n

getPosition( [Boolean local] ) : Number[]

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.
\n
Defaults to: false

Returns

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

getRawValue( ) : String

Returns the raw String value of the field, without performing any normalization, conversion, or validation. ...

Returns the raw String value of the field, without performing any normalization, conversion, or validation. Gets\nthe current value of the input element if the field has been rendered, ignoring the value if it is the\nemptyText. To get a normalized and converted value see getValue.

Returns

String
The raw String value of the field
\n

Overrides: Ext.form.field.Base.getRawValue

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

getSizeModel( Object ownerCtSizeModel ) : Object

Returns an object that describes how this component's width and height are managed. ...

Returns an object that describes how this component's width and height are managed.\nAll of these objects are shared and should not be modified.

Parameters

ownerCtSizeModel : Object
\n

Returns

Object
The size model for this component.
\n
- width : Ext.layout.SizeModel
  The size model\nfor the width.
  \n
- height : Ext.layout.SizeModel
  The size model\nfor the height.
  \n

getState( ) : Object

The supplied default state gathering method for the AbstractComponent class. ...

The supplied default state gathering method for the AbstractComponent class.

\n\n

This method returns dimension settings such as flex, anchor, width and height along with collapsed\nstate.

\n\n

Subclasses which implement more complex state should call the superclass's implementation, and apply their state\nto the result if this basic state is to be saved.

\n\n

Note that Component state will only be saved if the Component has a stateId and there as a StateProvider\nconfigured for the document.

Returns

Object
\n

Overrides: Ext.state.Stateful.getState

getStateId( ) : Stringprivate

Gets the state id for this object. ...

Gets the state id for this object.

Returns

String
The 'stateId' or the implicit 'id' specified by component configuration.
\n

getStyleProxy( Object cls )private

Returns an offscreen div with the same class name as the element this is being rendered. ...

Returns an offscreen div with the same class name as the element this is being rendered.\nThis is because child item rendering takes place in a detached div which, being not part of the document, has no styling.

Parameters

cls : Object
\n

getSubTplData( ) : Objecttemplate

Creates and returns the data object to be used when rendering the fieldSubTpl. ...

Creates and returns the data object to be used when rendering the fieldSubTpl.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Returns

Object
The template data
\n

getSubTplMarkup( )

Gets the markup to be inserted into the outer template's bodyEl. ...

Gets the markup to be inserted into the outer template's bodyEl. For fields this is the actual input element.

Overrides: Ext.form.Labelable.getSubTplMarkup

getSubmitData( ) : Object

Returns the parameter(s) that would be included in a standard form submit for this field. ...

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

\n\n

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\nstrings if that particular name has multiple values. It can also return null if there are no parameters to be\nsubmitted.
\n

getSubmitValue( ) : String

Returns the value that would be included in a standard form submit for this field. ...

Returns the value that would be included in a standard form submit for this field. This will be combined with the\nfield's name to form a name=value pair in the submitted parameters. If an empty string is\nreturned then just the name= will be submitted; if null is returned then nothing will be submitted.

\n\n

Note that the value returned will have been processed but may or may not have been\nsuccessfully validated.

Returns

String
The value to be submitted, or null.
\n

getTargetEl( )private

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. ...

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

getTpl( Object name )private

...

Parameters

name : Object
\n

Ext.form.field.Trigger
view source

getTriggerStateFlags( )private

Returns a set of flags that describe the trigger state. ...

Returns a set of flags that describe the trigger state. These are just used to easily\ndetermine if the DOM is out-of-sync with the component's properties.

Ext.form.field.Trigger
view source

getTriggerWidth( ) : Number

Get the total width of the trigger button area. ...

Get the total width of the trigger button area.

Returns

Number
The total trigger width
\n

getValue( ) : Object

Returns the current data value of the field. ...

Returns the current data value of the field. The type of value returned is particular to the type of the\nparticular field (e.g. a Date object for Ext.form.field.Date), as the result of calling rawToValue on\nthe field's processed String value. To return the raw String value, see getRawValue.

Returns

Object
value The field value
\n

Overrides: Ext.form.field.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.ComponentManager. ...

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

\n\n

var t = new Ext.form.field.Text();\nalert(t.getXType());  // alerts 'textfield'\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 available xtypes, see the\nExt.Component header.

\n\n

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

\n\n

Example usage:

\n\n

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

Returns

String
The xtype hierarchy string
\n

hasActiveError( ) : Boolean

Tells whether the field currently has an active error message. ...

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

Returns

Boolean
\n

hasActiveFx( ) : Ext.fx.Anim/Booleandeprecated

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

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

This method has been deprecated since 4.0

Replaced by getActiveAnimation

\n\n

Returns

Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n

hasCls( String className ) : Boolean

Checks if the specified CSS class exists on this element's DOM node. ...

Checks if the specified CSS class exists on this element's DOM node.

Parameters

className : String
The CSS class to check for
\n

Returns

Boolean
True if the class exists, else false
\n

hasConfig( Object config )private

...

Parameters

config : Object
\n

hasListener( String eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

Parameters

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

Returns

Boolean
true if the event is being listened for or bubbles, else false
\n

hasUICls( String cls )

Checks if there is currently a specified uiCls ...

Checks if there is currently a specified uiCls

Parameters

cls : String
The cls to check
\n

hasVisibleLabel( ) : Boolean

Checks if the field has a visible label ...

Checks if the field has a visible label

Returns

Boolean
True if the field has a visible label
\n

hide( [String/Ext.Element/Ext.Component animateTarget], [Function callback], [Object scope] ) : Ext.Component

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

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

Parameters

animateTarget : String/Ext.Element/Ext.Component (optional)
only valid for floating Components\nsuch as Windows or ToolTips, or regular Components which have\nbeen configured with floating: true.. The target to which the Component should animate while hiding.
\n
Defaults to: null
callback : Function (optional)
A callback function to call after the Component is hidden.
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n

Returns

Ext.Component
this
\n

initComponent( )protectedtemplate

The initComponent template method is an important initialization step for a Component. ...

The initComponent template method is an important initialization step for a Component. It is intended to be\nimplemented by each subclass of Ext.Component to provide any needed constructor logic. The\ninitComponent method of the class being created is called first, with each initComponent method\nup the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and,\nif needed, override the constructor logic of the Component at any step in the hierarchy.

\n\n

The initComponent method must contain a call to callParent in order\nto ensure that the parent class' initComponent method is also called.

\n\n

All config options passed to the constructor are applied to this before initComponent is called,\nso you can simply access them with this.someOption.

\n\n

The following example demonstrates using a dynamic string for the text of a button at the time of\ninstantiation of the class.

\n\n

Ext.define('DynamicButtonText', {\n    extend: 'Ext.button.Button',\n\n    initComponent: function() {\n        this.text = new Date();\n        this.renderTo = Ext.getBody();\n        this.callParent();\n    }\n});\n\nExt.onReady(function() {\n    Ext.create('DynamicButtonText');\n});\n

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

initConfig( Object config ) : Ext.Baseprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initField( )

Initializes this Field mixin on the current instance. ...

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

initFrame( )private

...

initLabelable( )

Performs initialization of this mixin. ...

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

initRenderData( ) : Objectprivate

Initialized the renderData to be used when rendering the renderTpl. ...

Initialized the renderData to be used when rendering the renderTpl.

Returns

Object
Object with keys and values that are going to be applied to the renderTpl
\n

initRenderTpl( ) : Ext.XTemplateprivate

Initializes the renderTpl. ...

Initializes the renderTpl.

Returns

Ext.XTemplate
The renderTpl XTemplate instance.
\n

initState( )private

Initializes the state of the object upon construction. ...

Initializes the state of the object upon construction.

initStyles( Object targetEl ) : Stringprivate

Converts style definitions to String. ...

Converts style definitions to String.

Parameters

targetEl : Object
\n

Returns

String
A CSS style string with style, padding, margin and border.
\n

initValue( )

Initializes the field's value based on the initial config. ...

Initializes the field's value based on the initial config.

is( String selector ) : Boolean

Tests whether this Component matches the selector string. ...

Tests whether this Component matches the selector string.

Parameters

selector : String
The selector string to test against.
\n

Returns

Boolean
True if this Component matches the selector.
\n

isDescendantOf( Ext.Container container ) : Boolean

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

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

Parameters

container : Ext.Container
\n

Returns

Boolean
True if it is.
\n

isDirty( ) : Boolean

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

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

\n\n

Note that if the owning form was configured with\ntrackResetOnLoad then the originalValue is updated when\nthe 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),\nfalse otherwise.
\n

isDisabled( ) : Boolean

Method to determine whether this Component is currently disabled. ...

Method to determine whether this Component is currently disabled.

Returns

Boolean
the disabled state of this Component.
\n

isDraggable( ) : Boolean

Method to determine whether this Component is draggable. ...

Method to determine whether this Component is draggable.

Returns

Boolean
the draggable state of this component.
\n

isDroppable( ) : Boolean

Method to determine whether this Component is droppable. ...

Method to determine whether this Component is droppable.

Returns

Boolean
the droppable state of this component.
\n

isEqual( Object value1, Object value2 )private

Override. ...

Override. Treat undefined and null values as equal to an empty string value.

Parameters

value1 : Object
\n
value2 : Object
\n

Overrides: Ext.form.field.Field.isEqual

isEqualAsString( Object value1, Object value2 ) : Booleanprivate

Returns whether two values are logically equal. ...

Returns whether two values are logically equal.\nSimilar to isEqual, however null or undefined values will be treated as empty strings.

Parameters

value1 : Object
The first value to compare
\n
value2 : Object
The second value to compare
\n

Returns

Boolean
True if the values are equal, false if inequal.
\n

isFileUpload( ) : Boolean

Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for\nsubmitti...

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

Returns

Boolean
\n

isFloating( ) : Boolean

Method to determine whether this Component is floating. ...

Method to determine whether this Component is floating.

Returns

Boolean
the floating state of this component.
\n

isHidden( ) : Boolean

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

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

Returns

Boolean
the hidden state of this Component.
\n

isLayoutRoot( )protected

Determines whether this Component is the root of a layout. ...

Determines whether this Component is the root of a layout. This returns true if\nthis component can run its layout without assistance from or impact on its owner.\nIf this component cannot run its layout given these restrictions, false is returned\nand its owner will be considered as the next candidate for the layout root.

\n\n

Setting the _isLayoutRoot property to true causes this method to always\nreturn true. This may be useful when updating a layout of a Container which shrink\nwraps content, and you know that it will not change size, and so can safely be the\ntopmost participant in the layout run.

isLayoutSuspended( ) : Boolean

Returns true if layout is suspended for this component. ...

Returns true if layout is suspended for this component. This can come from direct\nsuspension of this component's layout activity (Ext.Container.suspendLayout) or if one\nof this component's containers is suspended.

Returns

Boolean
True layout of this component is suspended.
\n

isValid( ) : Boolean

Returns whether or not the field value is currently valid by validating the\nprocessed raw value of the field. ...

Returns whether or not the field value is currently valid by validating the\nprocessed raw value of the field. Note: disabled fields are\nalways treated as valid.

Returns

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

Overrides: Ext.form.field.Field.isValid

isVisible( [Boolean deep] ) : Boolean

Returns true if this component is visible. ...

Returns true if this component is visible.

Parameters

deep : Boolean (optional)
Pass true to interrogate the visibility status of all parent Containers to\ndetermine whether this Component is truly visible to the user.
\n\n
Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating\ndynamically laid out UIs in a hidden Container before showing them.
\n
Defaults to: false

Returns

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

isXType( String xtype, [Boolean 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

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

\n\n

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

\n\n

Example usage:

\n\n

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

Parameters

xtype : String
The xtype to check for this Component
\n
shallow : Boolean (optional)
True to check whether this Component is directly of the specified xtype, false to\ncheck whether this Component is descended from the xtype.
\n
Defaults to: false

Returns

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

markInvalid( String/String[] errors )

Display one or more error messages associated with this field, using msgTarget to determine how to\ndisplay the messag...

Display one or more error messages associated with this field, using msgTarget to determine how to\ndisplay the messages and applying invalidCls to the field's UI element.

\n\n

Note: this method does not cause the Field's validate or isValid methods to return false\nif the value does pass validation. So simply marking a Field as invalid will not prevent submission of forms\nsubmitted with the Ext.form.action.Submit.clientValidation option set.

Parameters

errors : String/String[]
The validation message(s) to display.
\n

Overrides: Ext.form.field.Field.markInvalid

mon( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

Parameters

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

mun( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

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

nextNode( [String selector] ) : Ext.Component

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

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

\n\n

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

Parameters

selector : String (optional)
A ComponentQuery selector to filter the following nodes.
\n

Returns

Ext.Component
The next node (or the next node which matches the selector).\nReturns null if there is no matching node.
\n

nextSibling( [String selector] ) : Ext.Component

Returns the next sibling of this Component. ...

Returns the next sibling of this Component.

\n\n

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

\n\n

May also be refered to as next()

\n\n

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

Parameters

selector : String (optional)
A ComponentQuery selector to filter the following items.
\n

Returns

Ext.Component
The next sibling (or the next sibling which matches the selector).\nReturns null if there is no matching sibling.
\n

on( String/Object eventName, [Function fn], [Object scope], [Object options] )

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

onAdded( Ext.container.Container container, Number pos )protectedtemplate

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. References are\nestablished at add time rather than at render time.

\n\n

Allows addition of behavior when a Component is added to a\nContainer. At this stage, the Component is in the parent\nContainer's collection of child items. After calling the\nsuperclass's onAdded, the ownerCt reference will be present,\nand if configured with a ref, the refOwner will be set.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

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

Ext.form.field.Trigger
view source

onBlur( )private

The default blur handling must not occur for a TriggerField, implementing this template method as emptyFn disables that. ...

The default blur handling must not occur for a TriggerField, implementing this template method as emptyFn disables that.\nInstead the tab key is monitored, and the superclass's onBlur is called when tab is detected

onChange( )private

If grow=true, invoke the autoSize method when the field's value is changed. ...

If grow=true, invoke the autoSize method when the field's value is changed.

Overrides: Ext.form.field.Field.onChange

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

onDestroy( )protectedtemplate

Allows addition of behavior to the destroy operation. ...

Allows addition of behavior to the destroy operation.\nAfter calling the superclass’s onDestroy, the Component will be destroyed.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onDirtyChange( Boolean isDirty )private

Called when the field's dirty state changes. ...

Called when the field's dirty state changes. Adds/removes the dirtyCls on the main element.

Parameters

isDirty : Boolean
\n

Overrides: Ext.form.field.Field.onDirtyChange

onDisable( )protectedtemplate

Allows addition of behavior to the disable operation. ...

Allows addition of behavior to the disable operation.\nAfter calling the superclass’s onDisable, the Component will be disabled.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onEnable( )protectedtemplate

Allows addition of behavior to the enable operation. ...

Allows addition of behavior to the enable operation.\nAfter calling the superclass’s onEnable, the Component will be enabled.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onHide( [String/Ext.Element/Ext.Component animateTarget], [Function callback], [Object scope] )protectedtemplate

Possibly animates down to a target element. ...

Possibly animates down to a target element.

\n\n

Allows addition of behavior to the hide operation. After\ncalling the superclass’s onHide, the Component will be hidden.

\n\n

Gets passed the same parameters as hide.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element/Ext.Component (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

onPosition( Number x, Number y )protectedtemplate

Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that need...

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

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

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

onRemoved( Boolean destroying )protectedtemplate

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

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

\n\n

Allows addition of behavior when a Component is removed from\nits parent Container. At this stage, the Component has been\nremoved from its parent Container's collection of child items,\nbut has not been destroyed (It will be destroyed if the parent\nContainer's autoDestroy is true, or if the remove call was\npassed a truthy second parameter). After calling the\nsuperclass's onRemoved, the ownerCt and the refOwner will not\nbe present.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

destroying : Boolean
Will be passed as true if the Container performing the remove operation will delete this\nComponent upon remove.
\n

onRender( Ext.core.Element parentNode, Number containerIdx )protectedtemplate

Template method called when this Component's DOM structure is created. ...

Template method called when this Component's DOM structure is created.

\n\n

At this point, this Component's (and all descendants') DOM structure exists but it has not\nbeen layed out (positioned and sized).

\n\n

Subclasses which override this to gain access to the structure at render time should\ncall the parent class's method before attempting to access any child elements of the Component.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

parentNode : Ext.core.Element
The parent Element in which this Component's encapsulating element is contained.
\n
containerIdx : Number
The index within the parent Container's child collection of this Component.
\n

onResize( )protectedtemplate

Allows addition of behavior to the resize operation. ...

Allows addition of behavior to the resize operation.

\n\n

Called when Ext.resizer.Resizer#drag event is fired.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

onShow( [String/Ext.Element animateTarget], [Function callback], [Object scope] )protectedtemplate

Allows addition of behavior to the show operation. ...

Allows addition of behavior to the show operation. After\ncalling the superclass's onShow, the Component will be visible.

\n\n

Override in subclasses where more complex behaviour is needed.

\n\n

Gets passed the same parameters as show.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

animateTarget : String/Ext.Element (optional)
\n
callback : Function (optional)
\n
scope : Object (optional)
\n

onShowComplete( [Function callback], [Object scope] )protectedtemplate

Invoked after the afterShow method is complete. ...

Invoked after the afterShow method is complete.

\n\n

Gets passed the same callback and scope parameters that afterShow received.

This is a template method.\n a hook into the functionality of this class.\n Feel free to override it in child classes.

Parameters

callback : Function (optional)
\n
scope : Object (optional)
\n

onStateChange( )private

This method is called when any of the stateEvents are fired. ...

This method is called when any of the stateEvents are fired.

Ext.form.field.Trigger
view source

onTriggerClick( Ext.EventObject e )protected

The function that should handle the trigger's click event. ...

The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function. See Ext.form.field.ComboBox and Ext.form.field.Date for sample implementations.

Parameters

e : Ext.EventObject
\n

prepareClass( Function T )private

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a\nclass derives from this class or uses this class as a mixin.

Parameters

T : Function
The class constructor to prepare.
\n

previousNode( [String selector] ) : Ext.Component

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

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

\n\n

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

Parameters

selector : String (optional)
A ComponentQuery selector to filter the preceding nodes.
\n

Returns

Ext.Component
The previous node (or the previous node which matches the selector).\nReturns null if there is no matching node.
\n

previousSibling( [String selector] ) : Ext.Component

Returns the previous sibling of this Component. ...

Returns the previous sibling of this Component.

\n\n

Optionally selects the previous sibling which matches the passed ComponentQuery\nselector.

\n\n

May also be refered to as prev()

\n\n

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

Parameters

selector : String (optional)
A ComponentQuery selector to filter the preceding items.
\n

Returns

Ext.Component
The previous sibling (or the previous sibling which matches the selector).\nReturns null if there is no matching sibling.
\n

processRawValue( String value ) : String

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or\nvalidation. ...

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or\nvalidation. For text fields this applies the configured stripCharsRe\nto the raw value.

Parameters

value : String
The unprocessed string value
\n

Returns

String
The processed string value
\n

Overrides: Ext.form.field.Base.processRawValue

rawToValue( Object rawValue ) : Object

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. ...

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This\nallows controlling the normalization and conversion of user-entered values into field-type-appropriate values,\ne.g. a Date object for Ext.form.field.Date, and is invoked by getValue.

\n\n

It is up to individual implementations to decide how to handle raw values that cannot be successfully converted\nto the desired object type.

\n\n

See valueToRaw for the opposite conversion.

\n\n

The base implementation does no conversion, returning the raw value untouched.

Parameters

rawValue : Object
\n

Returns

Object
The converted value.
\n

registerFloatingItem( Object cmp )

Called by Component#doAutoRender\n\nRegister a Container configured floating: true with this Component's ZIndexManager. ...

Called by Component#doAutoRender

\n\n

Components added in ths way will not participate in any layout, but will be rendered\nupon first show in the way that Windows are.

Parameters

cmp : Object
\n

Ext.util.ElementContainer
view source

relayEvents( Object origin, String[] events, [String prefix] )

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.

\n\n

For example if you are extending Grid, you might decide to forward some events from store.\nSo you can do this inside your initComponent:

\n\n

this.relayEvents(this.getStore(), ['load']);\n

\n\n

The grid instance will then have an observable 'load' event which will be passed the\nparameters of the store's load event and any function fired with the grid's load event\nwould have access to the grid using the this keyword.

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

removeChildEls( Function testFn )

Removes items in the childEls array based on the return value of a supplied test\nfunction. ...

Removes items in the childEls array based on the return value of a supplied test\nfunction. The function is called with a entry in childEls and if the test function\nreturn true, that entry is removed. If false, that entry is kept.

Parameters

testFn : Function
The test function.
\n

removeCls( String/String[] cls ) : Ext.Component

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

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

Parameters

cls : String/String[]
The CSS class name to remove
\n

Returns

Ext.Component
Returns the Component to allow method chaining.
\n

removeClsWithUI( String/String[] cls )

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of thi...

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

Parameters

cls : String/String[]
A string or an array of strings to remove to the uiCls
\n

removeListener( String eventName, Function fn, [Object scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

removeManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

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

Removes listeners that were added by the mon method.

Parameters

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

removeManagedListenerItem( Boolean isClear, Object managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

removeUIClsFromElement( String ui )

Method which removes a specified UI + uiCls from the components element. ...

Method which removes a specified UI + uiCls from the components element. The cls which is added to the element\nwill be: this.baseCls + '-' + ui

Parameters

ui : String
The UI to add to the element
\n

removeUIFromElement( )private

Method which removes a specified UI from the components element. ...

Method which removes a specified UI from the components element.

render( [Ext.Element/HTMLElement/String container], [String/Number position] )

Renders the Component into the passed HTML element. ...

Renders the Component into the passed HTML element.

\n\n

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

\n\n

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

\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\ncauses any unrendered child Components to be rendered. This is required so that you can add\nmultiple child components if needed while only refreshing the layout once.

\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\nmanager. If 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

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.

Parameters

container : Ext.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

renderActiveError( )private

Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl,\nas that is required...

Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl,\nas that is required for proper styling in IE with nested fields (due to lack of child selector)

Overrides: Ext.form.Labelable.renderActiveError

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.\nAlso adds emptyText and emptyCls if the original value was blank.

Overrides: Ext.form.field.Field.reset

resetOriginalValue( )

Resets the field's originalValue property so it matches the current value. ...

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

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

savePropToState( String propName, Object state, [String stateName] ) : Boolean

Conditionally saves a single property from this object to the given state object. ...

Conditionally saves a single property from this object to the given state object.\nThe idea is to only save state which has changed from the initial state so that\ncurrent software settings do not override future software settings. Only those\nvalues that are user-changed state should be saved.

Parameters

propName : String
The name of the property to save.
\n
state : Object
The state object in to which to save the property.
\n
stateName : String (optional)
The name to use for the property in state.
\n

Returns

Boolean
True if the property was saved, false if not.
\n

savePropsToState( String/String[] propNames, Object state ) : Object

Gathers additional named properties of the instance and adds their current values\nto the passed state object. ...

Gathers additional named properties of the instance and adds their current values\nto the passed state object.

Parameters

propNames : String/String[]
The name (or array of names) of the property to save.
\n
state : Object
The state object in to which to save the property values.
\n

Returns

Object
state
\n

saveState( )

Saves the state of the object to the persistence store. ...

Saves the state of the object to the persistence store.

scrollBy( Number/Number[]/Object deltaX, Number/Boolean/Object deltaY, Boolean/Object animate )

Scrolls this Component's target element by the passed delta values, optionally animating. ...

Scrolls this Component's target element by the passed delta values, optionally animating.

\n\n

All of the following are equivalent:

\n\n

 comp.scrollBy(10, 10, true);\n comp.scrollBy([10, 10], true);\n comp.scrollBy({ x: 10, y: 10 }, true);\n

Parameters

deltaX : Number/Number[]/Object
Either the x delta, an Array specifying x and y deltas or\nan object with \"x\" and \"y\" properties.
\n
deltaY : Number/Boolean/Object
Either the y delta, or an animate flag or config object.
\n
animate : Boolean/Object
Animate flag/config object if the delta values were passed separately.
\n

selectText( [Number start], [Number end] )

Selects text in this field ...

Selects text in this field

Parameters

start : Number (optional)
The index where the selection should start
\n
Defaults to: 0
end : Number (optional)
The index where the selection should end (defaults to the text length)
\n

sequenceFx( ) : Object

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. ...

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

Returns

Object
this
\n

setActive( [Boolean active], [Ext.Component newActive] )

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been\nmoved to th...

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

\n\n

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

\n\n

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

Parameters

active : Boolean (optional)
True to activate the Component, false to deactivate it.
\n
Defaults to: false
newActive : Ext.Component (optional)
The newly active Component which is taking over topmost zIndex position.
\n

setActiveError( String msg )

Sets the active error message to the given string. ...

Sets the active error message to the given string. This replaces the entire error message contents with the given\nstring. Also see setActiveErrors which accepts an Array of messages and formats them according to the\nactiveErrorsTpl. Note that this only updates the error message element's text and attributes, you'll\nhave to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters

msg : String
The error message
\n

setActiveErrors( String[] errors )

Set the active error message to an Array of error messages. ...

Set the active error message to an Array of error messages. The messages are formatted into a single message\nstring using the activeErrorsTpl. Also see setActiveError which allows setting the entire error\ncontents with a single string. Note that this only updates the error message element's text and attributes,\nyou'll have to call doComponentLayout to actually update the field's layout to match. If the field extends\nExt.form.field.Base you should call markInvalid instead.

Parameters

errors : String[]
The error messages
\n

setAutoScroll( Boolean scroll ) : Ext.Component

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.Component
this
\n

setBorder( String/Number border )

...

Parameters

border : String/Number
The border, see border. If a falsey value is passed\nthe border will be removed.
\n

setConfig( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

setDisabled( Boolean disabled )

Enable or disable the component. ...

Enable or disable the component.

Parameters

disabled : Boolean
True to disable.
\n

setDocked( Object dock, [Boolean layoutParent] ) : Ext.Component

Sets the dock position of this component in its parent panel. ...

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part\nof the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

dock : Object
The dock position.
\n
layoutParent : Boolean (optional)
True to re-layout parent.
\n
Defaults to: false

Returns

Ext.Component
this
\n

Ext.form.field.Trigger
view source

setEditable( Boolean editable )

Sets the editable state of this field. ...

Sets the editable state of this field. This method is the runtime equivalent of setting the 'editable' config\noption at config time.

Parameters

editable : Boolean
True to allow the user to directly edit the field text. If false is passed, the user\nwill only be able to modify the field using the trigger. Will also add a click event to the text field which\nwill call the trigger.
\n

setFieldDefaults( Object defaults )

Applies a set of default configuration values to this Labelable instance. ...

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

Parameters

defaults : Object
The defaults to apply to the object.
\n

setFieldLabel( String label )

Set the label of this field. ...

Set the label of this field.

Parameters

label : String
The new label. The labelSeparator will be automatically appended to the label\nstring.
\n

setFieldStyle( String/Object/Function style )

Set the CSS style of the field input element. ...

Set the CSS style of the field input element.

Parameters

style : String/Object/Function
The style(s) to apply. Should be a valid argument to Ext.Element.applyStyles.
\n

setHeight( Number height ) : Ext.Component

Sets the height of the component. ...

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:
\n\n
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.
\n\n

Returns

Ext.Component
this
\n

setLoading( Boolean/Object/String load, [Boolean targetEl] ) : Ext.LoadMask

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

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

Parameters

load : Boolean/Object/String
True to show the default LoadMask, a config object that will be passed to the\nLoadMask constructor, or a message String to show. False to hide the current LoadMask.
\n
targetEl : Boolean (optional)
True to mask the targetEl of this Component instead of the this.el. For example,\nsetting this to true on a Panel will cause only the body to be masked.
\n
Defaults to: false

Returns

Ext.LoadMask
The LoadMask instance that has just been shown.
\n

setOverflowXY( String overflowX, String overflowY ) : Ext.Component

Sets the overflow x/y on the content element of the component. ...

Sets the overflow x/y on the content element of the component. The x/y overflow\nvalues can be any valid CSS overflow (e.g., 'auto' or 'scroll'). By default, the\nvalue is 'hidden'. Passing null for one of the values will erase the inline style.\nPassing undefined will preserve the current value.

Parameters

overflowX : String
The overflow-x value.
\n
overflowY : String
The overflow-y value.
\n

Returns

Ext.Component
this
\n

setPagePosition( Number x, Number y, [Boolean/Object animate] ) : Ext.Component

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
animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n

Returns

Ext.Component
this
\n

setPosition( Number left, Number top, [Boolean/Object animate] ) : Ext.Component

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. This\nmethod fires the move event.

Parameters

left : Number
The new left
\n
top : Number
The new top
\n
animate : Boolean/Object (optional)
If true, the Component is animated into its new position. You may also pass an\nanimation configuration.
\n

Returns

Ext.Component
this
\n

setRawValue( Object value ) : Object

Sets the field's raw value directly, bypassing value conversion, change detection, and\nvalidation. ...

Sets the field's raw value directly, bypassing value conversion, change detection, and\nvalidation. To set the value with these additional inspections see setValue.

Parameters

value : Object
The value to set
\n

Returns

Object
value The field value that is set
\n

Ext.form.field.Trigger
view source

setReadOnly( Boolean readOnly )

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

Sets the read-only state of this field. This method is the runtime equivalent of setting the 'readOnly' config\noption at config time.

Parameters

readOnly : Boolean
True to prevent the user changing the field and explicitly hide the trigger. Setting\nthis to true will supercede settings editable and hideTrigger. Setting this to false will defer back to editable\nand hideTrigger.
\n

Overrides: Ext.form.field.Base.setReadOnly

setSize( Number/String/Object width, Number/String height ) : Ext.Component

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

Sets the width and height of this Component. 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 : Number/String/Object
The new width to set. This may be one of:
\n\n
- 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\n
height : Number/String
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
\n\n
- 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\n

Returns

Ext.Component
this
\n

setUI( String ui )

Sets the UI for the component. ...

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

Parameters

ui : String
The new UI for the component
\n

setValue( Object value ) : Ext.form.field.Text

Sets a data value into the field and runs the change detection and validation. ...

Sets a data value into the field and runs the change detection and validation. Also applies any configured\nemptyText for text fields. To set the value directly without these inspections see setRawValue.

Parameters

value : Object
The value to set
\n

Returns

Ext.form.field.Text
this
\n

Overrides: Ext.form.field.Base.setValue

setVisible( Boolean visible ) : Ext.Component

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( Number width ) : Ext.Component

Sets the width of the component. ...

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

Parameters

width : Number
The new width to setThis may be one of:
\n\n
- 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.
\n\n

Returns

Ext.Component
this
\n

setupFramingTpl( Object frameTpl )private

Inject a reference to the function which applies the render template into the framing template. ...

Inject a reference to the function which applies the render template into the framing template. The framing template\nwraps the content.

Parameters

frameTpl : Object
\n

show( [String/Ext.Element animateTarget], [Function callback], [Object scope] ) : Ext.Component

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

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

\n\n

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

Parameters

animateTarget : String/Ext.Element (optional)
only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should animate from while opening.
\n
Defaults to: null
callback : Function (optional)
A callback function to call after the Component is displayed.\nOnly necessary if animation was specified.
\n
scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n

Returns

Ext.Component
this
\n

showAt( Number x, Number y, [Boolean/Object animate] )

Displays component at specific xy position. ...

Displays component at specific xy position.\nA floating component (like a menu) is positioned relative to its ownerCt if any.\nUseful for popping up a context menu:

\n\n

listeners: {\n    itemcontextmenu: function(view, record, item, index, event, options) {\n        Ext.create('Ext.menu.Menu', {\n            width: 100,\n            height: 100,\n            margin: '0 0 10 0',\n            items: [{\n                text: 'regular item 1'\n            },{\n                text: 'regular item 2'\n            },{\n                text: 'regular item 3'\n            }]\n        }).showAt(event.getXY());\n    }\n}\n

Parameters

x : Number
The new x position
\n
y : Number
The new y position
\n
animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

stopAnimation( ) : Ext.Element

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat haven't started yet.

Returns

Ext.Element
The Element
\n

stopFx( ) : Ext.Elementdeprecated

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat ...

Stops any running effects and clears this object's internal effects queue if it contains any additional effects\nthat haven't started yet.

This method has been deprecated since 4.0

Replaced by stopAnimation

\n\n

Returns

Ext.Element
The Element
\n

suspendEvents( Boolean queueSuspended )

Suspends the firing of all events. ...

Suspends 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

syncFx( ) : Object

Ensures that all effects queued after syncFx is called on this object are run concurrently. ...

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

Returns

Object
this
\n

toBack( ) : Ext.Component

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

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

Returns

Ext.Component
this
\n

toFront( [Boolean preventFocus] ) : Ext.Component

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

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

\n\n

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.
\n
Defaults to: false

Returns

Ext.Component
this
\n

transformOriginalValue( Object value ) : Objectprotected

Allows for any necessary modifications before the original\nvalue is set ...

Allows for any necessary modifications before the original\nvalue is set

Parameters

value : Object
The initial value
\n

Returns

Object
The modified initial value
\n

transformRawValue( Object value ) : Objectprotected

Transform the raw value before it is set ...

Transform the raw value before it is set

Parameters

value : Object
The value
\n

Returns

Object
The value to set
\n

trimLabelSeparator( ) : String

Returns the trimmed label by slicing off the label separator character. ...

Returns the trimmed label by slicing off the label separator character. Can be overridden.

Returns

String
The trimmed field label, or empty string if not defined
\n

un( String eventName, Function fn, [Object scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

unsetActiveError( )

Clears the active error message(s). ...

Clears the active error message(s). Note that this only clears the error message element's text and attributes,\nyou'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call clearInvalid instead.

up( [String selector] ) : Ext.container.Container

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

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

\n\n

Example:

\n\n

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

Parameters

selector : String (optional)
The simple selector to test.
\n

Returns

Ext.container.Container
The matching ancestor Container (or undefined if no match was found).
\n

update( String/Object htmlOrData, [Boolean loadScripts], [Function callback] )

Update the content area of a component. ...

Update the content area of a component.

Parameters

htmlOrData : String/Object
If this component has been configured with a template via the tpl config then\nit will use this argument as data to populate the template. If this component was not configured with a template,\nthe components content area will be updated via Ext.Element update
\n
loadScripts : Boolean (optional)
Only legitimate when using the html configuration.
\n
Defaults to: false
callback : Function (optional)
Only legitimate when using the html configuration. Callback to execute when\nscripts have finished loading
\n

updateAria( )private

Injected as an override by Ext.Aria.initialize ...

Injected as an override by Ext.Aria.initialize

updateBox( Object box ) : Ext.Component

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.Component
this
\n

updateLayout( Object options )

Updates this component's layout. ...

Updates this component's layout. If this update effects this components ownerCt,\nthat component's updateLayout method will be called to perform the layout instead.\nOtherwise, just this component (and its child items) will layout.

Parameters

options : Object
An object with layout options.
\n
- defer : Boolean
  True if this layout should be deferred.
  \n
- isRoot : Boolean
  True if this layout should be the root of the layout.
  \n

validate( ) : Boolean

Returns whether or not the field value is currently valid by validating the field's current\nvalue, and fires the vali...

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

\n\n

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

Returns

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

validateValue( Object value ) : Boolean

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

Uses getErrors to build an array of validation errors. If any errors are found, they are passed to\nmarkInvalid and false is returned, otherwise true is returned.

\n\n

Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2\nonwards getErrors should be overridden instead.

Parameters

value : Object
The value to validate
\n

Returns

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

valueToRaw( Object value ) : Object

Converts a mixed-type value to a raw representation suitable for displaying in the field. ...

Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows controlling\nhow value objects passed to setValue are shown to the user, including localization. For instance, for a\nExt.form.field.Date, this would control how a Date object passed to setValue would be converted\nto a String for display in the field.

\n\n

See rawToValue for the opposite conversion.

\n\n

The base implementation simply does a standard toString conversion, and converts empty values\nto an empty string.

Parameters

value : Object
The mixed-type value to convert to the raw representation.
\n

Returns

Object
The converted raw value.
\n

Defined By

Static Methods

addConfig( Object config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( Object members )privatestatic

...

Parameters

members : Object
\n

addMember( Object name, Object member )privatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( Object members )static

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( Object members ) : Ext.Basestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

createAlias( String/Object alias, String/Object origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( Object config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( Object members ) : Ext.Basedeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

triggerExtended( )privatestatic

...

Defined By

Events

activate( Ext.Component this, Object eOpts )

Fires after a Component has been visually activated. ...

Fires after a Component has been visually activated.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

added( Ext.Component this, Ext.container.Container container, Number pos, Object eOpts )

Fires after a Component had been added to a Container. ...

Fires after a Component had been added to a Container.

Parameters

this : Ext.Component
\n
container : Ext.container.Container
Parent Container
\n
pos : Number
position of Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

afterrender( Ext.Component this, Object eOpts )

Fires after the component rendering is finished. ...

Fires after the component rendering is finished.

\n\n

The afterrender event is fired after this Component has been rendered, been postprocesed by any\nafterRender method defined for the Component.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

autosize( Ext.form.field.Text this, Number width, Object eOpts )

Fires when the autoSize function is triggered and the field is resized according to the\ngrow/growMin/growMax configs ...

Fires when the autoSize function is triggered and the field is resized according to the\ngrow/growMin/growMax configs as a result. This event provides a hook for the\ndeveloper to apply additional logic at runtime to resize the field if needed.

Parameters

this : Ext.form.field.Text
This text field
\n
width : Number
The new field width
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeactivate( Ext.Component this, Object eOpts )

Fires before a Component has been visually activated. ...

Fires before a Component has been visually activated. Returning false from an event listener can prevent\nthe activate from occurring.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforedeactivate( Ext.Component this, Object eOpts )

Fires before a Component has been visually deactivated. ...

Fires before a Component has been visually deactivated. Returning false from an event listener can\nprevent the deactivate from occurring.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforedestroy( Ext.Component this, Object eOpts )

Fires before the component is destroyed. ...

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

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforehide( Ext.Component this, Object eOpts )

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

Fires before the component is hidden when calling the hide method. Return false from an event\nhandler to stop the hide.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforerender( Ext.Component this, Object eOpts )

Fires before the component is rendered. ...

Fires before the component is rendered. Return false from an event handler to stop the\nrender.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeshow( Ext.Component this, Object eOpts )

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

Fires before the component is shown when calling the show method. Return false from an event\nhandler to stop the show.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforestaterestore( Ext.state.Stateful this, Object state, Object eOpts )

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

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

Parameters

this : Ext.state.Stateful
\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 object. The method maybe overriden to\nprovide custom state restoration.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforestatesave( Ext.state.Stateful this, Object state, Object eOpts )

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

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

Parameters

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

blur( Ext.Component this, Ext.EventObject The, Object eOpts )

Fires when this Component loses focus. ...

Fires when this Component loses focus.

Parameters

this : Ext.Component
\n
The : Ext.EventObject
blur event.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

boxready( Ext.Component this, Number width, Number height, Object eOpts )

Fires one time - after the component has been layed out for the first time at its initial size. ...

Fires one time - after the component has been layed out for the first time at its initial size.

Parameters

this : Ext.Component
\n
width : Number
The initial width
\n
height : Number
The initial height
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

change( Ext.form.field.Field this, Object newValue, Object oldValue, Object eOpts )

Fires when the value of a field is changed via the setValue method. ...

Fires when the value of a field is changed via the setValue method.

Parameters

this : Ext.form.field.Field
\n
newValue : Object
The new value
\n
oldValue : Object
The original value
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

deactivate( Ext.Component this, Object eOpts )

Fires after a Component has been visually deactivated. ...

Fires after a Component has been visually deactivated.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

destroy( Ext.Component this, Object eOpts )

Fires after the component is destroyed. ...

Fires after the component is destroyed.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

dirtychange( Ext.form.field.Field this, Boolean isDirty, Object eOpts )

Fires when a change in the field's isDirty state is detected. ...

Fires when a change in the field's isDirty state is detected.

Parameters

this : Ext.form.field.Field
\n
isDirty : Boolean
Whether or not the field is now dirty
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

disable( Ext.Component this, Object eOpts )

Fires after the component is disabled. ...

Fires after the component is disabled.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

enable( Ext.Component this, Object eOpts )

Fires after the component is enabled. ...

Fires after the component is enabled.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

errorchange( Ext.form.Labelable this, String error, Object eOpts )

Fires when the active error message is changed via setActiveError. ...

Fires when the active error message is changed via setActiveError.

Parameters

this : Ext.form.Labelable
\n
error : String
The active error message
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

focus( Ext.Component this, Ext.EventObject The, Object eOpts )

Fires when this Component receives focus. ...

Fires when this Component receives focus.

Parameters

this : Ext.Component
\n
The : Ext.EventObject
focus event.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

hide( Ext.Component this, Object eOpts )

Fires after the component is hidden. ...

Fires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

keydown( Ext.form.field.Text this, Ext.EventObject e, Object eOpts )

Keydown input field event. ...

Keydown input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.field.Text
This text field
\n
e : Ext.EventObject
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

keypress( Ext.form.field.Text this, Ext.EventObject e, Object eOpts )

Keypress input field event. ...

Keypress input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.field.Text
This text field
\n
e : Ext.EventObject
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

keyup( Ext.form.field.Text this, Ext.EventObject e, Object eOpts )

Keyup input field event. ...

Keyup input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.field.Text
This text field
\n
e : Ext.EventObject
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

move( Ext.Component this, Number x, Number y, Object eOpts )

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
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

removed( Ext.Component this, Ext.container.Container ownerCt, Object eOpts )

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

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

Parameters

this : Ext.Component
\n
ownerCt : Ext.container.Container
Container which holds the component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

render( Ext.Component this, Object eOpts )

Fires after the component markup is rendered. ...

Fires after the component markup is rendered.

Parameters

this : Ext.Component
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

resize( Ext.Component this, Number width, Number height, Number oldWidth, Number oldHeight, Object eOpts )

Fires after the component is resized. ...

Fires after the component is resized. Note that this does not fire when the component is first layed out at its initial\nsize. To hook that point in the lifecycle, use the boxready event.

Parameters

this : Ext.Component
\n
width : Number
The new width that was set
\n
height : Number
The new height that was set
\n
oldWidth : Number
The previous width
\n
oldHeight : Number
The previous height
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

show( Ext.Component this, Object eOpts )

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
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

specialkey( Ext.form.field.Base this, Ext.EventObject e, Object eOpts )

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. To handle other keys\nsee Ext.util.KeyMap. You can check Ext.EventObject.getKey to determine which key was\npressed. For example:

\n\n

var form = new Ext.form.Panel({\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.up('form').getForm();\n                        form.submit();\n                    }\n                }\n            }\n        }\n    ],\n    ...\n});\n

Parameters

this : Ext.form.field.Base
\n
e : Ext.EventObject
The event object
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

staterestore( Ext.state.Stateful this, Object state, Object eOpts )

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

Fires after the state of the object is restored.

Parameters

this : Ext.state.Stateful
\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\nobject. The method maybe overriden to provide custom state restoration.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

statesave( Ext.state.Stateful this, Object state, Object eOpts )

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

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

Parameters

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