A mixin which allows a component to be configured and decorated with a label and/or error message as is\ncommon for form fields. This is used by e.g. Ext.form.field.Base and Ext.form.FieldContainer\nto let them be managed by the Field layout.
\n\n*NOTE**: This mixin is mainly for internal library use and most users should not need to use it directly. It\nis more likely you will want to use one of the component classes that import this mixin, such as\nExt.form.field.Base or Ext.form.FieldContainer.
\n\nUse of this mixin does not make a component a field in the logical sense, meaning it does not provide any\nlogic or state related to values or validation; that is handled by the related Ext.form.field.Field\nmixin. These two mixins may be used separately (for example Ext.form.FieldContainer is Labelable but not a\nField), or in combination (for example Ext.form.field.Base implements both and has logic for connecting the\ntwo.)
\n\nComponent classes which use this mixin should use the Field layout\nor a derivation thereof to properly size and position the label and message according to the component config.\nThey must also call the initLabelable method during component initialization to ensure the mixin gets\nset up correctly.
\n", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": "Jason JohnstonIf 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": "autoFitErrors", + "member": "Ext.form.Labelable", + "type": "Boolean", + "doc": "Whether 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": "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": "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": "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": "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": "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": "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": "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": "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": "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.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" + } + ], + "method": [ + { + "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": "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": "getInputId", + "member": "Ext.form.Labelable", + "doc": "Get the input id, if any, for this component. This is used as the \"for\" attribute on the label element.\nImplementing subclasses may also use this as e.g. the id for their own input element.
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The input id
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 321, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable-method-getInputId", + "shortDoc": "Get the input id, if any, for this component. This is used as the \"for\" attribute on the label element.\nImplementing ..." + }, + { + "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": "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": "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": "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": "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" + } + ], + "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": "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": "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": "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" + } + ], + "event": [ + { + "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" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/form/Labelable.js", + "linenr": 1, + "html_filename": "Labelable.html", + "href": "Labelable.html#Ext-form-Labelable", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + "Ext.form.field.Base", + "Ext.form.field.HtmlEditor", + "Ext.form.FieldContainer" + ], + "allMixins": [ + + ] +}); \ No newline at end of file