![\"Ext.form.Text](\"doc-resources/Ext.form.Text/Ext.form.Text.png\")
A basic text field. Can be used as a direct replacement for traditional text inputs,\nor as the base class for more sophisticated input controls (like Ext.form.field.TextArea\nand Ext.form.field.ComboBox). Has support for empty-field placeholder values (see emptyText).
\n\nThe Text field has a useful set of validations built in:
\n\nmaxlength attribute on the input element)In addition, custom validations may be added:
\n\nThe details around how and when each of these validation options get used are described in the\ndocumentation for getErrors.
\n\nBy default, the field value is checked for validity immediately while the user is typing in the\nfield. This can be controlled with the validateOnChange, checkChangeEvents, and\ncheckChangeBugger configurations. Also see the details on Form Validation in the\nExt.form.Panel class documentation.
\n\nText fields can be configured with custom regular expressions to be applied to entered values before\nvalidation: see maskRe and stripCharsRe for details.\n
Ext.create('Ext.form.Panel', {\n title: 'Contact Info',\n width: 300,\n bodyPadding: 10,\n renderTo: Ext.getBody(), \n items: [{\n xtype: 'textfield',\n name: 'name',\n fieldLabel: 'Name',\n allowBlank: false // requires a non-empty value\n }, {\n xtype: 'textfield',\n name: 'email',\n fieldLabel: 'Email Address',\n vtype: 'email' // requires value to be a valid email address format\n }]\n});\nIf specified, then the component will be displayed with this value as its active error when\nfirst rendered. Defaults to undefined. Use setActiveError or unsetActiveError to\nchange it after component creation.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 206, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-activeError", + "shortDoc": "If specified, then the component will be displayed with this value as its active error when\nfirst rendered. Defaults ..." + }, + { + "tagname": "cfg", + "name": "activeErrorsTpl", + "member": "Ext.form.Labelable", + "type": "Ext.XTemplate", + "doc": "The template used to format the Array of error messages passed to setActiveErrors\ninto a single HTML string. By default this renders each message as an item in an unordered list.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 50, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-activeErrorsTpl", + "shortDoc": "The template used to format the Array of error messages passed to setActiveErrors\ninto a single HTML string. By defau..." + }, + { + "tagname": "cfg", + "name": "allowBlank", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "Specify false to validate that the value's length is > 0 (defaults to\ntrue)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 129, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-allowBlank" + }, + { + "tagname": "cfg", + "name": "autoEl", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container,\nthis defaults to 'div'. The more complex Sencha classes use a more complex\nDOM structure specified by their own renderTpls.
\n\n\nThis is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:
\n\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}\nWhether to adjust the component's body area to make room for 'side' or 'under'\nerror messages. Defaults to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 184, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-autoFitErrors" + }, + { + "tagname": "cfg", + "name": "autoRender", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "This config is intended mainly for floating Components which may or may not be shown. Instead\nof using renderTo in the configuration, and rendering upon construction, this allows a Component\nto render itself upon first show.
\n\n\nSpecify as true to have this Component render to the document body upon first show.
Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.
\n\n\nThis defaults to true for the Window class.
true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false to clip any overflowing content (defaults to false).
True to automatically show the component upon creation.\nThis config option may only be used for floating components or components\nthat use autoRender. Defaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 471, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-autoShow", + "shortDoc": "True to automatically show the component upon creation.\nThis config option may only be used for floating components o..." + }, + { + "tagname": "cfg", + "name": "baseBodyCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 87, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-baseBodyCls" + }, + { + "tagname": "cfg", + "name": "baseCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "The base CSS class to apply to this components's element. This will also be prepended to\nelements within this component like Panel's body will get a class x-panel-body. This means\nthat if you create a subclass of Panel, and you want it to get all the Panels styling for the\nelement and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this\ncomponent.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 252, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls", + "shortDoc": "The base CSS class to apply to this components's element. This will also be prepended to\nelements within this compone..." + }, + { + "tagname": "cfg", + "name": "blankText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "The error text to display if the allowBlank validation\nfails (defaults to 'This field is required')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 169, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-blankText" + }, + { + "tagname": "cfg", + "name": "border", + "member": "Ext.AbstractComponent", + "type": "Number/String", + "doc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 339, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-border", + "shortDoc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be ..." + }, + { + "tagname": "cfg", + "name": "checkChangeBuffer", + "member": "Ext.form.field.Base", + "type": "Number", + "doc": "Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession.\nDefaults to 50 milliseconds.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 185, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-checkChangeBuffer", + "shortDoc": "Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession.\nDefaults to 50 milli..." + }, + { + "tagname": "cfg", + "name": "checkChangeEvents", + "member": "Ext.form.field.Base", + "type": "Array", + "doc": "A list of event names that will be listened for on the field's input element, which\nwill cause the field's value to be checked for changes. If a change is detected, the\nchange event will be fired, followed by validation if the validateOnChange\noption is enabled.
\n\n\nDefaults to ['change', 'propertychange'] in Internet Explorer, and ['change', 'input',\n'textInput', 'keyup', 'dragdrop'] in other browsers. This catches all the ways that field values\ncan be changed in most supported browsers; the only known exceptions at the time of writing are:
\n\n\nIf 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\nwithin a Ext.form.Panel, you can use the FormPanel's Ext.form.Panel.pollForChanges\nconfiguration to set up such a task automatically.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 161, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-checkChangeEvents", + "shortDoc": "A list of event names that will be listened for on the field's input element, which\nwill cause the field's value to b..." + }, + { + "tagname": "cfg", + "name": "clearCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The CSS class to be applied to the special clearing div rendered directly after the field\ncontents wrapper to provide field clearing (defaults to 'x-clear').
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 100, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-clearCls", + "shortDoc": "The CSS class to be applied to the special clearing div rendered directly after the field\ncontents wrapper to provide..." + }, + { + "tagname": "cfg", + "name": "cls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for adding customized styles to the component or any of its children using standard CSS rules.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 268, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-cls", + "shortDoc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for ..." + }, + { + "tagname": "cfg", + "name": "componentCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "CSS Class to be added to a components root level element to give distinction to it\nvia styling.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 262, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" + }, + { + "tagname": "cfg", + "name": "componentLayout", + "member": "Ext.AbstractComponent", + "type": "String/Object", + "doc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager which sizes a Component's internal structure in response to the Component being sized.
\n\n\nGenerally, 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\nThe default layout manager will be used on instances of the base Ext.Component class\nwhich simply sizes the Component's encapsulating element to the height and width specified in the setSize method.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 221, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout", + "shortDoc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager..." + }, + { + "tagname": "cfg", + "name": "contentEl", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content\nfor this component.
layout\nscheme that the Component may use. It is just HTML. Layouts operate on child items.x-hidden or the x-hide-display CSS class to\nprevent a brief flicker of the content before it is rendered to the panel.The initial set of data to apply to the tpl to\nupdate the content area of the Component.
The CSS class to use when the field value is dirty.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 156, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-dirtyCls" + }, + { + "tagname": "cfg", + "name": "disableKeyFilter", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "Specify true to disable input keystroke filtering (defaults\nto false)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 124, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-disableKeyFilter" + }, + { + "tagname": "cfg", + "name": "disabled", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "True to disable the field (defaults to false). Disabled Fields will not be\nsubmitted.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 43, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-disabled" + }, + { + "tagname": "cfg", + "name": "disabledCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 281, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" + }, + { + "tagname": "cfg", + "name": "draggable", + "member": "Ext.Component", + "type": "Mixed", + "doc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.
\n\n\nThis may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.
\n\n\nFor example to create a Component which may only be dragged around using a certain internal element as the drag handle,\nuse the delegate option:
\n\n\nnew 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\n\n\n\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js",
+ "linenr": 234,
+ "html_filename": "Component.html",
+ "href": "Component.html#Ext-Component-cfg-draggable",
+ "shortDoc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle..."
+ },
+ {
+ "tagname": "cfg",
+ "name": "emptyCls",
+ "member": "Ext.form.field.Text",
+ "type": "String",
+ "doc": "The CSS class to apply to an empty field to style the emptyText\n(defaults to 'x-form-empty-field'). This class is automatically added and removed as needed\ndepending on the current field value.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 216, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-emptyCls", + "shortDoc": "The CSS class to apply to an empty field to style the emptyText\n(defaults to 'x-form-empty-field'). This class is au..." + }, + { + "tagname": "cfg", + "name": "emptyText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "The default text to place into an empty field (defaults to undefined).
\n\n\nNote that normally this value will be submitted to the server if this field is enabled; to prevent this\nyou can set the submitEmptyText option of\nExt.form.Basic.submit to false.
\n\n\nAlso note that if you use inputType:'file', emptyText is not\nsupported and should be avoided.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 206, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-emptyText", + "shortDoc": "The default text to place into an empty field (defaults to undefined).\n\n\nNote that normally this value will be submit..." + }, + { + "tagname": "cfg", + "name": "enableKeyEvents", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "true to enable the proxying of key events for the HTML input field (defaults to false)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 225, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-enableKeyEvents" + }, + { + "tagname": "cfg", + "name": "enforceMaxLength", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "True to set the maxLength property on the underlying input field. Defaults to false
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 148, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-enforceMaxLength" + }, + { + "tagname": "cfg", + "name": "errorMsgCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 81, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-errorMsgCls" + }, + { + "tagname": "cfg", + "name": "fieldBodyCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "An extra CSS class to be applied to the body content element in addition to fieldBodyCls.\nDefaults to empty.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 93, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-fieldBodyCls" + }, + { + "tagname": "cfg", + "name": "fieldCls", + "member": "Ext.form.field.Base", + "type": "String", + "doc": "The default CSS class for the field input (defaults to 'x-form-field')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 140, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-fieldCls" + }, + { + "tagname": "cfg", + "name": "fieldLabel", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The label for the field. It gets appended with the labelSeparator, and its position\nand sizing is determined by the labelAlign, labelWidth, and labelPad\nconfigs. Defaults to undefined.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 113, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-fieldLabel", + "shortDoc": "The label for the field. It gets appended with the labelSeparator, and its position\nand sizing is determined by the l..." + }, + { + "tagname": "cfg", + "name": "fieldStyle", + "member": "Ext.form.field.Base", + "type": "String", + "doc": "Optional CSS style(s) to be applied to the field input element.\nShould be a valid argument to Ext.core.Element.applyStyles. Defaults to undefined. See also the\nsetFieldStyle method for changing the style after initialization.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 145, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-fieldStyle", + "shortDoc": "Optional CSS style(s) to be applied to the field input element.\nShould be a valid argument to Ext.core.Element.applyS..." + }, + { + "tagname": "cfg", + "name": "floating", + "member": "Ext.Component", + "type": "Boolean", + "doc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.
\n\n\nComponents such as Windows and Menus are floating\nby default.
\n\n\nFloating Components that are programatically rendered will register themselves with the global\nZIndexManager
\n\n\nA floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by\nexamining the ownerCt chain.
\n\n\nWhen configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack\nof related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when\nthe Component's toFront method is called.
\n\n\nThe ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that\ndescendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative\nto any siblings, but always above that floating ancestor Container.
\n\n\nIf no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.
\n\n\nFloating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly\nshow them.
\n\n\nAfter rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container.\nIf no floating ancestor Container was found the floatParent property will not be set.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 175, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-floating", + "shortDoc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.\n\n\nComponents such..." + }, + { + "tagname": "cfg", + "name": "focusCls", + "member": "Ext.form.field.Base", + "type": "String", + "doc": "The CSS class to use when the field receives focus (defaults to 'x-form-focus')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 151, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-focusCls" + }, + { + "tagname": "cfg", + "name": "focusOnToFront", + "member": "Ext.util.Floating", + "type": "Boolean", + "doc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 9, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-focusOnToFront", + "shortDoc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to ..." + }, + { + "tagname": "cfg", + "name": "formItemCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "A CSS class to be applied to the outermost element to denote that it is participating in the form\nfield layout. Defaults to 'x-form-item'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 68, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-formItemCls", + "shortDoc": "A CSS class to be applied to the outermost element to denote that it is participating in the form\nfield layout. Defau..." + }, + { + "tagname": "cfg", + "name": "frame", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphical rounded frame around the Component content.
This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer\nprior to version 9 which do not support rounded corners natively.
\n\n\nThe extra space taken up by this framing is available from the read only property frameSize.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 198, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-frame", + "shortDoc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphi..." + }, + { + "tagname": "cfg", + "name": "grow", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "true if this field should automatically grow and shrink to its content\n(defaults to false)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 89, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-grow" + }, + { + "tagname": "cfg", + "name": "growAppend", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "A string that will be appended to the field's current value for the purposes of calculating the target\nfield size. Only used when the grow config is true. Defaults to a single capital \"W\"\n(the widest character in common fonts) to leave enough space for the next typed character and avoid the\nfield value shifting before the width is adjusted.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 106, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-growAppend", + "shortDoc": "A string that will be appended to the field's current value for the purposes of calculating the target\nfield size. On..." + }, + { + "tagname": "cfg", + "name": "growMax", + "member": "Ext.form.field.Text", + "type": "Number", + "doc": "The maximum width to allow when grow = true (defaults\nto 800)
The minimum width to allow when grow = true (defaults\nto 30)
The height of this component in pixels.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 334, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-height" + }, + { + "tagname": "cfg", + "name": "hidden", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "Defaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 357, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hidden" + }, + { + "tagname": "cfg", + "name": "hideEmptyLabel", + "member": "Ext.form.Labelable", + "type": "Boolean", + "doc": "When set to true, the label element (fieldLabel and labelSeparator) will be\nautomatically hidden if the fieldLabel is empty. Setting this to false will cause the empty\nlabel element to be rendered and space to be reserved for it; this is useful if you want a field without a label\nto line up with other labeled fields in the same form. Defaults to true.
\n\n\nIf you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set\nthe hideLabel config to true.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 166, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-hideEmptyLabel", + "shortDoc": "When set to true, the label element (fieldLabel and labelSeparator) will be\nautomatically hidden if the fieldLabel is..." + }, + { + "tagname": "cfg", + "name": "hideLabel", + "member": "Ext.form.Labelable", + "type": "Boolean", + "doc": "Set to true to completely hide the label element (fieldLabel and labelSeparator).\nDefaults to false.
\n\n\nAlso see hideEmptyLabel, which controls whether space will be reserved for an empty fieldLabel.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 158, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-hideLabel", + "shortDoc": "Set to true to completely hide the label element (fieldLabel and labelSeparator).\nDefaults to false.\n\n\nAlso see hideE..." + }, + { + "tagname": "cfg", + "name": "hideMode", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be
'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. This\nis useful when a hidden Component must maintain measurable dimensions. Hiding using display results\nin a Component having zero dimensions.'display'.\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js",
+ "linenr": 388,
+ "html_filename": "AbstractComponent.html",
+ "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode",
+ "shortDoc": "A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be\n'display' : The..."
+ },
+ {
+ "tagname": "cfg",
+ "name": "html",
+ "member": "Ext.AbstractComponent",
+ "type": "String/Object",
+ "doc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML content is added after the component is rendered,\nso the document will not contain this HTML at the time the render event is fired.\nThis content is inserted into the body before any configured contentEl is appended.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 419, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-html", + "shortDoc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML conten..." + }, + { + "tagname": "cfg", + "name": "id", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "The unique id of this component instance (defaults to an auto-assigned id).
\n\n\nIt should not be necessary to use this configuration except for singleton objects in your application.\nComponents created with an id may be accessed globally using Ext.getCmp.
\n\n\nInstead of using assigned ids, use the itemId config, and ComponentQuery which\nprovides selector-based searching for Sencha Components analogous to DOM querying. The Container\nclass contains shortcut methods to query its descendant Components by selector.
\n\n\nNote that this id will also be used as the element id for the containing HTML element\nthat is rendered to the page for this component. This allows you to write id-based CSS\nrules to style the specific instance of this component uniquely, and also to select\nsub-elements using this component's id as the parent.
\n\n\nNote: to avoid complications imposed by a unique id also see itemId.
Note: to access the container of a Component see ownerCt.
The id that will be given to the generated input DOM element. Defaults to an automatically generated id.\nIf you configure this manually, you must make sure it is unique in the document.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 210, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-inputId", + "shortDoc": "The id that will be given to the generated input DOM element. Defaults to an automatically generated id.\nIf you confi..." + }, + { + "tagname": "cfg", + "name": "inputType", + "member": "Ext.form.field.Base", + "type": "String", + "doc": "The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text').\nThe extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them\nwill cause older browsers to fall back to 'text'.
\n\n\nThe type 'password' must be used to render that field type currently -- there is no separate Ext\ncomponent for that. You can use Ext.form.field.File which creates a custom-rendered file upload\nfield, but if you want a plain unstyled file input you can use a BaseField with inputType:'file'.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 118, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-inputType", + "shortDoc": "The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text').\nThe extended types supp..." + }, + { + "tagname": "cfg", + "name": "invalidCls", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 107, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-invalidCls" + }, + { + "tagname": "cfg", + "name": "invalidText", + "member": "Ext.form.field.Base", + "type": "String", + "doc": "The error text to use when marking a field invalid and no message is provided\n(defaults to 'The value in this field is invalid')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 134, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-invalidText", + "shortDoc": "The error text to use when marking a field invalid and no message is provided\n(defaults to 'The value in this field i..." + }, + { + "tagname": "cfg", + "name": "itemId", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. Instead of using an id with\nExt.getCmp, use itemId with\nExt.container.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the\ncontainer's internal MixedCollection, the itemId is scoped locally to the container --\navoiding potential conflicts with Ext.ComponentManager which requires a unique\nid.
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\nAlso see id, query, down and child.
Note: to access the container of an item see ownerCt.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 66, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-itemId", + "shortDoc": "An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. ..." + }, + { + "tagname": "cfg", + "name": "labelAlign", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "Controls the position and alignment of the fieldLabel. Valid values are:
\n\n\nThe CSS class to be applied to the label element. Defaults to 'x-form-item-label'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 75, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelCls" + }, + { + "tagname": "cfg", + "name": "labelPad", + "member": "Ext.form.Labelable", + "type": "Number", + "doc": "The amount of space in pixels between the fieldLabel and the input field. Defaults to 5.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 141, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelPad" + }, + { + "tagname": "cfg", + "name": "labelSeparator", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "Character(s) to be inserted at the end of the label text.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 147, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelSeparator" + }, + { + "tagname": "cfg", + "name": "labelStyle", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "A CSS style specification string to apply directly to this field's label. Defaults to undefined.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 153, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelStyle" + }, + { + "tagname": "cfg", + "name": "labelWidth", + "member": "Ext.form.Labelable", + "type": "Number", + "doc": "The width of the fieldLabel in pixels. Only applicable if the labelAlign is set\nto \"left\" or \"right\". Defaults to 100.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 134, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelWidth" + }, + { + "tagname": "cfg", + "name": "labelableRenderTpl", + "member": "Ext.form.Labelable", + "type": "Array/String/Ext.XTemplate", + "doc": "The rendering template for the field decorations. Component classes using this mixin should include\nlogic to use this as their renderTpl, and implement the\ngetSubTplMarkup method to generate the field body content.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 29, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-labelableRenderTpl", + "shortDoc": "The rendering template for the field decorations. Component classes using this mixin should include\nlogic to use this..." + }, + { + "tagname": "cfg", + "name": "listeners", + "member": "Ext.util.Observable", + "type": "Object", + "doc": "(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM listener to:
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});\nA configuration object or an instance of a Ext.ComponentLoader to load remote\ncontent for this Component.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 462, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-loader" + }, + { + "tagname": "cfg", + "name": "maintainFlex", + "member": "Ext.Component", + "type": "Boolean", + "doc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout.
\n\n\nSpecifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this\nComponent maintains its configured flex value.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 256, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-maintainFlex", + "shortDoc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout.\n\n\nSpecifies that if an immediate siblin..." + }, + { + "tagname": "cfg", + "name": "margin", + "member": "Ext.AbstractComponent", + "type": "Number/String", + "doc": "Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 351, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-margin", + "shortDoc": "Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or\nit can be ..." + }, + { + "tagname": "cfg", + "name": "maskRe", + "member": "Ext.form.field.Text", + "type": "RegExp", + "doc": "An input mask regular expression that will be used to filter keystrokes that do\nnot match (defaults to undefined)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 119, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-maskRe" + }, + { + "tagname": "cfg", + "name": "maxHeight", + "member": "Ext.AbstractComponent", + "type": "Number", + "doc": "The maximum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 451, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight", + "shortDoc": "The maximum value in pixels which this Component will set its height to.\n\n\nWarning: This will override any size manag..." + }, + { + "tagname": "cfg", + "name": "maxLength", + "member": "Ext.form.field.Text", + "type": "Number", + "doc": "Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).\nThis behavior is intended to provide instant feedback to the user by improving usability to allow pasting\nand editing or overtyping and back tracking. To restrict the maximum number of characters that can be\nentered into the field use the enforceMaxLength option.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 140, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-maxLength", + "shortDoc": "Maximum input field length allowed by validation (defaults to Number.MAX_VALUE).\nThis behavior is intended to provide..." + }, + { + "tagname": "cfg", + "name": "maxLengthText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "Error text to display if the maximum length\nvalidation fails (defaults to 'The maximum length for this field is {maxLength}')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 158, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-maxLengthText", + "shortDoc": "Error text to display if the maximum length\nvalidation fails (defaults to 'The maximum length for this field is {maxL..." + }, + { + "tagname": "cfg", + "name": "maxWidth", + "member": "Ext.AbstractComponent", + "type": "Number", + "doc": "The maximum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 456, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth", + "shortDoc": "The maximum value in pixels which this Component will set its width to.\n\n\nWarning: This will override any size manage..." + }, + { + "tagname": "cfg", + "name": "minHeight", + "member": "Ext.AbstractComponent", + "type": "Number", + "doc": "The minimum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 441, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight", + "shortDoc": "The minimum value in pixels which this Component will set its height to.\n\n\nWarning: This will override any size manag..." + }, + { + "tagname": "cfg", + "name": "minLength", + "member": "Ext.form.field.Text", + "type": "Number", + "doc": "Minimum input field length required (defaults to 0)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 135, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-minLength" + }, + { + "tagname": "cfg", + "name": "minLengthText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "Error text to display if the minimum length\nvalidation fails (defaults to 'The minimum length for this field is {minLength}')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 152, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-minLengthText", + "shortDoc": "Error text to display if the minimum length\nvalidation fails (defaults to 'The minimum length for this field is {minL..." + }, + { + "tagname": "cfg", + "name": "minWidth", + "member": "Ext.AbstractComponent", + "type": "Number", + "doc": "The minimum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 446, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minWidth", + "shortDoc": "The minimum value in pixels which this Component will set its width to.\n\n\nWarning: This will override any size manage..." + }, + { + "tagname": "cfg", + "name": "msgTarget", + "member": "Ext.form.Labelable", + "type": "String", + "doc": "The location where the error message text should display.\nMust be one of the following values:
\n\n\nqtip Display a quick tip containing the message when the user hovers over the field. This is the default.\ntitle 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.The name of the field (defaults to undefined). This is used as the parameter\nname when including the field value in a form submit(). If no name is\nconfigured, it falls back to the inputId. To prevent the field from being included in the\nform submit, set submitValue to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 111, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-name", + "shortDoc": "The name of the field (defaults to undefined). This is used as the parameter\nname when including the field value in a..." + }, + { + "tagname": "cfg", + "name": "overCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and removed when the mouse moves out. (defaults to ''). This can be\nuseful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 274, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-overCls", + "shortDoc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and..." + }, + { + "tagname": "cfg", + "name": "padding", + "member": "Ext.AbstractComponent", + "type": "Number/String", + "doc": "Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 345, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-padding", + "shortDoc": "Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or\nit can b..." + }, + { + "tagname": "cfg", + "name": "plugins", + "member": "Ext.AbstractComponent", + "type": "Object/Array", + "doc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 491, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-plugins", + "shortDoc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a ..." + }, + { + "tagname": "cfg", + "name": "preventMark", + "member": "Ext.form.Labelable", + "type": "Boolean", + "doc": "true to disable displaying any error message set on this object.\nDefaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 177, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-cfg-preventMark" + }, + { + "tagname": "cfg", + "name": "readOnly", + "member": "Ext.form.field.Base", + "type": "Boolean", + "doc": "true to mark the field as readOnly in HTML\n(defaults to false).
\n\nNote: this only sets the element's readOnly DOM attribute.\n\n\n
Setting readOnly=true, for example, will not disable triggering a\nComboBox or Date; it gives you the option of forcing the user to choose\nvia the trigger without typing in the text box. To hide the trigger use\nhideTrigger.
The CSS class applied to the component's main element when it is readOnly.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 205, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-readOnlyCls" + }, + { + "tagname": "cfg", + "name": "regex", + "member": "Ext.form.field.Text", + "type": "RegExp", + "doc": "A JavaScript RegExp object to be tested against the field value during validation\n(defaults to undefined). If the test fails, the field will be marked invalid using\nregexText.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 194, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-regex", + "shortDoc": "A JavaScript RegExp object to be tested against the field value during validation\n(defaults to undefined). If the tes..." + }, + { + "tagname": "cfg", + "name": "regexText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "The error text to display if regex is used and the\ntest fails during validation (defaults to '')
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 200, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-regexText" + }, + { + "tagname": "cfg", + "name": "renderSelectors", + "member": "Ext.AbstractComponent", + "type": "Object", + "doc": "An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render process.
\n\nAfter 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.
For example, a Component which rendered an image, and description into its element might use the following properties\ncoded into its prototype:
\n\nrenderTpl: '<img src=\"{imageUrl}\" class=\"x-image-component-img\"><div class=\"x-image-component-desc\">{description}>/div<',\n\nrenderSelectors: {\n image: 'img.x-image-component-img',\n descEl: 'div.x-image-component-desc'\n}\nAfter rendering, the Component would have a property image referencing its child img Element,\nand a property descEl referencing the div Element which contains the description.
Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.
\n\n\nSee render also.
An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component\nand Ext.container.Container, this defaults to null which means that they will be initially rendered\nwith no internal structure; they render their Element empty. The more specialized ExtJS and Touch classes\nwhich use a more complex DOM structure, provide their own template definitions.
This is intended to allow the developer to create application-specific utility Components with customized\ninternal structure.
\n\n\nUpon rendering, any created child elements may be automatically imported into object properties using the\nrenderSelectors option.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 143, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-renderTpl", + "shortDoc": "An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.\n\n\nYou do not normal..." + }, + { + "tagname": "cfg", + "name": "resizable", + "member": "Ext.Component", + "type": "Mixed", + "doc": "Specify as true to apply a Resizer to this Component\nafter rendering.
May also be specified as a config object to be passed to the constructor of Resizer\nto override any defaults. By default the Component passes its minimum and maximum size, and uses\nExt.resizer.Resizer.dynamic: false
A valid Ext.resizer.Resizer handles config string (defaults to 'all'). Only applies when resizable = true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 163, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-resizeHandles" + }, + { + "tagname": "cfg", + "name": "saveBuffer", + "member": "Ext.state.Stateful", + "type": "Number", + "doc": "A buffer to be applied if many state events are fired within\na short period. Defaults to 100.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 74, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-cfg-saveBuffer" + }, + { + "tagname": "cfg", + "name": "selectOnFocus", + "member": "Ext.form.field.Text", + "type": "Boolean", + "doc": "true to automatically select any existing field text when the field\nreceives input focus (defaults to false)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 164, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-selectOnFocus" + }, + { + "tagname": "cfg", + "name": "shadow", + "member": "Ext.util.Floating", + "type": "String/Boolean", + "doc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow, or a string indicating the\nshadow's display Ext.Shadow.mode. Set to false to disable the shadow.\n(Defaults to 'sides'.)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 16, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-shadow", + "shortDoc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow,..." + }, + { + "tagname": "cfg", + "name": "size", + "member": "Ext.form.field.Text", + "type": "Number", + "doc": "An initial value for the 'size' attribute on the text input element. This is only\nused if the field has no configured width and is not given a width by its container's layout.\nDefaults to 20.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 82, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-size", + "shortDoc": "An initial value for the 'size' attribute on the text input element. This is only\nused if the field has no configured..." + }, + { + "tagname": "cfg", + "name": "stateEvents", + "member": "Ext.state.Stateful", + "type": "Array", + "doc": "An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). stateEvents may be any type\nof event supported by this object, including browser or custom events\n(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and\nrestoring object state.
The unique id for this object to use for state management purposes.
\n\nSee stateful for an explanation of saving and restoring state.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 58, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-cfg-stateId", + "shortDoc": "The unique id for this object to use for state management purposes.\n\nSee stateful for an explanation of saving and re..." + }, + { + "tagname": "cfg", + "name": "stateful", + "member": "Ext.state.Stateful", + "type": "Boolean", + "doc": "A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. The object must have\na stateId for state to be managed. \nAuto-generated ids are not guaranteed to be stable across page loads and \ncannot be relied upon to save and restore the same state for a object.
\n
For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.
\nTo set the state provider for the current page:
\nExt.state.Manager.setProvider(new Ext.state.CookieProvider({\n expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\nA stateful object attempts to save state when one of the events\nlisted in the stateEvents configuration fires.
To save state, a stateful object first serializes its state by\ncalling getState. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the restorable state of the object.
The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the stateId
During construction, a stateful object attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId
The resulting object is passed to applyState.\nThe default implementation of applyState simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.
You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 18, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-cfg-stateful", + "shortDoc": "A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. ..." + }, + { + "tagname": "cfg", + "name": "stripCharsRe", + "member": "Ext.form.field.Text", + "type": "RegExp", + "doc": "A JavaScript RegExp object used to strip unwanted content from the value\nbefore validation (defaults to undefined).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 77, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-stripCharsRe" + }, + { + "tagname": "cfg", + "name": "style", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.core.Element.applyStyles.
\n\n new Ext.panel.Panel({\n title: 'Some Title',\n renderTo: Ext.getBody(),\n width: 400, height: 300,\n layout: 'form',\n items: [{\n xtype: 'textarea',\n style: {\n width: '95%',\n marginBottom: '10px'\n }\n },\n new Ext.button.Button({\n text: 'Send',\n minWidth: '100',\n style: {\n marginBottom: '10px'\n }\n })\n ]\n });\n The class that is added to the content target when you set styleHtmlContent to true.\nDefaults to 'x-html'
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 434, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" + }, + { + "tagname": "cfg", + "name": "styleHtmlContent", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "True to automatically style the html inside the content target of this component (body for panels).\nDefaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 427, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent" + }, + { + "tagname": "cfg", + "name": "submitValue", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Setting this to false will prevent the field from being\nsubmitted even when it is not disabled. Defaults to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 49, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-submitValue" + }, + { + "tagname": "cfg", + "name": "tabIndex", + "member": "Ext.form.field.Base", + "type": "Number", + "doc": "The tabIndex for this field. Note this only applies to fields that are rendered,\nnot those which are built via applyTo (defaults to undefined).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 129, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-tabIndex", + "shortDoc": "The tabIndex for this field. Note this only applies to fields that are rendered,\nnot those which are built via applyT..." + }, + { + "tagname": "cfg", + "name": "toFrontOnShow", + "member": "Ext.Component", + "type": "Boolean", + "doc": "True to automatically call toFront when the show method is called\non an already visible, floating component (default is true).
An data and\ntplWriteMode configurations.
The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.XTemplate.overwrite).
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 287, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-ui" + }, + { + "tagname": "cfg", + "name": "validateOnBlur", + "member": "Ext.form.field.Base", + "type": "Boolean", + "doc": "Whether the field should validate when it loses focus (defaults to true). This will cause fields\nto be validated as the user steps through the fields in the form regardless of whether they are making\nchanges to those fields along the way. See also validateOnChange.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 216, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-cfg-validateOnBlur", + "shortDoc": "Whether the field should validate when it loses focus (defaults to true). This will cause fields\nto be validated as t..." + }, + { + "tagname": "cfg", + "name": "validateOnChange", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to true. If the validation results in a change in the field's validity, a\nvaliditychange event will be fired. This allows the field to show feedback about the\nvalidity of its contents immediately as the user is typing.
\n\n\nWhen set to false, feedback will not be immediate. However the form will still be validated\nbefore submitting if the clientValidation option to Ext.form.Basic.doAction is\nenabled, or if the field or form are validated manually.
\n\n\nSee also Ext.form.field.Base.checkChangeEventsfor controlling how changes to the field's value are detected.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 55, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-validateOnChange", + "shortDoc": "Specifies whether this field should be validated immediately whenever a change in its value is detected.\nDefaults to ..." + }, + { + "tagname": "cfg", + "name": "validator", + "member": "Ext.form.field.Text", + "type": "Function", + "doc": "A custom validation function to be called during field validation (getErrors)\n(defaults to undefined). If specified, this function will be called first, allowing the\ndeveloper to override the default validation process.
\n\n\nThis function will be passed the following Parameters:
\n\n\nvalue: Mixed\nThis function is to Return:
\n\n\ntrue: Boolean\ntrue if the value is validmsg: String\nA value to initialize this field with (defaults to undefined).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 33, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-cfg-value" + }, + { + "tagname": "cfg", + "name": "vtype", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "A validation type name as defined in Ext.form.field.VTypes (defaults to undefined)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 115, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-cfg-vtype" + }, + { + "tagname": "cfg", + "name": "vtypeText", + "member": "Ext.form.field.Text", + "type": "String", + "doc": "A custom error message to display in place of the default message provided\nfor the vtype currently set for this field (defaults to undefined).\nNote: only applies if vtype is set, else ignored.
The width of this component in pixels.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 329, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-width" + } + ], + "method": [ + { + "tagname": "method", + "name": "Text", + "member": "Ext.form.field.Text", + "doc": "Creates a new TextField
\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "Configuration options
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 1, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-constructor", + "shortDoc": "Creates a new TextField
\n" + }, + { + "tagname": "method", + "name": "addClass", + "member": "Ext.AbstractComponent", + "doc": "@deprecated 4.0 Replaced by addCls\nAdds a CSS class to the top level element representing this component.
\n", + "params": [ + { + "type": "String", + "name": "cls", + "doc": "The CSS class name to add
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "Returns the Component to allow method chaining.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2161, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-addClass", + "shortDoc": "@deprecated 4.0 Replaced by addCls\nAdds a CSS class to the top level element representing this component.
\n" + }, + { + "tagname": "method", + "name": "addCls", + "member": "Ext.AbstractComponent", + "doc": "Adds a CSS class to the top level element representing this component.
\n", + "params": [ + { + "type": "String", + "name": "cls", + "doc": "The CSS class name to add
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "Returns the Component to allow method chaining.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2139, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-addCls", + "shortDoc": "Adds a CSS class to the top level element representing this component.
\n" + }, + { + "tagname": "method", + "name": "addClsWithUI", + "member": "Ext.AbstractComponent", + "doc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component.
\n", + "params": [ + { + "type": "String/Array", + "name": "cls", + "doc": "A string or an array of strings to add to the uiCls
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1346, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI", + "shortDoc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component.
\n" + }, + { + "tagname": "method", + "name": "addEvents", + "member": "Ext.util.Observable", + "doc": "Adds the specified events to the list of events which this Observable may fire.
\n", + "params": [ + { + "type": "Object/String", + "name": "o", + "doc": "Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n" + }, + { + "tagname": "method", + "name": "addListener", + "member": "Ext.util.Observable", + "doc": "Appends an event handler to this object.
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\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", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 271, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "
Appends an event handler to this object.
\n" + }, + { + "tagname": "method", + "name": "addManagedListener", + "member": "Ext.util.Observable", + "doc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", + "params": [ + { + "type": "Observable/Element", + "name": "item", + "doc": "
The item to which to add a listener/listeners.
\n", + "optional": false + }, + { + "type": "Object/String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Optional. If the ename parameter was an event name, this\nis the addListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" + }, + { + "tagname": "method", + "name": "addStateEvents", + "member": "Ext.state.Stateful", + "doc": "
Add events that will trigger the state to be saved.
\n", + "params": [ + { + "type": "String/Array", + "name": "events", + "doc": "The event name or an array of event names.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 159, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-method-addStateEvents", + "shortDoc": "Add events that will trigger the state to be saved.
\n" + }, + { + "tagname": "method", + "name": "afterComponentLayout", + "member": "Ext.AbstractComponent", + "doc": "\n", + "params": [ + { + "type": "Number", + "name": "adjWidth", + "doc": "The box-adjusted width that was set
\n", + "optional": false + }, + { + "type": "Number", + "name": "adjHeight", + "doc": "The box-adjusted height that was set
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isSetSize", + "doc": "Whether or not the height/width are stored on the component permanently
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "layoutOwner", + "doc": "Component which sent the layout. Only used when isSetSize is false.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2481, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "alignTo", + "member": "Ext.util.Floating", + "doc": "Aligns this floating Component to the specified element
\n", + "params": [ + { + "type": "Mixed", + "name": "element", + "doc": "The element or Ext.Component to align to. If passing a component, it must\nbe a omponent instance. If a string id is passed, it will be used as an element id.
\n", + "optional": false + }, + { + "type": "String", + "name": "position", + "doc": "(optional, defaults to \"tl-bl?\") The position to align to (see Ext.core.Element.alignTo for more details).
\n", + "optional": false + }, + { + "type": "Array", + "name": "offsets", + "doc": "(optional) Offset the positioning by [x, y]
\n", + "optional": true + } + ], + "return": { + "type": "Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 171, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-alignTo", + "shortDoc": "Aligns this floating Component to the specified element
\n" + }, + { + "tagname": "method", + "name": "animate", + "member": "Ext.util.Animate", + "doc": "Perform custom animation on this object.
\n
This method is applicable to both the the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
Properties include
from to durationeasing \n- ease
\n- easeIn
\n- easeOut
\n- easeInOut
\n- backIn
\n- backOut
\n- elasticIn
\n- elasticOut
\n- bounceIn
\n- bounceOut
\n
keyframes listeners beforeanimate event or the afteranimate event.from, to, and keyframe objects:x y left left value. Units must be supplied.top top value. Units must be supplied.width width value. Units must be supplied.height height value. Units must be supplied.scrollLeft scrollLeft value.scrollTop scrollLeft value.opacity opacity value. This must be a value between 0 and 1.Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.
\nfrom, to, and keyframe objects:x y left left value in pixels.top top value in pixels.width width value in pixels.width width value in pixels.dynamic For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:
\nmyWindow = 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});\nFor performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\" size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.
An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\n", + "optional": false + } + ], + "return": { + "type": "Object", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 207, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-animate", + "shortDoc": "Perform custom animation on this object.\nThis method is applicable to both the the Component class and the Element cl..." + }, + { + "tagname": "method", + "name": "applyState", + "member": "Ext.state.Stateful", + "doc": "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.
\n", + "params": [ + { + "type": "Object", + "name": "state", + "doc": "The state
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 225, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-method-applyState", + "shortDoc": "Applies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By defa..." + }, + { + "tagname": "method", + "name": "autoSize", + "member": "Ext.form.field.Text", + "doc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event if the\nwidth changes.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 636, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-autoSize", + "shortDoc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only ta..." + }, + { + "tagname": "method", + "name": "batchChanges", + "member": "Ext.form.field.Field", + "doc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent excessive firing of change events. This is useful for instance\nif the field has sub-fields which are being updated as a group; you don't want the container\nfield to check its own changed state for each subfield change.
\n", + "params": [ + { + "type": "Object", + "name": "fn", + "doc": "A function containing the transaction code
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 348, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-batchChanges", + "shortDoc": "A utility for grouping a set of modifications which may trigger value changes into a single\ntransaction, to prevent e..." + }, + { + "tagname": "method", + "name": "beforeComponentLayout", + "member": "Ext.AbstractComponent", + "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being executed.
\n", + "params": [ + { + "type": "Number", + "name": "adjWidth", + "doc": "The box-adjusted width that was set
\n", + "optional": false + }, + { + "type": "Number", + "name": "adjHeight", + "doc": "The box-adjusted height that was set
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isSetSize", + "doc": "Whether or not the height/width are stored on the component permanently
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "layoutOwner", + "doc": "Component which sent the layout. Only used when isSetSize is false.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2491, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout", + "shortDoc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being ex..." + }, + { + "tagname": "method", + "name": "bubble", + "member": "Ext.Component", + "doc": "Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe bubble is stopped.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The function to call
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope of the function (defaults to current node)
\n", + "optional": true + }, + { + "type": "Array", + "name": "args", + "doc": "(optional) The args to call the function with (default to passing the current component)
\n", + "optional": true + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 1004, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-bubble", + "shortDoc": "Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of..." + }, + { + "tagname": "method", + "name": "capture", + "member": "Ext.util.Observable", + "doc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "The Observable to capture events from.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "The function to call when an event is fired.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Center this Component in its container.
\n", + "params": [ + + ], + "return": { + "type": "Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 249, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-center", + "shortDoc": "Center this Component in its container.
\n" + }, + { + "tagname": "method", + "name": "checkChange", + "member": "Ext.form.field.Field", + "doc": "Checks whether the value of the field has changed since the last time it was checked. If the value\nhas changed, it:
\n\n\nChecks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange event.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 286, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-checkDirty", + "shortDoc": "Checks the isDirty state of the field and if it has changed since the last time\nit was checked, fires the dirtychange..." + }, + { + "tagname": "method", + "name": "clearInvalid", + "member": "Ext.form.field.Base", + "doc": "Clear any invalid styles/messages for this field.
\n\n\nNote: this method does not cause the Field's validate or isValid methods to\nreturn true if the value does not pass validation. So simply clearing a field's errors\nwill not necessarily allow submission of forms submitted with the Ext.form.action.Submit.clientValidation\noption set.
Removes all listeners for this object including the managed listeners
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 383, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners
\n" + }, + { + "tagname": "method", + "name": "clearManagedListeners", + "member": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 412, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object.
\n" + }, + { + "tagname": "method", + "name": "cloneConfig", + "member": "Ext.Component", + "doc": "Clone the current component using the original config values passed into this instance by default.
\n", + "params": [ + { + "type": "Object", + "name": "overrides", + "doc": "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", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "clone The cloned copy of this component
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 944, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-cloneConfig", + "shortDoc": "Clone the current component using the original config values passed into this instance by default.
\n" + }, + { + "tagname": "method", + "name": "destroy", + "member": "Ext.AbstractComponent", + "doc": "Destroys the Component.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2672, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-destroy", + "shortDoc": "Destroys the Component.
\n" + }, + { + "tagname": "method", + "name": "disable", + "member": "Ext.AbstractComponent", + "doc": "Disable the component.
\n", + "params": [ + { + "type": "Boolean", + "name": "silent", + "doc": "Passing true, will supress the 'disable' event from being fired.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2078, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-disable", + "shortDoc": "Disable the component.
\n" + }, + { + "tagname": "method", + "name": "doAutoRender", + "member": "Ext.AbstractComponent", + "doc": "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
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 816, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender", + "shortDoc": "Handles autoRender.\nFloating Components may have an ownerCt. If they are asking to be constrained, constrain them wit..." + }, + { + "tagname": "method", + "name": "doComponentLayout", + "member": "Ext.AbstractComponent", + "doc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.
\n", + "params": [ + { + "type": "Object", + "name": "width", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "height", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "isSetSize", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "ownerCt", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.container.Container", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2437, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout", + "shortDoc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout t..." + }, + { + "tagname": "method", + "name": "doConstrain", + "member": "Ext.util.Floating", + "doc": "Moves this floating Component into a constrain region.
\n\n\nBy default, this Component is constrained to be within the container it was added to, or the element\nit was rendered to.
\n\n\nAn alternative constraint may be passed.
\n\n", + "params": [ + { + "type": "Mixed", + "name": "constrainTo", + "doc": "Optional. The Element or Region into which this Component is to be constrained.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 133, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-doConstrain", + "shortDoc": "Moves this floating Component into a constrain region.\n\n\nBy default, this Component is constrained to be within the c..." + }, + { + "tagname": "method", + "name": "enable", + "member": "Ext.AbstractComponent", + "doc": "Enable the component
\n", + "params": [ + { + "type": "Boolean", + "name": "silent", + "doc": "Passing false will supress the 'enable' event from being fired.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2055, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-enable", + "shortDoc": "Enable the component
\n" + }, + { + "tagname": "method", + "name": "enableBubble", + "member": "Ext.util.Observable", + "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : 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.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\nThe event name to bubble, or an Array of event names.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 554, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." + }, + { + "tagname": "method", + "name": "extractFileInput", + "member": "Ext.form.field.Field", + "doc": "Only relevant if the instance's isFileUpload method returns true. Returns a reference\nto the file input DOM element holding the user's selected file. The input will be appended into\nthe submission form and will not be returned, so this method should also create a replacement.
\n", + "params": [ + + ], + "return": { + "type": "HTMLInputElement", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 373, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-extractFileInput", + "shortDoc": "Only relevant if the instance's isFileUpload method returns true. Returns a reference\nto the file input DOM element h..." + }, + { + "tagname": "method", + "name": "findLayoutController", + "member": "Ext.AbstractComponent", + "doc": "This method finds the topmost active layout who's processing will eventually determine the size and position of this\nComponent.
\n
This method is useful when dynamically adding Components into Containers, and some processing must take place after the\nfinal sizing and positioning of the Component has been performed.
\n\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 772, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-findLayoutController", + "shortDoc": "This method finds the topmost active layout who's processing will eventually determine the size and position of this\n..." + }, + { + "tagname": "method", + "name": "findParentBy", + "member": "Ext.Component", + "doc": "Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the container will be returned.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The custom function to call with the arguments (container, this component).
\n", + "optional": false + } + ], + "return": { + "type": "Ext.container.Container", + "doc": "The first Container for which the custom function returns true
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 975, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-findParentBy", + "shortDoc": "Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the con..." + }, + { + "tagname": "method", + "name": "findParentByType", + "member": "Ext.Component", + "doc": "Find a container above this component at any level by xtype or class
\n\n\nSee also the up method.
\n\n", + "params": [ + { + "type": "String/Class", + "name": "xtype", + "doc": "The xtype string for a component, or the class of the component directly
\n", + "optional": false + } + ], + "return": { + "type": "Ext.container.Container", + "doc": "The first Container which matches the given xtype or class
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 989, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-findParentByType", + "shortDoc": "Find a container above this component at any level by xtype or class
\n\n\nSee also the up method.
\n\n" + }, + { + "tagname": "method", + "name": "fireEvent", + "member": "Ext.util.Observable", + "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to fire.
\n", + "optional": false + }, + { + "type": "Object...", + "name": "args", + "doc": "Variable number of parameters are passed to handlers.
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 232, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." + }, + { + "tagname": "method", + "name": "focus", + "member": "Ext.Component", + "doc": "Try to focus this component.
\n", + "params": [ + { + "type": "Boolean", + "name": "selectText", + "doc": "(optional) If applicable, true to also select the text in this component
\n", + "optional": true + }, + { + "type": "Boolean/Number", + "name": "delay", + "doc": "(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).
\n", + "optional": true + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 853, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-focus", + "shortDoc": "Try to focus this component.
\n" + }, + { + "tagname": "method", + "name": "getActiveAnimation", + "member": "Ext.util.Animate", + "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n", + "params": [ + + ], + "return": { + "type": "Mixed", + "doc": "anim if element has active effects, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 377, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-getActiveAnimation", + "shortDoc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n" + }, + { + "tagname": "method", + "name": "getActiveError", + "member": "Ext.form.Labelable", + "doc": "Gets the active error message for this component, if any. This does not trigger\nvalidation on its own, it merely returns any message that the component may already hold.
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The active error message on the component; if there is no error, an empty string is returned.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 330, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-getActiveError", + "shortDoc": "Gets the active error message for this component, if any. This does not trigger\nvalidation on its own, it merely retu..." + }, + { + "tagname": "method", + "name": "getActiveErrors", + "member": "Ext.form.Labelable", + "doc": "Gets an Array of any active error messages currently applied to the field. This does not trigger\nvalidation on its own, it merely returns any messages that the component may already hold.
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The active error messages on the component; if there are no errors, an empty Array is returned.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 360, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-getActiveErrors", + "shortDoc": "Gets an Array of any active error messages currently applied to the field. This does not trigger\nvalidation on its ow..." + }, + { + "tagname": "method", + "name": "getBox", + "member": "Ext.Component", + "doc": "Gets the current box measurements of the component's underlying element.
\n", + "params": [ + { + "type": "Boolean", + "name": "local", + "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", + "optional": true + } + ], + "return": { + "type": "Object", + "doc": "box An object in the format {x, y, width, height}
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 538, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-getBox", + "shortDoc": "Gets the current box measurements of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "getBubbleTarget", + "member": "Ext.AbstractComponent", + "doc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n", + "params": [ + + ], + "return": { + "type": "Ext.container.Container", + "doc": "the Container which owns this Component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2276, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget", + "shortDoc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n" + }, + { + "tagname": "method", + "name": "getEl", + "member": "Ext.AbstractComponent", + "doc": "Retrieves the top level element representing this component.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1892, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getEl", + "shortDoc": "Retrieves the top level element representing this component.
\n" + }, + { + "tagname": "method", + "name": "getErrors", + "member": "Ext.form.field.Text", + "doc": "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\nField 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:
true if the value is valid (validation continues).Basic Validation
\n\n If the validator has not halted validation,\n basic validation proceeds as follows:
allowBlank : (Invalid message = emptyText)
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)
If the passed value does not satisfy the minLength\n specified, validation halts.
maxLength : (Invalid message = maxLengthText)
If the passed value does not satisfy the maxLength\n specified, validation halts.
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
The value to validate. The processed raw value will be used if nothing is passed
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "Array of any validation errors
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 499, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-getErrors", + "shortDoc": "Validates a value according to the field's validation rules and returns an array of errors\nfor any failing validation..." + }, + { + "tagname": "method", + "name": "getFieldLabel", + "member": "Ext.form.Labelable", + "doc": "Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be\noverridden to provide
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The configured field label, or empty string if not defined
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 232, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-getFieldLabel", + "shortDoc": "Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be\noverridden to provide
\n" + }, + { + "tagname": "method", + "name": "getHeight", + "member": "Ext.AbstractComponent", + "doc": "Gets the current height of the component's underlying element.
\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2579, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getHeight", + "shortDoc": "Gets the current height of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "getId", + "member": "Ext.AbstractComponent", + "doc": "Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1880, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getId", + "shortDoc": "Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n" + }, + { + "tagname": "method", + "name": "getInputId", + "member": "Ext.form.field.Base", + "doc": "Returns the input id for this field. If none was specified via the inputId config,\nthen an id will be automatically generated.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 298, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-getInputId", + "shortDoc": "Returns the input id for this field. If none was specified via the inputId config,\nthen an id will be automatically g..." + }, + { + "tagname": "method", + "name": "getInsertPosition", + "member": "Ext.AbstractComponent", + "doc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insertBefore.
\n", + "params": [ + { + "type": "String/Number/Element/HTMLElement", + "name": "position", + "doc": "Index, element id or element you want\nto put this component before.
\n", + "optional": false + } + ], + "return": { + "type": "HTMLElement", + "doc": "DOM element that you can use in the insertBefore
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1513, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition", + "shortDoc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insert..." + }, + { + "tagname": "method", + "name": "getLoader", + "member": "Ext.AbstractComponent", + "doc": "Gets the Ext.ComponentLoader for this Component.
\n", + "params": [ + + ], + "return": { + "type": "Ext.ComponentLoader", + "doc": "The loader instance, null if it doesn't exist.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2587, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getLoader", + "shortDoc": "Gets the Ext.ComponentLoader for this Component.
\n" + }, + { + "tagname": "method", + "name": "getModelData", + "member": "Ext.form.field.Field", + "doc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRecord is called. Typically this will be an object with a single name-value\npair, the name being this field's name and the value being its current data value. More\nadvanced field implementations may return more than one name-value pair. The returned values will be\nsaved to the corresponding field names in the Model.
\n\n\nNote that the values returned from this method are not guaranteed to have been successfully\nvalidated.
\n\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "A mapping of submit parameter names to values; each value should be a string, or an array\nof strings if that particular name has multiple values. It can also return null if there are no\nparameters to be submitted.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 190, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getModelData", + "shortDoc": "Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when\nExt.form.Basic.updateRe..." + }, + { + "tagname": "method", + "name": "getName", + "member": "Ext.form.field.Field", + "doc": "Returns the name attribute of the field. This is used as the parameter\nname when including the field value in a form submit().
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "name The field name
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 128, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getName", + "shortDoc": "Returns the name attribute of the field. This is used as the parameter\nname when including the field value in a form ..." + }, + { + "tagname": "method", + "name": "getPlugin", + "member": "Ext.AbstractComponent", + "doc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent.
\n", + "params": [ + { + "type": "Object", + "name": "pluginId", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.AbstractPlugin", + "doc": "pluginInstance
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2715, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getPlugin", + "shortDoc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent.
\n" + }, + { + "tagname": "method", + "name": "getPosition", + "member": "Ext.Component", + "doc": "Gets the current XY position of the component's underlying element.
\n", + "params": [ + { + "type": "Boolean", + "name": "local", + "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", + "optional": true + } + ], + "return": { + "type": "Array", + "doc": "The XY position of the element (e.g., [100, 200])
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 603, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-getPosition", + "shortDoc": "Gets the current XY position of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "getRawValue", + "member": "Ext.form.field.Text", + "doc": "Returns the raw String value of the field, without performing any normalization, conversion, or validation.\nGets the 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.
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "value The raw String value of the field
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 464, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-getRawValue", + "shortDoc": "Returns the raw String value of the field, without performing any normalization, conversion, or validation.\nGets the ..." + }, + { + "tagname": "method", + "name": "getSize", + "member": "Ext.AbstractComponent", + "doc": "Gets the current size of the component's underlying element.
\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "An object containing the element's size {width: (element width), height: (element height)}
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2563, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getSize", + "shortDoc": "Gets the current size of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "getState", + "member": "Ext.state.Stateful", + "doc": "Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to implement methods for getting the state.
\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "The current state
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 216, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-method-getState", + "shortDoc": "Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to..." + }, + { + "tagname": "method", + "name": "getStateId", + "member": "Ext.state.Stateful", + "doc": "Gets the state id for this object.
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The state id, null if not found.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 237, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-method-getStateId", + "shortDoc": "Gets the state id for this object.
\n" + }, + { + "tagname": "method", + "name": "getSubmitData", + "member": "Ext.form.field.Field", + "doc": "Returns the parameter(s) that would be included in a standard form submit for this field. Typically this\nwill be an object with a single name-value pair, the name being this field's name and the\nvalue being its current stringified value. More advanced field implementations may return more than one\nname-value pair.
\n\n\nNote that the values returned from this method are not guaranteed to have been successfully\nvalidated.
\n\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "A mapping of submit parameter names to values; each value should be a string, or an array\nof strings if that particular name has multiple values. It can also return null if there are no\nparameters to be submitted.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 169, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-getSubmitData", + "shortDoc": "Returns the parameter(s) that would be included in a standard form submit for this field. Typically this\nwill be an o..." + }, + { + "tagname": "method", + "name": "getSubmitValue", + "member": "Ext.form.field.Base", + "doc": "Returns the value that would be included in a standard form submit for this field. This will be combined\nwith the field's name to form a name=value pair in the submitted parameters.\nIf an empty string is returned then just the name= will be submitted; if null is returned\nthen nothing will be submitted.
\n\n\nNote that the value returned will have been processed but may or may not have\nbeen successfully validated.
\n\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The value to be submitted, or null.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 440, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-getSubmitValue", + "shortDoc": "Returns the value that would be included in a standard form submit for this field. This will be combined\nwith the fie..." + }, + { + "tagname": "method", + "name": "getValue", + "member": "Ext.form.field.Base", + "doc": "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.
\n", + "params": [ + + ], + "return": { + "type": "Mixed", + "doc": "value The field value
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 524, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-getValue", + "shortDoc": "Returns the current data value of the field. The type of value returned is particular to the type of the\nparticular f..." + }, + { + "tagname": "method", + "name": "getWidth", + "member": "Ext.AbstractComponent", + "doc": "Gets the current width of the component's underlying element.
\n", + "params": [ + + ], + "return": { + "type": "Number", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2571, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getWidth", + "shortDoc": "Gets the current width of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "getXType", + "member": "Ext.Component", + "doc": "Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all\navailable xtypes, see the Ext.Component header. Example usage:
\n\nvar t = new Ext.form.field.Text();\nalert(t.getXType()); // alerts 'textfield'\nThe xtype
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 962, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-getXType", + "shortDoc": "Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all\navailable xtypes, see th..." + }, + { + "tagname": "method", + "name": "getXTypes", + "member": "Ext.AbstractComponent", + "doc": "Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext.Component header.
\n\n\nIf using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.
\n\n\nExample usage:
\n\n\nvar t = new Ext.form.field.Text();\nalert(t.getXTypes()); // alerts 'component/field/textfield'\nThe xtype hierarchy string
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1938, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getXTypes", + "shortDoc": "Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext..." + }, + { + "tagname": "method", + "name": "hasActiveError", + "member": "Ext.form.Labelable", + "doc": "Tells whether the field currently has an active error message. This does not trigger\nvalidation on its own, it merely looks for any message that the component may already hold.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 339, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-hasActiveError", + "shortDoc": "Tells whether the field currently has an active error message. This does not trigger\nvalidation on its own, it merely..." + }, + { + "tagname": "method", + "name": "hasActiveFx", + "member": "Ext.util.Animate", + "doc": "@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively running or queued, else returns false.
\n", + "params": [ + + ], + "return": { + "type": "Mixed", + "doc": "anim if element has active effects, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 369, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-hasActiveFx", + "shortDoc": "@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively ..." + }, + { + "tagname": "method", + "name": "hasListener", + "member": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to check for
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 480, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event
\n" + }, + { + "tagname": "method", + "name": "hasUICls", + "member": "Ext.AbstractComponent", + "doc": "Checks if there is currently a specified uiCls
\n", + "params": [ + { + "type": "String", + "name": "cls", + "doc": "The cls to check
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1389, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-hasUICls", + "shortDoc": "Checks if there is currently a specified uiCls
\n" + }, + { + "tagname": "method", + "name": "hide", + "member": "Ext.Component", + "doc": "Hides this Component, setting it to invisible using the configured hideMode.
\n", + "params": [ + { + "type": "String/Element/Component", + "name": "animateTarget", + "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true..\nThe target to which the Component should animate while hiding (defaults to null with no animation)
(optional) A callback function to call after the Component is hidden.
\n", + "optional": true + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 748, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-hide", + "shortDoc": "Hides this Component, setting it to invisible using the configured hideMode.
\n" + }, + { + "tagname": "method", + "name": "initField", + "member": "Ext.form.field.Field", + "doc": "Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during their own initialization process.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 73, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-initField", + "shortDoc": "Initializes this Field mixin on the current instance. Components using this mixin should call\nthis method during thei..." + }, + { + "tagname": "method", + "name": "initLabelable", + "member": "Ext.form.Labelable", + "doc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 214, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-initLabelable", + "shortDoc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own in..." + }, + { + "tagname": "method", + "name": "is", + "member": "Ext.AbstractComponent", + "doc": "Tests whether this Component matches the selector string.
\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "The selector string to test against.
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if this Component matches the selector.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1719, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-is", + "shortDoc": "Tests whether this Component matches the selector string.
\n" + }, + { + "tagname": "method", + "name": "isDescendantOf", + "member": "Ext.AbstractComponent", + "doc": "Determines whether this component is the descendant of a particular container.
\n", + "params": [ + { + "type": "Ext.Container", + "name": "container", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "isDescendant
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2731, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf", + "shortDoc": "Determines whether this component is the descendant of a particular container.
\n" + }, + { + "tagname": "method", + "name": "isDirty", + "member": "Ext.form.field.Field", + "doc": "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\nNote that if the owning form was configured with\ntrackResetOnLoad\nthen the originalValue is updated when the values are loaded by\nExt.form.Basic.setValues.
\n\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if this field has been changed from its original value (and\nis not disabled), false otherwise.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 271, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isDirty", + "shortDoc": "Returns true if the value of this Field has been changed from its originalValue.\nWill always return false if the fiel..." + }, + { + "tagname": "method", + "name": "isDisabled", + "member": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is currently disabled.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "the disabled state of this Component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2115, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDisabled", + "shortDoc": "Method to determine whether this Component is currently disabled.
\n" + }, + { + "tagname": "method", + "name": "isDraggable", + "member": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is draggable.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "the draggable state of this component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2292, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDraggable", + "shortDoc": "Method to determine whether this Component is draggable.
\n" + }, + { + "tagname": "method", + "name": "isDroppable", + "member": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is droppable.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "the droppable state of this component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2300, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDroppable", + "shortDoc": "Method to determine whether this Component is droppable.
\n" + }, + { + "tagname": "method", + "name": "isEqual", + "member": "Ext.form.field.Field", + "doc": "Returns whether two field values are logically equal. Field implementations may override\nthis to provide custom comparison logic appropriate for the particular field's data type.
\n", + "params": [ + { + "type": "Mixed", + "name": "value1", + "doc": "The first value to compare
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "value2", + "doc": "The second value to compare
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if the values are equal, false if inequal.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 158, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isEqual", + "shortDoc": "Returns whether two field values are logically equal. Field implementations may override\nthis to provide custom compa..." + }, + { + "tagname": "method", + "name": "isFileUpload", + "member": "Ext.form.field.Field", + "doc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitting the form via AJAX. See\nExt.form.Basic.hasUpload for details. If this returns true, the extractFileInput\nmethod must also be implemented to return the corresponding file input element.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 362, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-isFileUpload", + "shortDoc": "Returns whether this Field is a file upload field; if it returns true, forms will use\nspecial techniques for submitti..." + }, + { + "tagname": "method", + "name": "isFloating", + "member": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is floating.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "the floating state of this component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2284, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isFloating", + "shortDoc": "Method to determine whether this Component is floating.
\n" + }, + { + "tagname": "method", + "name": "isHidden", + "member": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is currently set to hidden.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "the hidden state of this Component.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2131, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isHidden", + "shortDoc": "Method to determine whether this Component is currently set to hidden.
\n" + }, + { + "tagname": "method", + "name": "isValid", + "member": "Ext.form.field.Base", + "doc": "Returns whether or not the field value is currently valid by\nvalidating the processed raw value\nof the field. Note: disabled fields are always treated as valid.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the value is valid, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 691, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-isValid", + "shortDoc": "Returns whether or not the field value is currently valid by\nvalidating the processed raw value\nof the field. Note: d..." + }, + { + "tagname": "method", + "name": "isVisible", + "member": "Ext.AbstractComponent", + "doc": "Returns true if this component is visible.
\n", + "params": [ + { + "type": "Boolean", + "name": "deep", + "doc": ".
Optional. Pass true to interrogate the visibility status of all\nparent Containers to determine whether this Component is truly visible to the user.
Generally, to determine whether a Component is hidden, the no argument form is needed. For example\nwhen creating dynamically laid out UIs in a hidden Container before showing them.
\n\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if this component is visible, false otherwise.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2015, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isVisible", + "shortDoc": "Returns true if this component is visible.
\n" + }, + { + "tagname": "method", + "name": "isXType", + "member": "Ext.AbstractComponent", + "doc": "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\nIf using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.
\n\n\nFor a list of all available xtypes, see the Ext.Component header.
\n\n\nExample usage:
\n\n\nvar 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\nThe xtype to check for this Component
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "shallow", + "doc": "(optional) False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n", + "optional": true + } + ], + "return": { + "type": "Boolean", + "doc": "True if this component descends from the specified xtype, false otherwise.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1907, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-isXType", + "shortDoc": "Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom th..." + }, + { + "tagname": "method", + "name": "markInvalid", + "member": "Ext.form.field.Base", + "doc": "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\nNote: this method does not cause the Field's validate or isValid methods to\nreturn false if the value does pass validation. So simply marking a Field as invalid\nwill not prevent submission of forms submitted with the Ext.form.action.Submit.clientValidation\noption set.
The validation message(s) to display.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 726, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-markInvalid", + "shortDoc": "Display one or more error messages associated with this field, using msgTarget to determine how to\ndisplay the messag..." + }, + { + "tagname": "method", + "name": "nextNode", + "member": "Ext.AbstractComponent", + "doc": "Returns the next node in the Component tree in tree traversal order.
\n\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will\nwalk the tree to attempt to find a match. Contrast with pnextSibling.
\n\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "Optional A ComponentQuery selector to filter the following nodes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "includeSelf", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "The next node (or the next node which matches the selector). Returns null if there is no matching node.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1845, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-nextNode", + "shortDoc": "Returns the next node in the Component tree in tree traversal order.\n\n\nNote that this is not limited to siblings, and..." + }, + { + "tagname": "method", + "name": "nextSibling", + "member": "Ext.AbstractComponent", + "doc": "Returns the next sibling of this Component.
\n\n\nOptionally selects the next sibling which matches the passed ComponentQuery selector.
\n\n\nMay also be refered to as next()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode
Optional A ComponentQuery selector to filter the following items.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1749, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-nextSibling", + "shortDoc": "Returns the next sibling of this Component.\n\n\nOptionally selects the next sibling which matches the passed ComponentQ..." + }, + { + "tagname": "method", + "name": "observe", + "member": "Ext.util.Observable", + "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe class constructor to make observable.
\n", + "optional": false + }, + { + "type": "Object", + "name": "listeners", + "doc": "An object containing a series of listeners to add. See addListener.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 69, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." + }, + { + "tagname": "method", + "name": "on", + "member": "Ext.util.Observable", + "doc": "Appends an event handler to this object (shorthand for addListener.)
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event to listen for
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 616, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Appends an event handler to this object (shorthand for addListener.)
\n" + }, + { + "tagname": "method", + "name": "previousNode", + "member": "Ext.AbstractComponent", + "doc": "Returns the previous node in the Component tree in tree traversal order.
\n\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will\nwalk the tree in reverse order to attempt to find a match. Contrast with previousSibling.
\n\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "Optional. A ComponentQuery selector to filter the preceding nodes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "includeSelf", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "The previous node (or the previous node which matches the selector). Returns null if there is no matching node.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1809, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousNode", + "shortDoc": "Returns the previous node in the Component tree in tree traversal order.\n\n\nNote that this is not limited to siblings,..." + }, + { + "tagname": "method", + "name": "previousSibling", + "member": "Ext.AbstractComponent", + "doc": "Returns the previous sibling of this Component.
\n\n\nOptionally selects the previous sibling which matches the passed ComponentQuery selector.
\n\n\nMay also be refered to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode
Optional. A ComponentQuery selector to filter the preceding items.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1779, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousSibling", + "shortDoc": "Returns the previous sibling of this Component.\n\n\nOptionally selects the previous sibling which matches the passed Co..." + }, + { + "tagname": "method", + "name": "processRawValue", + "member": "Ext.form.field.Text", + "doc": "Performs any necessary manipulation of a raw String value to prepare it for conversion\nand/or validation. For text fields this applies the configured stripCharsRe to the\nraw value.
\n", + "params": [ + { + "type": "String", + "name": "value", + "doc": "The unprocessed string value
\n", + "optional": false + } + ], + "return": { + "type": "String", + "doc": "The processed string value
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 328, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-processRawValue", + "shortDoc": "Performs any necessary manipulation of a raw String value to prepare it for conversion\nand/or validation. For text fi..." + }, + { + "tagname": "method", + "name": "rawToValue", + "member": "Ext.form.field.Base", + "doc": "Converts a raw input field value into a mixed-type value that is suitable for this particular field type.\nThis allows controlling the normalization and conversion of user-entered values into field-type-appropriate\nvalues, e.g. a Date object for Ext.form.field.Date, and is invoked by getValue.
\n\n\nIt is up to individual implementations to decide how to handle raw values that cannot be successfully\nconverted to the desired object type.
\n\n\nSee valueToRaw for the opposite conversion.
\n\n\nThe base implementation does no conversion, returning the raw value untouched.
\n\n", + "params": [ + { + "type": "Mixed", + "name": "rawValue", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "The converted value.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 498, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-rawToValue", + "shortDoc": "Converts a raw input field value into a mixed-type value that is suitable for this particular field type.\nThis allows..." + }, + { + "tagname": "method", + "name": "relayEvents", + "member": "Ext.util.Observable", + "doc": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable whose events this object is to relay.
\n", + "optional": false + }, + { + "type": "Array", + "name": "events", + "doc": "Array of event names to relay.
\n", + "optional": false + }, + { + "type": "Object", + "name": "prefix", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 520, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this.
Removes all added captures from the Observable.
\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "The Observable to release
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 46, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable.
\n" + }, + { + "tagname": "method", + "name": "removeCls", + "member": "Ext.AbstractComponent", + "doc": "Removes a CSS class from the top level element representing this component.
\n", + "params": [ + { + "type": "Object", + "name": "className", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "Returns the Component to allow method chaining.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2171, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeCls", + "shortDoc": "Removes a CSS class from the top level element representing this component.
\n" + }, + { + "tagname": "method", + "name": "removeClsWithUI", + "member": "Ext.AbstractComponent", + "doc": "Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this component.
\n", + "params": [ + { + "type": "String/Array", + "name": "cls", + "doc": "A string or an array of strings to remove to the uiCls
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1368, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI", + "shortDoc": "Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this ..." + }, + { + "tagname": "method", + "name": "removeListener", + "member": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event the handler was associated with.
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 352, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler.
\n" + }, + { + "tagname": "method", + "name": "removeManagedListener", + "member": "Ext.util.Observable", + "doc": "Removes listeners that were added by the mon method.
\n", + "params": [ + { + "type": "Observable|Element", + "name": "item", + "doc": "The item from which to remove a listener/listeners.
\n", + "optional": false + }, + { + "type": "Object|String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" + }, + { + "tagname": "method", + "name": "reset", + "member": "Ext.form.field.Text", + "doc": "Resets the current field value to the originally-loaded value and clears any validation messages.\nAlso adds emptyText and emptyCls if the\noriginal value was blank.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 378, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-reset", + "shortDoc": "Resets the current field value to the originally-loaded value and clears any validation messages.\nAlso adds emptyText..." + }, + { + "tagname": "method", + "name": "resetOriginalValue", + "member": "Ext.form.field.Field", + "doc": "Resets the field's originalValue property so it matches the current value.\nThis is called by Ext.form.Basic.setValues if the form's\ntrackResetOnLoad property is set to true.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 225, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-resetOriginalValue", + "shortDoc": "Resets the field's originalValue property so it matches the current value.\nThis is called by Ext.form.Basic.setValues..." + }, + { + "tagname": "method", + "name": "resumeEvents", + "member": "Ext.util.Observable", + "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.
Selects text in this field
\n", + "params": [ + { + "type": "Number", + "name": "start", + "doc": "(optional) The index where the selection should start (defaults to 0)
\n", + "optional": true + }, + { + "type": "Number", + "name": "end", + "doc": "(optional) The index where the selection should end (defaults to the text length)
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 604, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-selectText", + "shortDoc": "Selects text in this field
\n" + }, + { + "tagname": "method", + "name": "sequenceFx", + "member": "Ext.util.Animate", + "doc": "Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence. This is the opposite of syncFx.
\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 357, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-sequenceFx", + "shortDoc": "Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence. This is the opposite ..." + }, + { + "tagname": "method", + "name": "setActive", + "member": "Ext.util.Floating", + "doc": "This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.
\n\n\nIf a Window is superceded by another Window, deactivating it hides its shadow.
\n\n\nThis method also fires the activate or deactivate event depending on which action occurred.
\n\n", + "params": [ + { + "type": "Boolean", + "name": "active", + "doc": "True to activate the Component, false to deactivate it (defaults to false)
\n", + "optional": false + }, + { + "type": "Component", + "name": "newActive", + "doc": "The newly active Component which is taking over topmost zIndex position.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 216, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-setActive", + "shortDoc": "This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to th..." + }, + { + "tagname": "method", + "name": "setActiveError", + "member": "Ext.form.Labelable", + "doc": "Sets the active error message to the given string. This replaces the entire error message\ncontents with the given string. Also see setActiveErrors which accepts an Array of\nmessages and formats them according to the activeErrorsTpl.
\n", + "params": [ + { + "type": "String", + "name": "msg", + "doc": "The error message
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 348, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-setActiveError", + "shortDoc": "Sets the active error message to the given string. This replaces the entire error message\ncontents with the given str..." + }, + { + "tagname": "method", + "name": "setActiveErrors", + "member": "Ext.form.Labelable", + "doc": "Set the active error message to an Array of error messages. The messages are formatted into\na single message string using the activeErrorsTpl. Also see setActiveError\nwhich allows setting the entire error contents with a single string.
\n", + "params": [ + { + "type": "Array", + "name": "errors", + "doc": "The error messages
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 369, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-setActiveErrors", + "shortDoc": "Set the active error message to an Array of error messages. The messages are formatted into\na single message string u..." + }, + { + "tagname": "method", + "name": "setAutoScroll", + "member": "Ext.Component", + "doc": "Sets the overflow on the content element of the component.
\n", + "params": [ + { + "type": "Boolean", + "name": "scroll", + "doc": "True to allow the Component to auto scroll.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 359, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-setAutoScroll", + "shortDoc": "Sets the overflow on the content element of the component.
\n" + }, + { + "tagname": "method", + "name": "setDisabled", + "member": "Ext.AbstractComponent", + "doc": "Enable or disable the component.
\n", + "params": [ + { + "type": "Boolean", + "name": "disabled", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2123, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDisabled", + "shortDoc": "Enable or disable the component.
\n" + }, + { + "tagname": "method", + "name": "setDocked", + "member": "Ext.AbstractComponent", + "doc": "Sets the dock position of this component in its parent panel. Note that\nthis only has effect if this item is part of the dockedItems collection\nof a parent that has a DockLayout (note that any Panel has a DockLayout\nby default)
\n", + "params": [ + { + "type": "Object", + "name": "dock", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "layoutParent", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2646, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDocked", + "shortDoc": "Sets the dock position of this component in its parent panel. Note that\nthis only has effect if this item is part of ..." + }, + { + "tagname": "method", + "name": "setFieldDefaults", + "member": "Ext.form.Labelable", + "doc": "Applies a set of default configuration values to this Labelable instance. For each of the\nproperties in the given object, check if this component hasOwnProperty that config; if not\nthen it's inheriting a default value from its prototype and we should apply the default value.
\n", + "params": [ + { + "type": "Object", + "name": "defaults", + "doc": "The defaults to apply to the object.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 417, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-setFieldDefaults", + "shortDoc": "Applies a set of default configuration values to this Labelable instance. For each of the\nproperties in the given obj..." + }, + { + "tagname": "method", + "name": "setFieldStyle", + "member": "Ext.form.field.Base", + "doc": "Set the CSS style of the field input element.
\n", + "params": [ + { + "type": "String/Object/Function", + "name": "style", + "doc": "The style(s) to apply. Should be a valid argument to\nExt.core.Element.applyStyles.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 348, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-setFieldStyle", + "shortDoc": "Set the CSS style of the field input element.
\n" + }, + { + "tagname": "method", + "name": "setHeight", + "member": "Ext.AbstractComponent", + "doc": "Sets the height of the component. This method fires the resize event.
\n", + "params": [ + { + "type": "Number", + "name": "height", + "doc": "The new height to set. This may be one of:
this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2550, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setHeight", + "shortDoc": "Sets the height of the component. This method fires the resize event.
\n" + }, + { + "tagname": "method", + "name": "setLoading", + "member": "Ext.AbstractComponent", + "doc": "This method allows you to show or hide a LoadMask on top of this component.
\n", + "params": [ + { + "type": "Boolean/Object/String", + "name": "load", + "doc": "True to show the default LoadMask, a config object\nthat will be passed to the LoadMask constructor, or a message String to show. False to\nhide the current LoadMask.
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "targetEl", + "doc": "True to mask the targetEl of this Component instead of the this.el.\nFor example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)
\n", + "optional": false + } + ], + "return": { + "type": "Ext.LoadMask", + "doc": "The LoadMask instance that has just been shown.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2611, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setLoading", + "shortDoc": "This method allows you to show or hide a LoadMask on top of this component.
\n" + }, + { + "tagname": "method", + "name": "setPagePosition", + "member": "Ext.Component", + "doc": "Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\n", + "params": [ + { + "type": "Number", + "name": "x", + "doc": "The new x position
\n", + "optional": false + }, + { + "type": "Number", + "name": "y", + "doc": "The new y position
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "animate", + "doc": "If passed, the Component is animated into its new position. If this parameter\nis a number, it is used as the animation duration in milliseconds.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 501, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-setPagePosition", + "shortDoc": "Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the ..." + }, + { + "tagname": "method", + "name": "setPosition", + "member": "Ext.Component", + "doc": "Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires the move event.
\n", + "params": [ + { + "type": "Number", + "name": "left", + "doc": "The new left
\n", + "optional": false + }, + { + "type": "Number", + "name": "top", + "doc": "The new top
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "animate", + "doc": "If true, the Component is animated into its new position. You may also pass an animation configuration.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 417, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-setPosition", + "shortDoc": "Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires ..." + }, + { + "tagname": "method", + "name": "setRawValue", + "member": "Ext.form.field.Base", + "doc": "Sets the field's raw value directly, bypassing value conversion, change detection, and\nvalidation. To set the value with these additional inspections see setValue.
\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The value to set
\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "value The field value that is set
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 465, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-setRawValue", + "shortDoc": "Sets the field's raw value directly, bypassing value conversion, change detection, and\nvalidation. To set the value w..." + }, + { + "tagname": "method", + "name": "setReadOnly", + "member": "Ext.form.field.Base", + "doc": "Sets the read only state of this field.
\n", + "params": [ + { + "type": "Boolean", + "name": "readOnly", + "doc": "Whether the field should be read only.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 570, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-setReadOnly", + "shortDoc": "Sets the read only state of this field.
\n" + }, + { + "tagname": "method", + "name": "setSize", + "member": "Ext.AbstractComponent", + "doc": "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}.
The new width to set. This may be one of:
{width: widthValue, height: heightValue}.undefined to leave the width unchanged.The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
undefined to leave the height unchanged.this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2340, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setSize", + "shortDoc": "Sets the width and height of this Component. This method fires the resize event. This method can accept\neither width ..." + }, + { + "tagname": "method", + "name": "setUI", + "member": "Ext.AbstractComponent", + "doc": "Sets the UI for the component. This will remove any existing UIs on the component. It will also\nloop through any uiCls set on the component and rename them so they include the new UI
\n", + "params": [ + { + "type": "String", + "name": "ui", + "doc": "The new UI for the component
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1309, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setUI", + "shortDoc": "Sets the UI for the component. This will remove any existing UIs on the component. It will also\nloop through any uiCl..." + }, + { + "tagname": "method", + "name": "setValue", + "member": "Ext.form.field.Text", + "doc": "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.
\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The value to set
\n", + "optional": false + } + ], + "return": { + "type": "Ext.form.field.Text", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 479, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-method-setValue", + "shortDoc": "Sets a data value into the field and runs the change detection and validation. Also applies any configured\nemptyText ..." + }, + { + "tagname": "method", + "name": "setVisible", + "member": "Ext.AbstractComponent", + "doc": "Convenience function to hide or show this component by boolean.
\n", + "params": [ + { + "type": "Boolean", + "name": "visible", + "doc": "True to show, false to hide
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2006, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setVisible", + "shortDoc": "Convenience function to hide or show this component by boolean.
\n" + }, + { + "tagname": "method", + "name": "setWidth", + "member": "Ext.AbstractComponent", + "doc": "Sets the width of the component. This method fires the resize event.
\n", + "params": [ + { + "type": "Number", + "name": "width", + "doc": "The new width to setThis may be one of:
this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2538, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setWidth", + "shortDoc": "Sets the width of the component. This method fires the resize event.
\n" + }, + { + "tagname": "method", + "name": "show", + "member": "Ext.Component", + "doc": "Shows this Component, rendering it first if autoRender or {"floating are true.
After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of\nits z-index stack.
\n\n", + "params": [ + { + "type": "String/Element", + "name": "animateTarget", + "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should\nanimate from while opening (defaults to null with no animation)
(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.
\n", + "optional": true + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 645, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-show", + "shortDoc": "Shows this Component, rendering it first if autoRender or {"floating are true.\n\n\nAfter being shown, a floating C..." + }, + { + "tagname": "method", + "name": "stopAnimation", + "member": "Ext.util.Animate", + "doc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", + "params": [ + + ], + "return": { + "type": "Ext.core.Element", + "doc": "The Element
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 335, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-stopAnimation", + "shortDoc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ..." + }, + { + "tagname": "method", + "name": "stopFx", + "member": "Ext.util.Animate", + "doc": "@deprecated 4.0 Replaced by stopAnimation\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", + "params": [ + + ], + "return": { + "type": "Ext.core.Element", + "doc": "The Element
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 326, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-stopFx", + "shortDoc": "@deprecated 4.0 Replaced by stopAnimation\nStops any running effects and clears this object's internal effects queue i..." + }, + { + "tagname": "method", + "name": "suspendEvents", + "member": "Ext.util.Observable", + "doc": "Suspend the firing of all events. (see resumeEvents)
\n", + "params": [ + { + "type": "Boolean", + "name": "queueSuspended", + "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 490, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspend the firing of all events. (see resumeEvents)
\n" + }, + { + "tagname": "method", + "name": "syncFx", + "member": "Ext.util.Animate", + "doc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\n", + "params": [ + + ], + "return": { + "type": "Object", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", + "linenr": 345, + "html_filename": "Animate.html", + "href": "Animate.html#Ext-util-Animate-method-syncFx", + "shortDoc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of ..." + }, + { + "tagname": "method", + "name": "toBack", + "member": "Ext.util.Floating", + "doc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n", + "params": [ + + ], + "return": { + "type": "Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 240, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-toBack", + "shortDoc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n" + }, + { + "tagname": "method", + "name": "toFront", + "member": "Ext.util.Floating", + "doc": "Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager
\n\n\nIf this Component is modal, inserts the modal mask just below this Component in the z-index stack.
\n\n", + "params": [ + { + "type": "Boolean", + "name": "preventFocus", + "doc": "(optional) Specify true to prevent the Component from being focused.
this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 188, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-toFront", + "shortDoc": "Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag..." + }, + { + "tagname": "method", + "name": "un", + "member": "Ext.util.Observable", + "doc": "Removes an event handler (shorthand for removeListener.)
\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "The type of event the handler was associated with.
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 608, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Removes an event handler (shorthand for removeListener.)
\n" + }, + { + "tagname": "method", + "name": "unsetActiveError", + "member": "Ext.form.Labelable", + "doc": "Clears the active error.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 381, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-unsetActiveError", + "shortDoc": "Clears the active error.
\n" + }, + { + "tagname": "method", + "name": "up", + "member": "Ext.AbstractComponent", + "doc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector.
Example:\n
var owningTabPanel = grid.up('tabpanel');\nOptional. The simple selector to test.
\n", + "optional": false + } + ], + "return": { + "type": "Container", + "doc": "The matching ancestor Container (or undefined if no match was found).
Update the content area of a component.
\n", + "params": [ + { + "type": "Mixed", + "name": "htmlOrData", + "doc": "If this component has been configured with a template via the tpl config\nthen it will use this argument as data to populate the template.\nIf this component was not configured with a template, the components\ncontent area will be updated via Ext.core.Element update
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "loadScripts", + "doc": "(optional) Only legitimate when using the html configuration. Defaults to false
\n", + "optional": true + }, + { + "type": "Function", + "name": "callback", + "doc": "(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1974, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-update", + "shortDoc": "Update the content area of a component.
\n" + }, + { + "tagname": "method", + "name": "updateBox", + "member": "Ext.Component", + "doc": "Sets the current box measurements of the component's underlying element.
\n", + "params": [ + { + "type": "Object", + "name": "box", + "doc": "An object in the format {x, y, width, height}
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 551, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-updateBox", + "shortDoc": "Sets the current box measurements of the component's underlying element.
\n" + }, + { + "tagname": "method", + "name": "validate", + "member": "Ext.form.field.Field", + "doc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the validitychange event if the field's validity has\nchanged since the last validation. Note: disabled fields are always treated as valid.
\n\n\nCustom implementations of this method are allowed to have side-effects such as triggering error\nmessage display. To validate without side-effects, use isValid.
\n\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the value is valid, else false
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 330, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-method-validate", + "shortDoc": "Returns whether or not the field value is currently valid by validating the\nfield's current value, and fires the vali..." + }, + { + "tagname": "method", + "name": "validateValue", + "member": "Ext.form.field.Base", + "doc": "Uses getErrors to build an array of validation errors. If any errors are found, they are passed\nto markInvalid and false is returned, otherwise true is returned.
\n\n\nPreviously, subclasses were invited to provide an implementation of this to process validations - from 3.2\nonwards getErrors should be overridden instead.
\n\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The value to validate
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "True if all validations passed, false if one or more failed
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 703, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-validateValue", + "shortDoc": "Uses getErrors to build an array of validation errors. If any errors are found, they are passed\nto markInvalid and fa..." + }, + { + "tagname": "method", + "name": "valueToRaw", + "member": "Ext.form.field.Base", + "doc": "Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows\ncontrolling how value objects passed to setValue are shown to the user, including localization.\nFor instance, for a Ext.form.field.Date, this would control how a Date object passed to setValue\nwould be converted to a String for display in the field.
\n\n\nSee rawToValue for the opposite conversion.
\n\n\nThe base implementation simply does a standard toString conversion, and converts\nempty values to an empty string.
\n\n", + "params": [ + { + "type": "Mixed", + "name": "value", + "doc": "The mixed-type value to convert to the raw representation.
\n", + "optional": false + } + ], + "return": { + "type": "Mixed", + "doc": "The converted raw value.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 483, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-method-valueToRaw", + "shortDoc": "Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows\ncontrolling how..." + } + ], + "property": [ + { + "tagname": "property", + "name": "bodyEl", + "member": "Ext.form.Labelable", + "type": "Ext.core.Element", + "doc": "The div Element wrapping the component's contents. Only available after the component has been rendered.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 293, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-property-bodyEl" + }, + { + "tagname": "property", + "name": "draggable", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "Read-only property indicating whether or not the component can be dragged
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 374, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-draggable" + }, + { + "tagname": "property", + "name": "errorEl", + "member": "Ext.form.Labelable", + "type": "Ext.core.Element", + "doc": "The div Element that will contain the component's error message(s). Note that depending on the\nconfigured msgTarget, this element may be hidden in favor of some other form of\npresentation, but will always be present in the DOM for use by assistive technologies.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 300, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-property-errorEl", + "shortDoc": "The div Element that will contain the component's error message(s). Note that depending on the\nconfigured msgTarget, ..." + }, + { + "tagname": "property", + "name": "floatParent", + "member": "Ext.Component", + "type": "Ext.Container", + "doc": "Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
\n\n\nFloating Components that are programatically rendered will not have a floatParent property.
For floating Components which are child items of a Container, the floatParent will be the floating ancestor Container which is\nresponsible for the base z-index value of all its floating descendants. It provides a ZIndexManager which provides\nz-indexing services for all its descendant floating Components.
\n\n\nFor example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its\nfloatParent
See floating and zIndexManager
\n\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 221, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-property-floatParent", + "shortDoc": "Optional. Only present for floating Components which were inserted as descendant items of floating Containers.\n\n\nFloa..." + }, + { + "tagname": "property", + "name": "frameSize", + "member": "Ext.AbstractComponent", + "type": "Object", + "doc": "Read-only property indicating the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.
\n\n\nThis is an object containing the frame width in pixels for all four sides of the Component containing\nthe following properties:
\n\n\ntop The width of the top framing element in pixels.right The width of the right framing element in pixels.bottom The width of the bottom framing element in pixels.left The width of the left framing element in pixels.The input Element for this Field. Only available after the field has been rendered.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 371, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-property-inputEl" + }, + { + "tagname": "property", + "name": "isFieldLabelable", + "member": "Ext.form.Labelable", + "type": "Boolean", + "doc": "Flag denoting that this object is labelable as a field. Always true.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 61, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-property-isFieldLabelable" + }, + { + "tagname": "property", + "name": "isFormField", + "member": "Ext.form.field.Field", + "type": "Boolean", + "doc": "Flag denoting that this component is a Field. Always true.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 26, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-property-isFormField" + }, + { + "tagname": "property", + "name": "labelEl", + "member": "Ext.form.Labelable", + "type": "Ext.core.Element", + "doc": "The label Element for this component. Only available after the component has been rendered.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 286, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-property-labelEl" + }, + { + "tagname": "property", + "name": "maskOnDisable", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "This is an internal flag that you use when creating custom components.\nBy default this is set to true which means that every component gets a mask when its disabled.\nComponents like FieldContainer, FieldSet, Field, Button, Tab override this property to false\nsince they want to implement custom disable logic.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 513, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable", + "shortDoc": "This is an internal flag that you use when creating custom components.\nBy default this is set to true which means tha..." + }, + { + "tagname": "property", + "name": "originalValue", + "member": "Ext.form.field.Field", + "type": "Mixed", + "doc": "The original value of the field as configured in the value configuration, or as loaded by\nthe last form load operation if the form's trackResetOnLoad\nsetting is true.
This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a Container). Read-only.
\n\nNote: to access items within the Container see itemId.
\n\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 101, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-ownerCt", + "shortDoc": "This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a C..." + }, + { + "tagname": "property", + "name": "rendered", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "Read-only property indicating whether or not the component has been rendered.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 500, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-rendered" + }, + { + "tagname": "property", + "name": "zIndexManager", + "member": "Ext.Component", + "type": "Ext.ZIndexManager", + "doc": "Optional. Only present for floating Components after they have been rendered.
\n\n\nA reference to the ZIndexManager which is managing this Component's z-index.
\n\n\nThe ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal\nmask which is insert just beneath the topmost visible modal floating Component.
\n\n\nFloating Components may be brought to the front or sent to the back of the z-index stack.
\n\n\nThis defaults to the global ZIndexManager for floating Components that are programatically\nrendered.
\n\n\nFor floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found\nwhich is floating, or if not found the global ZIndexManager is used.
\n\n\nSee floating and floatParent
\n\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 206, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-property-zIndexManager", + "shortDoc": "Optional. Only present for floating Components after they have been rendered.\n\n\nA reference to the ZIndexManager whic..." + } + ], + "event": [ + { + "tagname": "event", + "name": "activate", + "member": "Ext.AbstractComponent", + "doc": "Fires after a Component has been visually activated.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 540, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-activate", + "shortDoc": "Fires after a Component has been visually activated.
\n" + }, + { + "tagname": "event", + "name": "added", + "member": "Ext.AbstractComponent", + "doc": "Fires after a Component had been added to a Container.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.container.Container", + "name": "container", + "doc": "Parent Container
\n", + "optional": false + }, + { + "type": "Number", + "name": "pos", + "doc": "position of Component
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 560, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-added", + "shortDoc": "Fires after a Component had been added to a Container.
\n" + }, + { + "tagname": "event", + "name": "afterrender", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component rendering is finished.
\n\n\nThe afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component.
\n\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 627, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-afterrender", + "shortDoc": "Fires after the component rendering is finished.\n\n\nThe afterrender event is fired after this Component has been rende..." + }, + { + "tagname": "event", + "name": "autosize", + "member": "Ext.form.field.Text", + "doc": "Fires when the autoSize function is triggered and the field is\nresized according to the grow/growMin/growMax configs as a result.\nThis event provides a hook for the developer to apply additional logic at runtime to resize the\nfield if needed.
\n", + "params": [ + { + "type": "Ext.form.field.Text", + "name": "this", + "doc": "This text field
\n", + "optional": false + }, + { + "type": "Number", + "name": "width", + "doc": "The new field width
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 234, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-event-autosize", + "shortDoc": "Fires when the autoSize function is triggered and the field is\nresized according to the grow/growMin/growMax configs ..." + }, + { + "tagname": "event", + "name": "beforeactivate", + "member": "Ext.AbstractComponent", + "doc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate\nfrom occurring.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 532, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate", + "shortDoc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate..." + }, + { + "tagname": "event", + "name": "beforedeactivate", + "member": "Ext.AbstractComponent", + "doc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deactivate\nfrom occurring.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 546, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate", + "shortDoc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deacti..." + }, + { + "tagname": "event", + "name": "beforedestroy", + "member": "Ext.AbstractComponent", + "doc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 635, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy", + "shortDoc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n" + }, + { + "tagname": "event", + "name": "beforehide", + "member": "Ext.AbstractComponent", + "doc": "Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 593, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforehide", + "shortDoc": "Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.
\n" + }, + { + "tagname": "event", + "name": "beforerender", + "member": "Ext.AbstractComponent", + "doc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 614, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforerender", + "shortDoc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n" + }, + { + "tagname": "event", + "name": "beforeshow", + "member": "Ext.AbstractComponent", + "doc": "Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 580, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeshow", + "shortDoc": "Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.
\n" + }, + { + "tagname": "event", + "name": "beforestaterestore", + "member": "Ext.state.Stateful", + "doc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n", + "params": [ + { + "type": "Ext.state.Stateful", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "state", + "doc": "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", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 101, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-event-beforestaterestore", + "shortDoc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n" + }, + { + "tagname": "event", + "name": "beforestatesave", + "member": "Ext.state.Stateful", + "doc": "Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\n", + "params": [ + { + "type": "Ext.state.Stateful", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "state", + "doc": "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", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 122, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-event-beforestatesave", + "shortDoc": "Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\n" + }, + { + "tagname": "event", + "name": "blur", + "member": "Ext.form.field.Base", + "doc": "Fires when this field loses input focus.
\n", + "params": [ + { + "type": "Ext.form.field.Base", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 246, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-event-blur", + "shortDoc": "Fires when this field loses input focus.
\n" + }, + { + "tagname": "event", + "name": "change", + "member": "Ext.form.field.Field", + "doc": "Fires when a user-initiated change is detected in the value of the field.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Mixed", + "name": "newValue", + "doc": "The new value
\n", + "optional": false + }, + { + "type": "Mixed", + "name": "oldValue", + "doc": "The original value
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 79, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-change", + "shortDoc": "Fires when a user-initiated change is detected in the value of the field.
\n" + }, + { + "tagname": "event", + "name": "deactivate", + "member": "Ext.AbstractComponent", + "doc": "Fires after a Component has been visually deactivated.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 554, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-deactivate", + "shortDoc": "Fires after a Component has been visually deactivated.
\n" + }, + { + "tagname": "event", + "name": "destroy", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is destroyed.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 641, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-destroy", + "shortDoc": "Fires after the component is destroyed.
\n" + }, + { + "tagname": "event", + "name": "dirtychange", + "member": "Ext.form.field.Field", + "doc": "Fires when a change in the field's isDirty state is detected.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isDirty", + "doc": "Whether or not the field is now dirty
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 94, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-dirtychange", + "shortDoc": "Fires when a change in the field's isDirty state is detected.
\n" + }, + { + "tagname": "event", + "name": "disable", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is disabled.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 568, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-disable", + "shortDoc": "Fires after the component is disabled.
\n" + }, + { + "tagname": "event", + "name": "enable", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is enabled.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 574, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-enable", + "shortDoc": "Fires after the component is enabled.
\n" + }, + { + "tagname": "event", + "name": "errorchange", + "member": "Ext.form.Labelable", + "doc": "Fires when the active error message is changed via setActiveError.
\n", + "params": [ + { + "type": "Ext.form.Labelable", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "String", + "name": "error", + "doc": "The active error message
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 222, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-event-errorchange", + "shortDoc": "Fires when the active error message is changed via setActiveError.
\n" + }, + { + "tagname": "event", + "name": "focus", + "member": "Ext.form.field.Base", + "doc": "Fires when this field receives input focus.
\n", + "params": [ + { + "type": "Ext.form.field.Base", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 240, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-event-focus", + "shortDoc": "Fires when this field receives input focus.
\n" + }, + { + "tagname": "event", + "name": "hide", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 600, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-hide", + "shortDoc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n" + }, + { + "tagname": "event", + "name": "keydown", + "member": "Ext.form.field.Text", + "doc": "Keydown input field event. This event only fires if enableKeyEvents\nis set to true.
\n", + "params": [ + { + "type": "Ext.form.field.Text", + "name": "this", + "doc": "This text field
\n", + "optional": false + }, + { + "type": "Ext.EventObject", + "name": "e", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 245, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-event-keydown", + "shortDoc": "Keydown input field event. This event only fires if enableKeyEvents\nis set to true.
\n" + }, + { + "tagname": "event", + "name": "keypress", + "member": "Ext.form.field.Text", + "doc": "Keypress input field event. This event only fires if enableKeyEvents\nis set to true.
\n", + "params": [ + { + "type": "Ext.form.field.Text", + "name": "this", + "doc": "This text field
\n", + "optional": false + }, + { + "type": "Ext.EventObject", + "name": "e", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 261, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-event-keypress", + "shortDoc": "Keypress input field event. This event only fires if enableKeyEvents\nis set to true.
\n" + }, + { + "tagname": "event", + "name": "keyup", + "member": "Ext.form.field.Text", + "doc": "Keyup input field event. This event only fires if enableKeyEvents\nis set to true.
\n", + "params": [ + { + "type": "Ext.form.field.Text", + "name": "this", + "doc": "This text field
\n", + "optional": false + }, + { + "type": "Ext.EventObject", + "name": "e", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 253, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text-event-keyup", + "shortDoc": "Keyup input field event. This event only fires if enableKeyEvents\nis set to true.
\n" + }, + { + "tagname": "event", + "name": "move", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is moved.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Number", + "name": "x", + "doc": "The new x position
\n", + "optional": false + }, + { + "type": "Number", + "name": "y", + "doc": "The new y position
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 655, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-move", + "shortDoc": "Fires after the component is moved.
\n" + }, + { + "tagname": "event", + "name": "removed", + "member": "Ext.AbstractComponent", + "doc": "Fires when a component is removed from an Ext.container.Container
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.container.Container", + "name": "ownerCt", + "doc": "Container which holds the component
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 607, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-removed", + "shortDoc": "Fires when a component is removed from an Ext.container.Container
\n" + }, + { + "tagname": "event", + "name": "render", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component markup is rendered.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 621, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-render", + "shortDoc": "Fires after the component markup is rendered.
\n" + }, + { + "tagname": "event", + "name": "resize", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is resized.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Number", + "name": "adjWidth", + "doc": "The box-adjusted width that was set
\n", + "optional": false + }, + { + "type": "Number", + "name": "adjHeight", + "doc": "The box-adjusted height that was set
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 647, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-resize", + "shortDoc": "Fires after the component is resized.
\n" + }, + { + "tagname": "event", + "name": "show", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is shown when calling the show method.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 587, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-show", + "shortDoc": "Fires after the component is shown when calling the show method.
\n" + }, + { + "tagname": "event", + "name": "specialkey", + "member": "Ext.form.field.Base", + "doc": "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.\nTo handle other keys see Ext.panel.Panel.keys or Ext.util.KeyMap.\nYou can check Ext.EventObject.getKey to determine which key was pressed.\nFor example:
\n\nvar 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});\nThe event object
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Base.js", + "linenr": 252, + "html_filename": "Base.html", + "href": "Base.html#Ext-form-field-Base-event-specialkey", + "shortDoc": "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.\nTo handle other keys see Ext.pan..." + }, + { + "tagname": "event", + "name": "staterestore", + "member": "Ext.state.Stateful", + "doc": "Fires after the state of the object is restored.
\n", + "params": [ + { + "type": "Ext.state.Stateful", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "state", + "doc": "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", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 112, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-event-staterestore", + "shortDoc": "Fires after the state of the object is restored.
\n" + }, + { + "tagname": "event", + "name": "statesave", + "member": "Ext.state.Stateful", + "doc": "Fires after the state of the object is saved to the configured state provider.
\n", + "params": [ + { + "type": "Ext.state.Stateful", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "state", + "doc": "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", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 133, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-event-statesave", + "shortDoc": "Fires after the state of the object is saved to the configured state provider.
\n" + }, + { + "tagname": "event", + "name": "validitychange", + "member": "Ext.form.field.Field", + "doc": "Fires when a change in the field's validity is detected.
\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isValid", + "doc": "Whether or not the field is now valid
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Field.js", + "linenr": 87, + "html_filename": "Field.html", + "href": "Field.html#Ext-form-field-Field-event-validitychange", + "shortDoc": "Fires when a change in the field's validity is detected.
\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/field/Text.js", + "linenr": 1, + "html_filename": "Text.html", + "href": "Text.html#Ext-form-field-Text", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": true, + "superclasses": [ + "Ext.AbstractComponent", + "Ext.Component", + "Ext.form.field.Base" + ], + "subclasses": [ + "Ext.form.field.File", + "Ext.form.field.TextArea", + "Ext.form.field.Trigger" + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.form.Labelable", + "Ext.form.field.Field", + "Ext.util.Floating", + "Ext.util.Observable", + "Ext.util.Animate", + "Ext.state.Stateful" + ] +}); \ No newline at end of file