Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.5.2 - Classic Toolkit


top

Ext.form.Labelable

Hierarchy

Ext.Base
Ext.Mixin
Ext.form.Labelable

Requires

Ext.XTemplate
Ext.overrides.dom.Element

Summary

A mixin which allows a component to be configured and decorated with a label and/or error message as is common for form fields. This is used by e.g. Ext.form.field.Base and Ext.form.FieldContainer to let them be managed by the Field layout.

NOTE: This mixin is mainly for internal library use and most users should not need to use it directly. It is more likely you will want to use one of the component classes that import this mixin, such as Ext.form.field.Base or Ext.form.FieldContainer.

Use of this mixin does not make a component a field in the logical sense, meaning it does not provide any logic or state related to values or validation; that is handled by the related Ext.form.field.Field mixin. These two mixins may be used separately (for example Ext.form.FieldContainer is Labelable but not a Field), or in combination (for example Ext.form.field.Base implements both and has logic for connecting the two.)

Component classes which use this mixin should use the Field layout or a derivation thereof to properly size and position the label and message according to the component config. They must also call the initLabelable method during component initialization to ensure the mixin gets set up correctly.

No members found using the current filters

configs

Optional Configs

activeError : String

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

getActiveError String

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.

Returns

:String

The active error message on the component; if there is no error, an empty string is returned.

setActiveError ( msg )

Sets the active error message to the given string. This replaces the entire error message contents with the given string. Also see setActiveErrors which accepts an Array of messages and formats them according to the activeErrorsTpl. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters

msg :  String

The error message

activeErrorsTpl : String / String[] / Ext.XTemplate

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. if the msgTarget is title, it defaults to a list separated by new lines. Otherwise, it renders each message as an item in an unordered list.

Defaults to:

undefined

afterBodyEl : String / Array / Ext.XTemplate

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

afterLabelTextTpl : String / Array / Ext.XTemplate

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

afterLabelTpl : String / Array / Ext.XTemplate

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

afterSubTpl : String / Array / Ext.XTemplate

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

ariaErrorText : String

Localized announcement text for validation errors. This text will be used by Assistive Technologies such as screen readers to alert the users when field validation fails.

This config is used with Ext.String#format. '{0}' will be replaced with the actual error message(s), '{1}' will be replaced with field label.

Defaults to:

'Input error. {0}.'

ariaHelp : String

Optional text description for this object. This text will be announced to Assistive Technology users when the object is focused.

Defaults to:

undefined

autoFitErrors : Boolean

Whether to adjust the component's body width to make room for 'side' error messages.

Defaults to:

true

baseBodyCls : String

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

Defaults to:

Ext.baseCSSPrefix + 'form-item-body'

beforeBodyEl : String / Array / Ext.XTemplate

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

beforeLabelTextTpl : String / Array / Ext.XTemplate

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

beforeLabelTpl : String / Array / Ext.XTemplate

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

beforeSubTpl : String / Array / Ext.XTemplate

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

errorMsgCls : String

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

Defaults to:

Ext.baseCSSPrefix + 'form-error-msg'

fieldBodyCls : String

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

Defaults to:

''

fieldLabel : String

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

Defaults to:

undefined

getFieldLabel String
template tpl

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

Returns

:String

The configured field label, or empty string if not defined

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

setFieldLabel ( label )

Set the label of this field.

Parameters

label :  String

The new label. The labelSeparator will be automatically appended to the label string.

formItemCls : String

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

Defaults to:

Ext.baseCSSPrefix + 'form-item'

hideEmptyLabel : Boolean

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

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

Defaults to:

true

hideLabel : Boolean

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

Defaults to:

false

invalidCls : String

The CSS class to use when marking the component invalid.

Defaults to:

Ext.baseCSSPrefix + 'form-invalid'

labelableRenderTpl : String / String[] / Ext.XTemplate
private pri

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

Defaults to:

[
    '{beforeLabelTpl}',
    '<label id="{id}-labelEl" data-ref="labelEl" class="{labelCls} {labelCls}-{ui} {labelClsExtra} ',
    '{childElCls} {unselectableCls}" style="{labelStyle}"',
    '<tpl if="inputId && !skipLabelForAttribute"> for="{inputId}"</tpl>',
    ' {labelAttrTpl}>',
    '<span class="{labelInnerCls} {labelInnerCls}-{ui}" style="{labelInnerStyle}">',
    '{beforeLabelTextTpl}',
    '<span id="{id}-labelTextEl" data-ref="labelTextEl" class="{labelTextCls}">',
    '<tpl if="fieldLabel">{fieldLabel}',
    '<tpl if="labelSeparator">{labelSeparator}</tpl>',
    '</tpl>',
    '</span>',
    '{afterLabelTextTpl}',
    '</span>',
    '</label>',
    '{afterLabelTpl}',
    '<div id="{id}-bodyEl" data-ref="bodyEl" role="presentation"',
    ' class="{baseBodyCls} {baseBodyCls}-{ui}<tpl if="fieldBodyCls">',
    ' {fieldBodyCls} {fieldBodyCls}-{ui}</tpl> {growCls} {extraFieldBodyCls}"',
    '<tpl if="bodyStyle"> style="{bodyStyle}"</tpl>>',
    '{beforeBodyEl}',
    '{beforeSubTpl}',
    '{[values.$comp.getSubTplMarkup(values)]}',
    '{afterSubTpl}',
    '{afterBodyEl}',
    // ARIA elements serve different purposes:
    // - ariaHelpEl may contain optional hints about the field, such as
    //   expected format. This text is static and usually does not change
    //   once rendered. It is also optional.
    // - ariaStatusEl is used to convey status of the field. Validation errors
    //   are rendered here, as well as other information that might be helpful
    //   to Assistive Technology users exploring the app in browse mode.
    // - ariaErrorEl is used for announcing dynamic changes in the field state,
    //   so that AT users receive updates while in forms mode.
    //
    // Both ariaHelpEl and ariaStatusEl are referenced by the field's input element
    // via aria-describedby.
    '<tpl if="renderAriaElements">',
    '<tpl if="ariaHelp">',
    '<span id="{id}-ariaHelpEl" data-ref="ariaHelpEl"',
    ' class="' + Ext.baseCSSPrefix + 'hidden-offsets">',
    '{ariaHelp}',
    '</span>',
    '</tpl>',
    '<span id="{id}-ariaStatusEl" data-ref="ariaStatusEl" aria-hidden="true"',
    ' class="' + Ext.baseCSSPrefix + 'hidden-offsets">',
    '{ariaStatus}',
    '</span>',
    '<span id="{id}-ariaErrorEl" data-ref="ariaErrorEl" aria-hidden="true" aria-live="assertive"',
    ' class="' + Ext.baseCSSPrefix + 'hidden-clip">',
    '</span>',
    '</tpl>',
    '</div>',
    '<tpl if="renderError">',
    '<div id="{id}-errorWrapEl" data-ref="errorWrapEl" class="{errorWrapCls} {errorWrapCls}-{ui}',
    ' {errorWrapExtraCls}" style="{errorWrapStyle}">',
    '<div role="presentation" id="{id}-errorEl" data-ref="errorEl" ',
    'class="{errorMsgCls} {invalidMsgCls} {invalidMsgCls}-{ui}" ',
    'data-anchorTarget="{tipAnchorTarget}">',
    '</div>',
    '</div>',
    '</tpl>',
    {
        disableFormats: true
    }
]

labelAlign : String

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

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

Defaults to:

'left'

labelAttrTpl : String / Array / Ext.XTemplate

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

labelCls : String

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

Defaults to:

Ext.baseCSSPrefix + 'form-item-label'

labelClsExtra : String

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

labelPad : Number

The amount of space in pixels between the fieldLabel and the field body. This defaults to 5 for compatibility with Ext JS 4, however, as of Ext JS 5 the space between the label and the body can optionally be determined by the theme using the $form-label-horizontal-spacing (for side-aligned labels) and $form-label-vertical-spacing (for top-aligned labels) SASS variables. In order for the stylesheet values as to take effect, you must use a labelPad value of null.

Defaults to:

5

labelSeparator : String

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

Set to empty string to hide the separator completely.

Defaults to:

':'

labelStyle : String

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

labelWidth : Number

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

Defaults to:

100

msgTarget : String

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

  • qtip Display a quick tip containing the message when the user hovers over the field. This is the default.

    Ext.tip.QuickTipManager#init must have been called for this setting to work.

  • title Display the message in a default browser title attribute popup.

  • under Add a block div beneath the field containing the error message.
  • side Add an error icon to the right of the field, displaying the message in a popup on hover.
  • none Don't display any error message. This might be useful if you are implementing custom error display.
  • [element id] Add the error message directly to the innerHTML of the specified element.

Defaults to:

'qtip'

preventMark : Boolean

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

Defaults to:

false

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

bodyEl : Ext.dom.Element

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

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

destroyed : Boolean
protected pro

This property is set to true after the destroy method is called.

Defaults to:

false

errorEl : Ext.dom.Element

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

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFieldLabelable : Boolean

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

Defaults to:

true

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

labelEl : Ext.dom.Element

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

msgTargets
private pri

Map for msg target lookup, if target is not in this map it is assumed to be an element id

Defaults to:

{
    qtip: 1,
    title: 1,
    under: 1,
    side: 1,
    none: 1
}

noWrap
private pri

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

Defaults to:

true

self : Ext.Class
protected pro

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

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Defaults to:

Base

topLabelCls
private pri

Defaults to:

Ext.baseCSSPrefix + 'form-item-label-top'

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use method-callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

args :  Array/Arguments

The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

:Object

Returns the result of calling the superclass method

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

destroyMembers ( args )

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

getActiveErrors String[]

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

Returns

:String[]

The active error messages on the component; if there are no errors, an empty Array is returned.

getConfig ( [name], [peek], [ifInitialized] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

true to peek at the raw value without calling the getter.

Defaults to: false

ifInitialized :  Boolean (optional)

true to only return the initialized property value, not the raw config value, and not to trigger initialization. Returns undefined if the property has not yet been initialized.

Defaults to: false

Returns

:Object

The config property value.

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to the constructor when instantiating this class.

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

The full config object or a single config value when name parameter specified.

getInputId String

Get the input id, if any, for this component. This is used as the "for" attribute on the label element. Implementing subclasses may also use this as e.g. the id for their own input element.

Returns

:String

The input id

getLabelableRenderData ( data ) : Object
protected pro

Generates the arguments for the field decorations rendering template.

Parameters

data :  Object

optional object to use as the base data object. If provided, this method will add properties to the base object instead of creating a new one.

Returns

:Object

The template arguments

getSubTplMarkup String
protected pro

Gets the markup to be inserted into the outer template's bodyEl. Defaults to empty string, should be implemented by classes including this mixin as needed.

Returns

:String

The markup to be inserted

hasActiveError Boolean

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

Returns

:Boolean

hasConfig ( name )
private pri

Parameters

name :  String

hasVisibleLabel Boolean

Checks if the field has a visible label

Returns

:Boolean

True if the field has a visible label

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

initLabelable

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

renderActiveError
private pri

Updates the rendered DOM to match the current activeError. This only updates the content and attributes, you'll have to call doComponentLayout to actually update the display.

setActiveErrors ( errors )

Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

Parameters

errors :  String[]

The error messages

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

setFieldDefaults ( defaults )

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given object, check if this component hasOwnProperty that config; if not then it's inheriting a default value from its prototype and we should apply the default value.

Parameters

defaults :  Object

The defaults to apply to the object.

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class

toggleInvalidCls ( hasError )
private pri

Add/remove invalid class(es)

Parameters

hasError :  Boolean

trimLabelSeparator String

Returns the trimmed label by slicing off the label separator character. Can be overridden.

Returns

:String

The trimmed field label, or empty string if not defined

unsetActiveError

Clears the active error message(s). Note that this only clears the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call clearInvalid instead.

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass true if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

destroyTip
static sta

Destroy the error tip instance.

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String

className

initTip
static sta private pri

Use a custom QuickTip instance separate from the main QuickTips singleton, so that we can give it a custom frame style. Responds to errorqtip rather than the qtip property.

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

Override members of this class. Overridden methods can be invoked via callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

events

errorchange ( this, error, eOpts )

Fires when the active error message is changed via setActiveError.

Parameters

this :  Ext.form.Labelable

error :  String

The active error message

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$form-error-icon-background-image : String

The background image for error icons

Defaults to:

'form/exclamation'

$form-error-icon-height : Number

Height for form error icons.

Defaults to:

16px

$form-error-icon-side-margin : Number / list

Margin for error icons that are aligned to the side of the field

Defaults to:

0 1px

$form-error-icon-width : Number

Width for form error icons.

Defaults to:

16px

$form-error-msg-color : color

The text color of form error messages

Defaults to:

$form-field-invalid-border-color

$form-error-msg-font-family : String

The font-family of form error messages

Defaults to:

$font-family

$form-error-msg-font-size : Number

The font-size of form error messages

Defaults to:

$font-size

$form-error-msg-font-weight : String

The font-weight of form error messages

Defaults to:

$font-weight

$form-error-msg-line-height : Number

The line-height of form error messages

Defaults to:

$form-error-icon-height

$form-error-under-icon-spacing : Number

The space between the icon and the message for errors that display under the field

Defaults to:

4px

$form-error-under-padding : Number / list

The padding on errors that display under the form field

Defaults to:

2px 2px 2px 0

$form-field-disabled-opacity : Number

Opacity of disabled form fields

Defaults to:

.3

$form-item-margin-bottom : Number

The bottom margin to apply to form items when in auto, anchor, vbox, or table layout. This value is also used as the default border-spacing in a form-layout.

Defaults to:

5px

$form-label-font-color : color

The text color of form field labels

Defaults to:

$color

$form-label-font-family : String

The font-family of form field labels

Defaults to:

$font-family

$form-label-font-size : Number

The font-size of form field labels

Defaults to:

$font-size

$form-label-font-weight : String

The font-weight of form field labels

Defaults to:

$font-weight

$form-label-horizontal-spacing : Number

Horizontal space between the label and the field body when the label is left-aligned.

Defaults to:

5px

$form-label-line-height : Number

The line-height of form field labels

Defaults to:

round($form-label-font-size * 1.15)

$form-label-vertical-spacing : Number

Vertical space between the label and the field body when the label is top-aligned.

Defaults to:

5px

$form-toolbar-error-icon-background-image : String

The background image for toolbar field error icons

Defaults to:

'form/exclamation'

$form-toolbar-error-icon-height : Number

Height for toolbar field error icons.

Defaults to:

16px

$form-toolbar-error-icon-side-margin : Number / list

Margin for toolbar field error icons that are aligned to the side of the field

Defaults to:

0 1px

$form-toolbar-error-icon-width : Number

Width for toolbar field error icons.

Defaults to:

16px

$form-toolbar-error-msg-color : color

The text color of toolbar form error messages

Defaults to:

$form-field-invalid-border-color

$form-toolbar-error-msg-font-family : String

The font-family of toolbar form field error messages

Defaults to:

$font-family

$form-toolbar-error-msg-font-size : Number

The font-size of toolbar form field error messages

Defaults to:

$font-size

$form-toolbar-error-msg-font-weight : String

The font-weight of toolbar form field error messages

Defaults to:

$font-weight

$form-toolbar-error-msg-line-height : Number

The line-height of toolbar form field error messages

Defaults to:

$form-toolbar-error-icon-height

$form-toolbar-error-under-icon-spacing : Number

The space between the icon and the message for errors that display under a toolbar field

Defaults to:

4px

$form-toolbar-error-under-padding : Number / list

The padding on errors that display under the toolbar form field

Defaults to:

2px 2px 2px 0

$form-toolbar-field-disabled-opacity : Number

Opacity of disabled toolbar form fields

Defaults to:

.3

$form-toolbar-label-font-color : color

The text color of toolbar form field labels

Defaults to:

$color

$form-toolbar-label-font-family : String

The font-family of toolbar form field labels

Defaults to:

$font-family

$form-toolbar-label-font-size : Number

The font-size of toolbar form field labels

Defaults to:

$font-size

$form-toolbar-label-font-weight : String

The font-weight of toolbar form field labels

Defaults to:

$font-weight

$form-toolbar-label-horizontal-spacing : Number

Horizontal space between the toolbar field's label and the field body when the label is left-aligned.

Defaults to:

5px

$form-toolbar-label-line-height : Number

The line-height of toolbar form field labels

Defaults to:

round($form-toolbar-label-font-size * 1.15)

$form-toolbar-label-vertical-spacing : Number

Vertical space between the toolbar field's label and the field body when the label is top-aligned.

Defaults to:

5px

$include-label-default-ui : Boolean

True to include the "default" label UI

Defaults to:

$include-field-default-ui

$include-label-toolbar-ui : Boolean

True to include the "default" label UI

Defaults to:

$include-field-toolbar-ui

theme mixins

extjs-label-ui ( ...list... )

Creates a visual theme for "labelable" form items. Provides visual styling for the Label and error message that can be shared between many types of form fields.

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$ui-font-color :  color (optional)

The text color the label

Defaults to: $form-label-font-color

$ui-font-weight :  String (optional)

The font-weight of the label

Defaults to: $form-label-font-weight

$ui-font-size :  Number (optional)

The font-size of the label

Defaults to: $form-label-font-size

$ui-font-family :  String (optional)

The font-family the label

Defaults to: $form-label-font-family

$ui-height :  Number (optional)

The height of the label. This should be the same height as the height of fields that this label ui will be used with. This does not actually set the height of the label but is used to ensure that the label is centered within the given height.

Defaults to: $form-field-height

$ui-line-height :  Number (optional)

The line-height of the label

Defaults to: $form-label-line-height

$ui-horizontal-spacing :  Number (optional)

Horizontal space between the label and the field body when the label is left-aligned.

Defaults to: $form-label-horizontal-spacing

$ui-vertical-spacing :  Number (optional)

Vertical space between the label and the field body when the label is top-aligned.

Defaults to: $form-label-vertical-spacing

$ui-error-icon-background-image :  Number (optional)

The background-image of the error icon

Defaults to: $form-error-icon-background-image

$ui-error-icon-width :  Number (optional)

The width of the error icon

Defaults to: $form-error-icon-width

$ui-error-icon-height :  Number (optional)

The height of the error icon

Defaults to: $form-error-icon-height

$ui-error-icon-side-margin :  Number/list (optional)

Margin for error icons when aligned to the side of the field

Defaults to: $form-error-icon-side-margin

$ui-error-under-icon-spacing :  Number (optional)

The space between the icon and the message for errors that display under the field

Defaults to: $form-error-under-icon-spacing

$ui-error-under-padding :  Number/list (optional)

The padding on errors that display under the form field

Defaults to: $form-error-under-padding

$ui-error-msg-color :  color (optional)

The text color of form error messages

Defaults to: $form-error-msg-color

$ui-error-msg-font-weight :  String (optional)

The font-weight of form error messages

Defaults to: $form-error-msg-font-weight

$ui-error-msg-font-size :  Number (optional)

The font-size of form error messages

Defaults to: $form-error-msg-font-size

$ui-error-msg-font-family :  String (optional)

The font-family of form error messages

Defaults to: $form-error-msg-font-family

$ui-error-msg-line-height :  Number (optional)

The line-height of form error messages

Defaults to: $form-error-msg-line-height

$ui-disabled-opacity :  Number (optional)

Opacity of disabled form fields

Defaults to: $form-field-disabled-opacity

Ext JS 6.5.2 - Classic Toolkit