- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "activeError",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>If specified, then the component will be displayed with this value as its active error when\nfirst rendered. Defaults to undefined. Use <a href=\"#/api/Ext.form.Labelable-method-setActiveError\" rel=\"Ext.form.Labelable-method-setActiveError\" class=\"docClass\">setActiveError</a> or <a href=\"#/api/Ext.form.Labelable-method-unsetActiveError\" rel=\"Ext.form.Labelable-method-unsetActiveError\" class=\"docClass\">unsetActiveError</a> to\nchange it after component creation.</p>\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": "<p>The template used to format the Array of error messages passed to <a href=\"#/api/Ext.form.Labelable-method-setActiveErrors\" rel=\"Ext.form.Labelable-method-setActiveErrors\" class=\"docClass\">setActiveErrors</a>\ninto a single HTML string. By default this renders each message as an item in an unordered list.</p>\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": "autoFitErrors",
- "member": "Ext.form.Labelable",
- "type": "Boolean",
- "doc": "<p>Whether to adjust the component's body area to make room for 'side' or 'under'\n<a href=\"#/api/Ext.form.Labelable-cfg-msgTarget\" rel=\"Ext.form.Labelable-cfg-msgTarget\" class=\"docClass\">error messages</a>. Defaults to <tt>true</tt>.</p>\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": "baseBodyCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.</p>\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": "clearCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The CSS class to be applied to the special clearing div rendered directly after the field\ncontents wrapper to provide field clearing (defaults to <tt>'x-clear'</tt>).</p>\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": "errorMsgCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.</p>\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": "<p>An extra CSS class to be applied to the body content element in addition to <a href=\"#/api/Ext.form.Labelable-cfg-fieldBodyCls\" rel=\"Ext.form.Labelable-cfg-fieldBodyCls\" class=\"docClass\">fieldBodyCls</a>.\nDefaults to empty.</p>\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": "fieldLabel",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The label for the field. It gets appended with the <a href=\"#/api/Ext.form.Labelable-cfg-labelSeparator\" rel=\"Ext.form.Labelable-cfg-labelSeparator\" class=\"docClass\">labelSeparator</a>, and its position\nand sizing is determined by the <a href=\"#/api/Ext.form.Labelable-cfg-labelAlign\" rel=\"Ext.form.Labelable-cfg-labelAlign\" class=\"docClass\">labelAlign</a>, <a href=\"#/api/Ext.form.Labelable-cfg-labelWidth\" rel=\"Ext.form.Labelable-cfg-labelWidth\" class=\"docClass\">labelWidth</a>, and <a href=\"#/api/Ext.form.Labelable-cfg-labelPad\" rel=\"Ext.form.Labelable-cfg-labelPad\" class=\"docClass\">labelPad</a>\nconfigs. Defaults to undefined.</p>\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": "formItemCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>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'.</p>\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": "hideEmptyLabel",
- "member": "Ext.form.Labelable",
- "type": "Boolean",
- "doc": "<p>When set to <tt>true</tt>, the label element (<a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a> and <a href=\"#/api/Ext.form.Labelable-cfg-labelSeparator\" rel=\"Ext.form.Labelable-cfg-labelSeparator\" class=\"docClass\">labelSeparator</a>) will be\nautomatically hidden if the <a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a> is empty. Setting this to <tt>false</tt> 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 <tt>true</tt>.</p>\n\n\n<p>If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set\nthe <a href=\"#/api/Ext.form.Labelable-cfg-hideLabel\" rel=\"Ext.form.Labelable-cfg-hideLabel\" class=\"docClass\">hideLabel</a> config to <tt>true</tt>.</p>\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": "<p>Set to <tt>true</tt> to completely hide the label element (<a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a> and <a href=\"#/api/Ext.form.Labelable-cfg-labelSeparator\" rel=\"Ext.form.Labelable-cfg-labelSeparator\" class=\"docClass\">labelSeparator</a>).\nDefaults to <tt>false</tt>.</p>\n\n\n<p>Also see <a href=\"#/api/Ext.form.Labelable-cfg-hideEmptyLabel\" rel=\"Ext.form.Labelable-cfg-hideEmptyLabel\" class=\"docClass\">hideEmptyLabel</a>, which controls whether space will be reserved for an empty fieldLabel.</p>\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": "invalidCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')</p>\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": "labelAlign",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>Controls the position and alignment of the <a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a>. Valid values are:</p>\n\n\n<ul>\n<li><tt>\"left\"</tt> (the default) - The label is positioned to the left of the field, with its text\naligned to the left. Its width is determined by the <a href=\"#/api/Ext.form.Labelable-cfg-labelWidth\" rel=\"Ext.form.Labelable-cfg-labelWidth\" class=\"docClass\">labelWidth</a> config.</li>\n<li><tt>\"top\"</tt> - The label is positioned above the field.</li>\n<li><tt>\"right\"</tt> - The label is positioned to the left of the field, with its text aligned\nto the right. Its width is determined by the <a href=\"#/api/Ext.form.Labelable-cfg-labelWidth\" rel=\"Ext.form.Labelable-cfg-labelWidth\" class=\"docClass\">labelWidth</a> config.</li>\n</ul>\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js",
- "linenr": 121,
- "html_filename": "Labelable.html",
- "href": "Labelable.html#Ext-form-Labelable-cfg-labelAlign",
- "shortDoc": "Controls the position and alignment of the fieldLabel. Valid values are:\n\n\n\n\"left\" (the default) - The label is posit..."
- },
- {
- "tagname": "cfg",
- "name": "labelCls",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.</p>\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": "<p>The amount of space in pixels between the <a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a> and the input field. Defaults to <tt>5</tt>.</p>\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": "<p>Character(s) to be inserted at the end of the <a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">label text</a>.</p>\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": "<p>A CSS style specification string to apply directly to this field's label. Defaults to undefined.</p>\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": "<p>The width of the <a href=\"#/api/Ext.form.Labelable-cfg-fieldLabel\" rel=\"Ext.form.Labelable-cfg-fieldLabel\" class=\"docClass\">fieldLabel</a> in pixels. Only applicable if the <a href=\"#/api/Ext.form.Labelable-cfg-labelAlign\" rel=\"Ext.form.Labelable-cfg-labelAlign\" class=\"docClass\">labelAlign</a> is set\nto \"left\" or \"right\". Defaults to <tt>100</tt>.</p>\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": "<p>The rendering template for the field decorations. Component classes using this mixin should include\nlogic to use this as their <a href=\"#/api/Ext.AbstractComponent-cfg-renderTpl\" rel=\"Ext.AbstractComponent-cfg-renderTpl\" class=\"docClass\">renderTpl</a>, and implement the\n<a href=\"#/api/Ext.form.Labelable--getSubTplMarkup\" rel=\"Ext.form.Labelable--getSubTplMarkup\" class=\"docClass\">getSubTplMarkup</a> method to generate the field body content.</p>\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": "msgTarget",
- "member": "Ext.form.Labelable",
- "type": "String",
- "doc": "<p>The location where the error message text should display.\nMust be one of the following values:</p>\n\n\n<div class=\"mdetail-params\"><ul>\n<li><code>qtip</code> Display a quick tip containing the message when the user hovers over the field. This is the default.\n<div class=\"subdesc\"><b><a href=\"#/api/Ext.tip.QuickTipManager-method-init\" rel=\"Ext.tip.QuickTipManager-method-init\" class=\"docClass\">Ext.tip.QuickTipManager.init</a> must have been called for this setting to work.</b></div></li>\n<li><code>title</code> Display the message in a default browser title attribute popup.</li>\n<li><code>under</code> Add a block div beneath the field containing the error message.</li>\n<li><code>side</code> Add an error icon to the right of the field, displaying the message in a popup on hover.</li>\n<li><code>none</code> Don't display any error message. This might be useful if you are implementing custom error display.</li>\n<li><code>[element id]</code> Add the error message directly to the innerHTML of the specified element.</li>\n</ul></div>\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js",
- "linenr": 191,
- "html_filename": "Labelable.html",
- "href": "Labelable.html#Ext-form-Labelable-cfg-msgTarget",
- "shortDoc": "The location where the error message text should display.\nMust be one of the following values:\n\n\n\nqtip Display a quic..."
- },
- {
- "tagname": "cfg",
- "name": "preventMark",
- "member": "Ext.form.Labelable",
- "type": "Boolean",
- "doc": "<p><tt>true</tt> to disable displaying any <a href=\"#/api/Ext.form.Labelable-method-setActiveError\" rel=\"Ext.form.Labelable-method-setActiveError\" class=\"docClass\">error message</a> set on this object.\nDefaults to <tt>false</tt>.</p>\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"
- }
- ],
- "method": [
- {
- "tagname": "method",
- "name": "getActiveError",
- "member": "Ext.form.Labelable",
- "doc": "<p>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.</p>\n",
- "params": [
-
- ],
- "return": {