ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

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

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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.

ExtWebComponents 7.1.0


top

<ext-filefield/> filefield

No members found using the current filters

properties

Optional Properties

$className
readonly ro private pri

<ext-filefield $className="value" />
let element = document.body.querySelector('ext-filefield');
element.$className = 'value';
let $className = element.$className;

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
readonly ro private pri

<ext-filefield $configPrefixed="true" />
let element = document.body.querySelector('ext-filefield');
element.$configPrefixed = true;
let $configPrefixed = element.$configPrefixed;

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
readonly ro private pri

<ext-filefield $configStrict="true" />
let element = document.body.querySelector('ext-filefield');
element.$configStrict = true;
let $configStrict = element.$configStrict;

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

$configTransforms : Object / Array
readonly ro private pri

<ext-filefield $configTransforms="{ }" />
let element = document.body.querySelector('ext-filefield');
element.$configTransforms = { };
let $configTransforms = element.$configTransforms;

A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.

Defaults to:

{}

$eventOptions
readonly ro private pri

<ext-filefield $eventOptions="value" />
let element = document.body.querySelector('ext-filefield');
element.$eventOptions = 'value';
let $eventOptions = element.$eventOptions;

Matches options property names within a listeners specification object - property names which are never used as event names.

Defaults to:

{
    scope: 1,
    delay: 1,
    buffer: 1,
    onFrame: 1,
    single: 1,
    args: 1,
    destroyable: 1,
    priority: 1,
    order: 1
}

$onExtended
static sta private pri

Defaults to:

[]

$vetoClearingPrototypeOnDestroy
readonly ro private pri

<ext-filefield $vetoClearingPrototypeOnDestroy="value" />
let element = document.body.querySelector('ext-filefield');
element.$vetoClearingPrototypeOnDestroy = 'value';
let $vetoClearingPrototypeOnDestroy = element.$vetoClearingPrototypeOnDestroy;

We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to:

true

accept : String
immutable imm

<ext-filefield accept="value" />
let element = document.body.querySelector('ext-filefield');
element.accept = 'value';
let accept = element.accept;

File input accept attribute documented here (http://www.w3schools.com/tags/att_input_accept.asp) Also can be simple strings -- e.g. audio, video, image

Defaults to:

null

activeAnimation
readonly ro private pri

<ext-filefield activeAnimation="value" />
let element = document.body.querySelector('ext-filefield');
element.activeAnimation = 'value';
let activeAnimation = element.activeAnimation;

Defaults to:

null

alignSelf : String

<ext-filefield alignSelf="value" />
let element = document.body.querySelector('ext-filefield');
element.alignSelf = 'value';
let alignSelf = element.alignSelf;

Specifies the self alignment of this widget in a box layout

Defaults to:

null

alwaysOnTop : Boolean / Number

<ext-filefield alwaysOnTop="true" />
let element = document.body.querySelector('ext-filefield');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

false

Available since: 6.2.0

animateUnderline : Boolean

<ext-filefield animateUnderline="true" />
let element = document.body.querySelector('ext-filefield');
element.animateUnderline = true;
let animateUnderline = element.animateUnderline;

'true' to animate the underline of a field when focused

Defaults to:

false

ariaAttributes : Object

<ext-filefield ariaAttributes="{ }" />
let element = document.body.querySelector('ext-filefield');
element.ariaAttributes = { };
let ariaAttributes = element.ariaAttributes;

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

Defaults to:

null

ariaDescribedBy : String
immutable imm

<ext-filefield ariaDescribedBy="value" />
let element = document.body.querySelector('ext-filefield');
element.ariaDescribedBy = 'value';
let ariaDescribedBy = element.ariaDescribedBy;

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaEl : String
readonly ro private pri

<ext-filefield ariaEl="value" />
let element = document.body.querySelector('ext-filefield');
let ariaEl = element.ariaEl;

The name of the Component property that holds a reference to the Element that serves as that Component's ARIA element. This property will be replaced with the actual Element reference after rendering.

Most of the simple Components will have their main element as ariaEl.

Defaults to:

'el'

Available since: 6.0.0

ariaLabel : String
immutable imm

<ext-filefield ariaLabel="value" />
let element = document.body.querySelector('ext-filefield');
element.ariaLabel = 'value';
let ariaLabel = element.ariaLabel;

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String
immutable imm

<ext-filefield ariaLabelledBy="value" />
let element = document.body.querySelector('ext-filefield');
element.ariaLabelledBy = 'value';
let ariaLabelledBy = element.ariaLabelledBy;

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

ariaRenderAttributes : Object
readonly ro private pri

<ext-filefield ariaRenderAttributes="{ }" />
let element = document.body.querySelector('ext-filefield');
element.ariaRenderAttributes = { };
let ariaRenderAttributes = element.ariaRenderAttributes;

Instance specific ARIA attributes to render into Component's ariaEl. This object is only used during rendering, and is discarded afterwards.

ariaRole : String
readonly ro

<ext-filefield ariaRole="value" />
let element = document.body.querySelector('ext-filefield');
let ariaRole = element.ariaRole;

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

autoCapitalize : Boolean

<ext-filefield autoCapitalize="true" />
let element = document.body.querySelector('ext-filefield');
element.autoCapitalize = true;
let autoCapitalize = element.autoCapitalize;

True to set the field's DOM element auto-capitalize attribute to "on", false to set to "off".

Defaults to:

null

autoComplete : Boolean

<ext-filefield autoComplete="true" />
let element = document.body.querySelector('ext-filefield');
element.autoComplete = true;
let autoComplete = element.autoComplete;

`false to disable autocomplete on this text field. Autocomplete is enabled by default on text fields, but disabled on picker fields.

Defaults to:

true

autoCorrect : Boolean

<ext-filefield autoCorrect="true" />
let element = document.body.querySelector('ext-filefield');
element.autoCorrect = true;
let autoCorrect = element.autoCorrect;

True to set the field DOM element autocorrect attribute to "on", false to set to "off".

Defaults to:

null

autoFitErrors : Boolean

<ext-filefield autoFitErrors="true" />
let element = document.body.querySelector('ext-filefield');
element.autoFitErrors = true;
let autoFitErrors = element.autoFitErrors;

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

Defaults to:

true

autoGenId : Boolean
readonly ro private pri

<ext-filefield autoGenId="true" />
let element = document.body.querySelector('ext-filefield');
element.autoGenId = true;
let autoGenId = element.autoGenId;

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

Defaults to:

false

Available since: 6.7.0

autoHideInputMask : Boolean

<ext-filefield autoHideInputMask="true" />
let element = document.body.querySelector('ext-filefield');
element.autoHideInputMask = true;
let autoHideInputMask = element.autoHideInputMask;

Specify as false to always show the inputMask.

Defaults to:

true

Available since: 6.5.0

axisLock : Boolean

<ext-filefield axisLock="true" />
let element = document.body.querySelector('ext-filefield');
element.axisLock = true;
let axisLock = element.axisLock;

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

badFormatMessage : String
immutable imm

<ext-filefield badFormatMessage="value" />
let element = document.body.querySelector('ext-filefield');
element.badFormatMessage = 'value';
let badFormatMessage = element.badFormatMessage;

The error message that will be displayed if the value cannot be parsed (for some derived types) or if the value does not match a configured inputMask.

Defaults to:

'Value does not match the required format'

Available since: 6.5.0

baseCls
readonly ro protected pro

<ext-filefield baseCls="value" />
let element = document.body.querySelector('ext-filefield');
element.baseCls = 'value';
let baseCls = element.baseCls;

The base CSS class to apply to this widget's element. Used as the prefix for ui-specific class names. Defaults to the value of classCls or (x- + the xtype) of the widget if classCls is null

Defaults to:

null

bind : Object / String

<ext-filefield bind="value" />
let element = document.body.querySelector('ext-filefield');
element.bind = 'value';
let bind = element.bind;

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel#bind. The ViewModel instance is determined by lookupViewModel.

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding.

Defaults to:

null

border : Boolean

<ext-filefield border="true" />
let element = document.body.querySelector('ext-filefield');
element.border = true;
let border = element.border;

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    style: 'border: 1px solid blue;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border: 1px solid red;
}

Defaults to:

null

bottom : Number / String

<ext-filefield bottom="value" />
let element = document.body.querySelector('ext-filefield');
element.bottom = 'value';
let bottom = element.bottom;

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

bubbleDirty : Boolean

<ext-filefield bubbleDirty="true" />
let element = document.body.querySelector('ext-filefield');
element.bubbleDirty = true;
let bubbleDirty = element.bubbleDirty;

Set to false to disable dirty states affecting ancestor containers such as fieldpanel or formpanel. The dirty state of such containers is based on the presence of dirty descendants. In some cases, however, it may be desired to hide the dirty state of one of these containers from its ancestor containers.

Defaults to:

true

Available since: 7.0

capture : String
immutable imm

<ext-filefield capture="value" />
let element = document.body.querySelector('ext-filefield');
element.capture = 'value';
let capture = element.capture;

File input capture attribute. Accepts values such as "camera", "camcorder", "microphone"

Defaults to:

null

centered : Boolean

<ext-filefield centered="true" />
let element = document.body.querySelector('ext-filefield');
element.centered = true;
let centered = element.centered;

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

false

classCls
readonly ro

<ext-filefield classCls="value" />
let element = document.body.querySelector('ext-filefield');
element.classCls = 'value';
let classCls = element.classCls;

A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example

Ext.define('Foo', {
    extend: 'Ext.Widget',
    classCls: 'foo'
});

Ext.define('Bar', {
    extend: 'Foo',
    classCls: 'bar'
});

var bar = new Bar();

console.log(bar.element.className); // outputs 'foo bar'

Defaults to:

Ext.baseCSSPrefix + 'textfield'

classClsRoot
readonly ro protected pro

<ext-filefield classClsRoot="value" />
let element = document.body.querySelector('ext-filefield');
element.classClsRoot = 'value';
let classClsRoot = element.classClsRoot;

When set to true during widget class definition, that class will be the "root" for classCls inheritance. Derived classes may set this to true to avoid inheriting a classCls from their superclass.

Defaults to:

true

clearPropertiesOnDestroy : Boolean / "async"
readonly ro protected pro

<ext-filefield clearPropertiesOnDestroy="true" />
let element = document.body.querySelector('ext-filefield');
element.clearPropertiesOnDestroy = true;
let clearPropertiesOnDestroy = element.clearPropertiesOnDestroy;

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
readonly ro private pri

<ext-filefield clearPrototypeOnDestroy="true" />
let element = document.body.querySelector('ext-filefield');
element.clearPrototypeOnDestroy = true;
let clearPrototypeOnDestroy = element.clearPrototypeOnDestroy;

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

clearable : Boolean

<ext-filefield clearable="true" />
let element = document.body.querySelector('ext-filefield');
element.clearable = true;
let clearable = element.clearable;

true to show a clear trigger in this field when it has a non-empty value

Defaults to:

true

cls : String / String[]

<ext-filefield cls="value" />
let element = document.body.querySelector('ext-filefield');
element.cls = 'value';
let cls = element.cls;

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a <ext-container/>).

Defaults to:

null

constrainAlign : String / Ext.util.Region / Ext.dom.Element

<ext-filefield constrainAlign="value" />
let element = document.body.querySelector('ext-filefield');
element.constrainAlign = 'value';
let constrainAlign = element.constrainAlign;

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

Defaults to:

null

containsFocus : Boolean
readonly ro

<ext-filefield containsFocus="true" />
let element = document.body.querySelector('ext-filefield');
let containsFocus = element.containsFocus;

true if this currently focused element is within this Component's or Container's hierarchy. This property is set separately from hasFocus, and can be true when hasFocus is false.

Examples:

  • Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true

  • Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true

  • Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true

See also hasFocus.

Defaults to:

false

contentEl : Ext.dom.Element / HTMLElement / String

<ext-filefield contentEl="value" />
let element = document.body.querySelector('ext-filefield');
element.contentEl = 'value';
let contentEl = element.contentEl;

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

controller : String / Object / Ext.app.ViewController

<ext-filefield controller="value" />
let element = document.body.querySelector('ext-filefield');
element.controller = 'value';
let controller = element.controller;

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});

Defaults to:

null

data : Object

<ext-filefield data="{ }" />
let element = document.body.querySelector('ext-filefield');
element.data = { };
let data = element.data;

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

Note: Data will be appended to any existing data.

Defaults to:

null

dataType : Ext.data.field.Field / Object / String

<ext-filefield dataType="value" />
let element = document.body.querySelector('ext-filefield');
element.dataType = 'value';
let dataType = element.dataType;

A config for a Ext.data.field.Field or data field sub-class instance used to serialize this field's value for form submission. This is used by the serialize method unless modelValidation is used, in which case, the data field of the bound Ext.data.Model is used.

For example:

 {
     xtype: 'datefield',
     dataType: {
         // type: 'date'  (datefield does this by default)
         dateWriteFormat: 'Y-m-d'
     }
 }

If this config is a string, it is used to create a Ext.data.field.Field by that alias.

Defaults to:

null

Available since: 7.0

defaultBindProperty : String
readonly ro

<ext-filefield defaultBindProperty="value" />
let element = document.body.querySelector('ext-filefield');
element.defaultBindProperty = 'value';
let defaultBindProperty = element.defaultBindProperty;

This property is used to determine the property of a bind config that is just the value. For example, if defaultBindProperty="value", then this shorthand bind config:

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to:

'value'

defaultListenerScope : Boolean

<ext-filefield defaultListenerScope="true" />
let element = document.body.querySelector('ext-filefield');
element.defaultListenerScope = true;
let defaultListenerScope = element.defaultListenerScope;

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to:

false

destroyed : Boolean
readonly ro

<ext-filefield destroyed="true" />
let element = document.body.querySelector('ext-filefield');
element.destroyed = true;
let destroyed = element.destroyed;

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

Defaults to:

false

dirty : Boolean

<ext-filefield dirty="true" />
let element = document.body.querySelector('ext-filefield');
element.dirty = true;
let dirty = element.dirty;

This config property describes the modified state of this component. In most cases this config's value is maintained by the component and should be considered readonly. The class implementor should be the only one to call the setter.

For containers, this config will be updated on a short delay in some cases.

Defaults to:

false

Available since: 7.0

disabled : Boolean

<ext-filefield disabled="true" />
let element = document.body.querySelector('ext-filefield');
element.disabled = true;
let disabled = element.disabled;

true to disable the field.

Be aware that conformant with the HTML specification, disabled Fields will not be submitted.

Defaults to:

false

displayed : Boolean

<ext-filefield displayed="true" />
let element = document.body.querySelector('ext-filefield');
element.displayed = true;
let displayed = element.displayed;

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

doKeyDown
readonly ro protected pro

<ext-filefield doKeyDown="value" />
let element = document.body.querySelector('ext-filefield');
element.doKeyDown = 'value';
let doKeyDown = element.doKeyDown;

Called when a key has been pressed in the <input>

Defaults to:

Ext.emptyFn

dockPositions
readonly ro private pri

<ext-filefield dockPositions="value" />
let element = document.body.querySelector('ext-filefield');
let dockPositions = element.dockPositions;

Defaults to:

{
    top: true,
    right: true,
    bottom: true,
    left: true
}

docked : String

<ext-filefield docked="value" />
let element = document.body.querySelector('ext-filefield');
element.docked = 'value';
let docked = element.docked;

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

<ext-filefield draggable="true" />
let element = document.body.querySelector('ext-filefield');
element.draggable = true;
let draggable = element.draggable;

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

editable : Boolean

<ext-filefield editable="true" />
let element = document.body.querySelector('ext-filefield');
element.editable = true;
let editable = element.editable;

Configure as false to prevent the user from typing text directly into the field; the field can only have its value set programmatically or via an action invoked by a trigger.

Contrast with readOnly which disables all mutation via the UI.

Defaults to:

true

element : Object
readonly ro protected pro

<ext-filefield element="{ }" />
let element = document.body.querySelector('ext-filefield');
element.element = { };
let element = element.element;

A configuration object for Ext.Element.create() that is used to create the Element template. Subclasses should avoid overriding this property and instead add elements using template.

Supports all the standard options of a Ext.Element.create() config and adds 3 additional options:

  1. reference - this option specifies a name for Element references. These references names become properties of the Widget instance and refer to Ext.Element instances that were created using the template:

      element: {
          reference: 'element',
          children: [{
              reference: 'innerElement'
          }]
      }
    

After construction of a widget the reference elements are accessible as follows:

var foo = new FooWidget(),
    innerEl = foo.innerElement; // an Ext.Element that wraps the innerElement

The reference attribute is optional, but all Widgets must have a 'element' reference on some element within the template (usually the outermost one).

  1. listeners - a standard listeners object as specified by Ext.mixin.Observable.

      element: {
          reference: 'element',
          listeners: {
              click: 'onClick'
          },
          children: [{
              reference: 'innerElement',
              listeners: {
                  click: 'onInnerClick'
              }
          }]
      }
    

Since listeners cannot be attached without an Ext.Element reference the reference property MUST be specified in order to use listeners.

The Widget instance is used as the scope for all listeners specified in this way, so it is invalid to use the scope option in the listeners config since it will always be overwritten using this.

  1. uiCls - a suffix to be appended to the ui-specific CSS class for each ui for this widget. These ui classes are constructed by appending the ui to each classCls or baseCls for the widget. As such, uiCls should never be used on the main element reference, as its uiCls is computed automatically.

For example, assume a widget is defined with a ui of 'alt action' and a uiCls of 'inner-el' on its innerElement reference element:

     Ext.define('Doodad', {
         extend: 'Ext.Widget',
         xtype: 'doodad',

         classCls: 'x-doodad',

         ui: 'alt action',

         element: {
             reference: 'element',

             children: [{
                 reference: 'innerElement',
                 cls: 'x-inner-el',
                 uiCls: 'inner-el'
             }]
         }
     });

This would result in the following markup when rendered:

<div class="x-doodad x-doodad-alt x-doodad-action">
    <div class="x-inner-el x-doodad-inner-el x-doodad-alt-inner-el x-doodad-action-inner-el"></div>
</div>

These additional classes can be used to style the reference element for a particular ui; however, use of uiCls is not typically necessary or recommended. Reference elements should usually be styled using simple descendant selectors:

.x-doodad-alt .x-inner-el {
    color: red;
}

When there is a possibility that widgets can be nested it is best to use direct child selectors to avoid the possibility of selecting all descendants instead of just the reference element for the intended widget:

.x-doodad-alt > .x-inner-el {
    color: red;
}

Only use uiCls when there is a possibility of nesting, AND there may be a variable number of elements between the main element and the reference element in question. For example, Ext.Container with docked items has a different number of elements in between its element and its bodyElement than a Container without docked items because of the wrapping elements that are dynamically added to support docking. To ensure it does not style all descendants it must use a uiCls to style its bodyElement:

.x-container-alt-body-el {
    background: #fff;
}

Note that when uiCls is specified it also adds a class name that does not contain the ui using just the classCls and/or baseCls as the prefix. This class name can be used for base-level styling that does not relate to any particular UI:

.x-container-body-el {
    position: relative;
}

Defaults to:

{
    reference: 'element'
}

enterAnimation : String / Mixed
deprecated dep

<ext-filefield enterAnimation="value" />
let element = document.body.querySelector('ext-filefield');
element.enterAnimation = 'value';
let enterAnimation = element.enterAnimation;

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Defaults to:

null

Deprecated since version 2.0.0
Please use showAnimation instead.

error : String / String[]

<ext-filefield error="value" />
let element = document.body.querySelector('ext-filefield');
element.error = 'value';
let error = element.error;

The error (or errors) to display for this field. This config is typically set by the field's validators but can be set directly if an error needs to be associated with a field manually.

Errors will be HTML encoded as necessary and errorTpl before becoming the current errorMessage.

Defaults to:

null

Available since: 6.5.0

errorMessage : String

<ext-filefield errorMessage="value" />
let element = document.body.querySelector('ext-filefield');
element.errorMessage = 'value';
let errorMessage = element.errorMessage;

The field's error message to display as errorTarget. This message must already be properly formatted and encoded as appropriate for the errorTarget.

Defaults to:

null

Available since: 6.5.0

errorTarget : String

<ext-filefield errorTarget="value" />
let element = document.body.querySelector('ext-filefield');
element.errorTarget = 'value';
let errorTarget = element.errorTarget;

The location where the error message text should display.

The following are values that have predefined meaning:

  • qtip Display a Ext.tip.Manager containing the message when the user hovers (or taps) the field. For this option to work, quick tips must be enabled by calling Ext.tip.Manager#init.
  • side Add an error icon to the right of the field, displaying the message in a popup on hover or tap.
  • title Display the message in a default browser title attribute.
  • under Add a div beneath the field containing the error message.

Defaults to:

'qtip'

Available since: 6.5.0

errorTip : Object

<ext-filefield errorTip="{ }" />
let element = document.body.querySelector('ext-filefield');
element.errorTip = { };
let errorTip = element.errorTip;

The default config that will be used to display errors in the tooltip.

Defaults to:

null

Available since: 6.5.0

errorTpl : String / String[] / Ext.XTemplate

<ext-filefield errorTpl="value" />
let element = document.body.querySelector('ext-filefield');
element.errorTpl = 'value';
let errorTpl = element.errorTpl;

The template used to format the error set for this field. By default, the errorTarget is used to determine whether the error(s) are formatted as an HTML list or as plain text.

Defaults to:

null

Available since: 6.5.0

eventHandlers : Object
deprecated dep private pri

<ext-filefield eventHandlers="{ }" />
let element = document.body.querySelector('ext-filefield');
element.eventHandlers = { };
let eventHandlers = element.eventHandlers;

A map of event type to the corresponding handler method name. This is used internally by native event handling mechanism.

Defaults to:

{
    focus: 'handleFocusEvent',
    blur: 'handleBlurEvent'
}

Deprecated since version 6.6.0
Inline event handlers are deprecated

eventsSuspended
readonly ro private pri

<ext-filefield eventsSuspended="value" />
let element = document.body.querySelector('ext-filefield');
element.eventsSuspended = 'value';
let eventsSuspended = element.eventsSuspended;

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

Defaults to:

0

exitAnimation : String / Mixed
deprecated dep

<ext-filefield exitAnimation="value" />
let element = document.body.querySelector('ext-filefield');
element.exitAnimation = 'value';
let exitAnimation = element.exitAnimation;

Animation effect to apply when the Component is being hidden.

Defaults to:

null

Deprecated since version 2.0.0
Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

factoryConfig : Object
readonly ro

<ext-filefield factoryConfig="{ }" />
let element = document.body.querySelector('ext-filefield');
element.factoryConfig = { };
let factoryConfig = element.factoryConfig;

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

flex : Number / String / Object

<ext-filefield flex="value" />
let element = document.body.querySelector('ext-filefield');
element.flex = 'value';
let flex = element.flex;

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

Defaults to:

null

floatWrapCls : String
readonly ro private pri

<ext-filefield floatWrapCls="value" />
let element = document.body.querySelector('ext-filefield');
let floatWrapCls = element.floatWrapCls;

The CSS class to add to this component's floatWrap when it's created.

Defaults to:

"x-float-wrap"

floated : Boolean

<ext-filefield floated="true" />
let element = document.body.querySelector('ext-filefield');
element.floated = true;
let floated = element.floated;

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

false

Available since: 6.2.0

floatedSelector : String
readonly ro private pri

<ext-filefield floatedSelector="value" />
let element = document.body.querySelector('ext-filefield');
let floatedSelector = element.floatedSelector;

The CSS selector to match floated elements.

Defaults to:

".x-floated"

floatingCls : String
readonly ro

<ext-filefield floatingCls="value" />
let element = document.body.querySelector('ext-filefield');
element.floatingCls = 'value';
let floatingCls = element.floatingCls;

The CSS class to add to this component when it is floated at the viewport level.

Defaults to:

Ext.baseCSSPrefix + 'floating'

focusCls : String
immutable imm

<ext-filefield focusCls="value" />
let element = document.body.querySelector('ext-filefield');
element.focusCls = 'value';
let focusCls = element.focusCls;

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

<ext-filefield focusClsEl="value" />
let element = document.body.querySelector('ext-filefield');
element.focusClsEl = 'value';
let focusClsEl = element.focusClsEl;

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element
readonly ro

<ext-filefield focusEl="value" />
let element = document.body.querySelector('ext-filefield');
element.focusEl = 'value';
let focusEl = element.focusEl;

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

focusable : Boolean
readonly ro

<ext-filefield focusable="true" />
let element = document.body.querySelector('ext-filefield');
let focusable = element.focusable;

true for keyboard interactive Components or Widgets, false otherwise. For Containers, this property reflects interactiveness of the Container itself, not its children. See isFocusable.

Note: It is not enough to set this property to true to make a component keyboard interactive. You also need to make sure that the component's focusEl is reachable via Tab key (tabbable). See also tabIndex.

Defaults to:

false

hasFocus : Boolean
readonly ro

<ext-filefield hasFocus="true" />
let element = document.body.querySelector('ext-filefield');
let hasFocus = element.hasFocus;

true if this component's focusEl is focused. See also containsFocus.

Defaults to:

false

hasListeners : Object
readonly ro

<ext-filefield hasListeners="{ }" />
let element = document.body.querySelector('ext-filefield');
let hasListeners = element.hasListeners;

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

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

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

height : Number / String

<ext-filefield height="value" />
let element = document.body.querySelector('ext-filefield');
element.height = 'value';
let height = element.height;

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hidden : Boolean

<ext-filefield hidden="true" />
let element = document.body.querySelector('ext-filefield');
element.hidden = true;
let hidden = element.hidden;

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

<ext-filefield hideAnimation="value" />
let element = document.body.querySelector('ext-filefield');
element.hideAnimation = 'value';
let hideAnimation = element.hideAnimation;

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

<ext-filefield hideMode="value" />
let element = document.body.querySelector('ext-filefield');
element.hideMode = 'value';
let hideMode = element.hideMode;

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

hideOnMaskTap : Boolean

<ext-filefield hideOnMaskTap="true" />
let element = document.body.querySelector('ext-filefield');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

html : String / Ext.dom.Element / HTMLElement

<ext-filefield html="value" />
let element = document.body.querySelector('ext-filefield');
element.html = 'value';
let html = element.html;

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

htmlErrorsTpl : Ext.XTemplate
readonly ro private pri

<ext-filefield htmlErrorsTpl="value" />
let element = document.body.querySelector('ext-filefield');
let htmlErrorsTpl = element.htmlErrorsTpl;

The default template used to format errors in HTML. This property is promoted to an Ext.XTemplate instance on first use.

Defaults to:

[
    '<tpl if="count == 1">',
    '<tpl for="errors">{.:htmlEncode}</tpl>',
    '<tpl elseif="count">',
    '<ul class="{listCls}">',
    '<tpl for="errors"><li>{.:htmlEncode}</li></tpl>',
    '</ul>',
    '</tpl>'
]

Available since: 6.5.0

id : String
immutable imm

<ext-filefield id="value" />
let element = document.body.querySelector('ext-filefield');
element.id = 'value';
let id = element.id;

The unique id of this component instance.

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

Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The <ext-container/> class contains shortcut methods to query its descendant Components by selector.

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

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

Defaults to an auto-assigned id.

inheritUi : Boolean / String
readonly ro

<ext-filefield inheritUi="true" />
let element = document.body.querySelector('ext-filefield');
element.inheritUi = true;
let inheritUi = element.inheritUi;

Set to true on widgets that should inherit ui from their parent container. This property is typically set on the class body, but can be set on an instance as long as it is set prior to the instance being added to its container. This property is inspected at the moment a widget is added to a container, and any UIs on the container are added to the widget at that time. Inherited UIs are in addition to the widget's own ui, and are updated when the container's UI changes.

Defaults to:

false

initFocusable
readonly ro protected pro

<ext-filefield initFocusable="value" />
let element = document.body.querySelector('ext-filefield');
element.initFocusable = 'value';
let initFocusable = element.initFocusable;

Template method to do any Focusable related initialization that does not involve event listeners creation.

Defaults to:

Ext.emptyFn

inline : Boolean

<ext-filefield inline="true" />
let element = document.body.querySelector('ext-filefield');
element.inline = true;
let inline = element.inline;

true to cause this field to layout with inline element behavior. An inline field's width is determined by the total width of its label and body elements instead of automatically expanding to fill the width of its container.

Defaults to:

false

inputCls : String
deprecated dep immutable imm

<ext-filefield inputCls="value" />
let element = document.body.querySelector('ext-filefield');
element.inputCls = 'value';
let inputCls = element.inputCls;

Deprecated since version 6.5.0
There is no longer an input component to which to add a class.

inputMask : String / Ext.field.InputMask

<ext-filefield inputMask="value" />
let element = document.body.querySelector('ext-filefield');
element.inputMask = 'value';
let inputMask = element.inputMask;

Important: To use this config you must require Ext.field.InputMask or use a complete framework build. The logic to implement an inputMask is not automatically included in a build.

Defaults to:

null

Available since: 6.5.0

inputType : String

<ext-filefield inputType="value" />
let element = document.body.querySelector('ext-filefield');
element.inputType = 'value';
let inputType = element.inputType;

The type attribute for input fields -- e.g. text, password, date, url, email, etc.

Defaults to:

'text'

inputValue
private pri

<ext-filefield inputValue="value" />
let element = document.body.querySelector('ext-filefield');
element.inputValue = 'value';
let inputValue = element.inputValue;

Defaults to:

null

instanceCls : String / String[]
private pri

<ext-filefield instanceCls="value" />
let element = document.body.querySelector('ext-filefield');
element.instanceCls = 'value';
let instanceCls = element.instanceCls;

An extra CSS class or classes to augment the classCls on an individual instance

Defaults to:

null

Available since: 6.5.0

isComponent
readonly ro private pri

<ext-filefield isComponent="value" />
let element = document.body.querySelector('ext-filefield');
element.isComponent = 'value';
let isComponent = element.isComponent;

Defaults to:

true

isConfiguring : Boolean
readonly ro protected pro

<ext-filefield isConfiguring="true" />
let element = document.body.querySelector('ext-filefield');
let isConfiguring = element.isConfiguring;

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

Defaults to:

false

Available since: 5.0.0

isField : Boolean
readonly ro

<ext-filefield isField="true" />
let element = document.body.querySelector('ext-filefield');
let isField = element.isField;

true in this class to identify an object this type, or subclass thereof.

This is used by Ext.form.Panel#getValues to determine which components inside a form are fields.

Defaults to:

true

isFile
readonly ro private pri

<ext-filefield isFile="value" />
let element = document.body.querySelector('ext-filefield');
element.isFile = 'value';
let isFile = element.isFile;

Defaults to:

true

isFirstInstance : Boolean
readonly ro protected pro

<ext-filefield isFirstInstance="true" />
let element = document.body.querySelector('ext-filefield');
let isFirstInstance = element.isFirstInstance;

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

Defaults to:

false

Available since: 5.0.0

isFormField
readonly ro private pri

<ext-filefield isFormField="value" />
let element = document.body.querySelector('ext-filefield');
element.isFormField = 'value';
let isFormField = element.isFormField;

Defaults to:

true

isInner
readonly ro private pri

<ext-filefield isInner="value" />
let element = document.body.querySelector('ext-filefield');
element.isInner = 'value';
let isInner = element.isInner;

Defaults to:

true

isInstance : Boolean
readonly ro protected pro

<ext-filefield isInstance="true" />
let element = document.body.querySelector('ext-filefield');
let isInstance = element.isInstance;

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

Defaults to:

true

isObservable : Boolean
readonly ro

<ext-filefield isObservable="true" />
let element = document.body.querySelector('ext-filefield');
element.isObservable = true;
let isObservable = element.isObservable;

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

Defaults to:

true

itemId : String

<ext-filefield itemId="value" />
let element = document.body.querySelector('ext-filefield');
element.itemId = 'value';
let itemId = element.itemId;

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

Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.

Defaults to:

undefined

keyMap : Object

<ext-filefield keyMap="{ }" />
let element = document.body.querySelector('ext-filefield');
element.keyMap = { };
let keyMap = element.keyMap;

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function(either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Defaults to:

null

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

<ext-filefield keyMapEnabled="true" />
let element = document.body.querySelector('ext-filefield');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by <ext-component/> at the proper time, this is not something application code normally handles.

Defaults to:

null

keyMapTarget : String
immutable imm protected pro

<ext-filefield keyMapTarget="value" />
let element = document.body.querySelector('ext-filefield');
element.keyMapTarget = 'value';
let keyMapTarget = element.keyMapTarget;

The name of the member that should be used to listen for keydown/keypress events. This is intended to be controlled at the class level not per instance.

Defaults to:

'el'

label : String

<ext-filefield label="value" />
let element = document.body.querySelector('ext-filefield');
element.label = 'value';
let label = element.label;

The label of this field

Defaults to:

null

labelAlign : 'top' / 'left' / 'bottom' / 'right'

<ext-filefield labelAlign="value" />
let element = document.body.querySelector('ext-filefield');
element.labelAlign = 'value';
let labelAlign = element.labelAlign;

When value is 'placeholder', the label text will be rendered as placeholder text inside the empty input and will animated to "top" alignment when the input is focused or contains text. The position to render the label relative to the field body.

Defaults to:

'left'

labelCls : String

<ext-filefield labelCls="value" />
let element = document.body.querySelector('ext-filefield');
element.labelCls = 'value';
let labelCls = element.labelCls;

Optional CSS class to add to the Label element.

Defaults to:

null

labelInPlaceholder
private pri

<ext-filefield labelInPlaceholder="value" />
let element = document.body.querySelector('ext-filefield');
element.labelInPlaceholder = 'value';
let labelInPlaceholder = element.labelInPlaceholder;

Defaults to:

true

labelMinWidth : Number / String

<ext-filefield labelMinWidth="value" />
let element = document.body.querySelector('ext-filefield');
element.labelMinWidth = 'value';
let labelMinWidth = element.labelMinWidth;

Min-width of this field's label.

Defaults to:

null

labelTextAlign : 'top' / 'right' / 'bottom' / 'left'

<ext-filefield labelTextAlign="value" />
let element = document.body.querySelector('ext-filefield');
element.labelTextAlign = 'value';
let labelTextAlign = element.labelTextAlign;

Text alignment of this field's label

Defaults to:

'left'

labelWidth : Number / String

<ext-filefield labelWidth="value" />
let element = document.body.querySelector('ext-filefield');
element.labelWidth = 'value';
let labelWidth = element.labelWidth;

Width of this field's label. Can be a number of pixels or any valid CSS value, such as '30%'. To size the label to its text, use labelWidth: 'auto'

Defaults to:

null

labelWrap : Boolean

<ext-filefield labelWrap="true" />
let element = document.body.querySelector('ext-filefield');
element.labelWrap = true;
let labelWrap = element.labelWrap;

true to allow the label to wrap. If set to false, the label will be truncated with an ellipsis.

Defaults to:

false

lastKeyMapEvent : Ext.event.Event
readonly ro

<ext-filefield lastKeyMapEvent="value" />
let element = document.body.querySelector('ext-filefield');
element.lastKeyMapEvent = 'value';
let lastKeyMapEvent = element.lastKeyMapEvent;

The last key event processed is cached on the component for use in subsequent event handlers.

Available since: 6.6.0

left : Number / String

<ext-filefield left="value" />
let element = document.body.querySelector('ext-filefield');
element.left = 'value';
let left = element.left;

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

<ext-filefield listeners="{ }" />
let element = document.body.querySelector('ext-filefield');
element.listeners = { };
let listeners = element.listeners;

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

DOM events from Ext JS <ext-component/>

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

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

margin : Number / String

<ext-filefield margin="value" />
let element = document.body.querySelector('ext-filefield');
element.margin = 'value';
let margin = element.margin;

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to:

null

maxHeight : Number / String

<ext-filefield maxHeight="value" />
let element = document.body.querySelector('ext-filefield');
element.maxHeight = 'value';
let maxHeight = element.maxHeight;

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxLength : Number

<ext-filefield maxLength="10" />
let element = document.body.querySelector('ext-filefield');
element.maxLength = 10;
let maxLength = element.maxLength;

The maximum number of permitted input characters.

Defaults to:

null

maxWidth : Number / String

<ext-filefield maxWidth="value" />
let element = document.body.querySelector('ext-filefield');
element.maxWidth = 'value';
let maxWidth = element.maxWidth;

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

minHeight : Number / String

<ext-filefield minHeight="value" />
let element = document.body.querySelector('ext-filefield');
element.minHeight = 'value';
let minHeight = element.minHeight;

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

<ext-filefield minWidth="value" />
let element = document.body.querySelector('ext-filefield');
element.minWidth = 'value';
let minWidth = element.minWidth;

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

<ext-filefield modal="true" />
let element = document.body.querySelector('ext-filefield');
element.modal = true;
let modal = element.modal;

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

modelValidation : Boolean
immutable imm

<ext-filefield modelValidation="true" />
let element = document.body.querySelector('ext-filefield');
element.modelValidation = true;
let modelValidation = element.modelValidation;

This config enables binding to your Ext.data.Model#validators. This is only processed by form fields (e.g., Ext.field.*) at present, however, this setting is inherited and so can be set on a parent container.

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

Defaults to:

null

Available since: 6.5.0

multiple : Boolean
immutable imm

<ext-filefield multiple="true" />
let element = document.body.querySelector('ext-filefield');
element.multiple = true;
let multiple = element.multiple;

Allow selection of multiple files

Defaults to:

false

name : String

<ext-filefield name="value" />
let element = document.body.querySelector('ext-filefield');
element.name = 'value';
let name = element.name;

The field's name. Used by form panels to gather data to be submitted.

For <ext-inputfield/> this name is set as the name attribute of the inputElement

Defaults to:

null

nameable : Boolean
immutable imm

<ext-filefield nameable="true" />
let element = document.body.querySelector('ext-filefield');
element.nameable = true;
let nameable = element.nameable;

Set to true for this component's name property to be tracked by its containing nameHolder.

Defaults to:

false

noBorderCls : String
readonly ro private pri

<ext-filefield noBorderCls="value" />
let element = document.body.querySelector('ext-filefield');
let noBorderCls = element.noBorderCls;

The CSS class to add to this component should not have a border.

Defaults to:

Ext.baseCSSPrefix + 'noborder-trbl'

originalValue : Mixed
readonly ro private pri

<ext-filefield originalValue="value" />
let element = document.body.querySelector('ext-filefield');
element.originalValue = 'value';
let originalValue = element.originalValue;

The original value when the field was instantiated.

Defaults to:

null

padding : Number / String

<ext-filefield padding="value" />
let element = document.body.querySelector('ext-filefield');
element.padding = 'value';
let padding = element.padding;

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

parseValidator : Ext.data.validator.Validator
private pri

<ext-filefield parseValidator="value" />
let element = document.body.querySelector('ext-filefield');
element.parseValidator = 'value';
let parseValidator = element.parseValidator;

Defaults to:

null

Available since: 6.5.1

pattern : String

<ext-filefield pattern="value" />
let element = document.body.querySelector('ext-filefield');
element.pattern = 'value';
let pattern = element.pattern;

The value for the HTML5 pattern attribute. You can use this to change which keyboard layout will be used.

Ext.define('Ux.field.Pattern', {
    extend : 'Ext.field.Text',
    xtype  : 'patternfield',

    config : {

component : { pattern : '[0-9]*' } } });

Even though it extends <ext-textfield/>, it will display the number keyboard.

Defaults to:

null

placeHolder : String
deprecated dep immutable imm

<ext-filefield placeHolder="value" />
let element = document.body.querySelector('ext-filefield');
element.placeHolder = 'value';
let placeHolder = element.placeHolder;

A string value displayed in the input when the control is empty.

Deprecated since version 6.5.0
Use the all lowercase placeholder config.

placeholder : String

<ext-filefield placeholder="value" />
let element = document.body.querySelector('ext-filefield');
element.placeholder = 'value';
let placeholder = element.placeholder;

A string value displayed in the input when the control is empty.

Defaults to:

null

plainErrorsTpl : Ext.XTemplate
readonly ro private pri

<ext-filefield plainErrorsTpl="value" />
let element = document.body.querySelector('ext-filefield');
let plainErrorsTpl = element.plainErrorsTpl;

The default template used to format errors as plain text. This property is promoted to an Ext.XTemplate instance on first use.

Defaults to:

[
    '<tpl if="count">',
    '<tpl for="errors" between="\\n">{.}</tpl>',
    '</tpl>'
]

Available since: 6.5.0

plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract

<ext-filefield plugins="{ }" />
let element = document.body.querySelector('ext-filefield');
element.plugins = { };
let plugins = element.plugins;

This config describes one or more plugin config objects used to create plugin instances for this component.

Plugins are a way to bundle and reuse custom functionality. Plugins should extend Ext.plugin.Abstract but technically the only requirement for a valid plugin is that it contain an init method that accepts a reference to its owner. Once a plugin is created, the owner will call the init method, passing a reference to itself. Each plugin can then call methods or respond to events on its owner as needed to provide its functionality.

This config's value can take several different forms.

The value can be a single string with the plugin's Ext.enums.Plugin:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

In the above examples, the string "listpaging" is the type alias for listpaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         pullrefresh: true,
         listpaging: {
             autoPaging: true,
             weight: 10
         }
     }
 });

The object keys are the id's as well as the default type alias. This form allows the value of the plugins to be merged from base class to derived class and finally with the instance configuration. This allows classes to define a set of plugins that derived classes or instantiators can further configure or disable. This merge behavior is a feature of the config.

The plugins config can also be an array of plugin aliases (arrays are not merged so this form does not respect plugins defined by the class author):

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

An array can also contain elements that are config objects with a type property holding the type alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['pullrefresh', {
         type: 'listpaging',
         autoPaging: true
     }]
 });

Defaults to:

null

positioned
readonly ro private pri

<ext-filefield positioned="value" />
let element = document.body.querySelector('ext-filefield');
element.positioned = 'value';
let positioned = element.positioned;

Defaults to:

false

publishes : String / String[] / Object

<ext-filefield publishes="value" />
let element = document.body.querySelector('ext-filefield');
element.publishes = 'value';
let publishes = element.publishes;

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

This config uses the cfg-reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and cfg-reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

  setFieldLabel: function(fieldLabel) {
      this.callParent(arguments);
      this.publishState('fieldLabel', fieldLabel);
  }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to:

{
    value: 1
}

readOnly : Boolean

<ext-filefield readOnly="true" />
let element = document.body.querySelector('ext-filefield');
element.readOnly = true;
let readOnly = element.readOnly;

true to set the field DOM element readonly attribute to "true".

Mutation of <ext-textfield/> through triggers is also disabled.

To simply prevent typing into the field while still allowing mutation through triggers, set editable to false.

Defaults to:

false

record : Ext.data.Model

<ext-filefield record="value" />
let element = document.body.querySelector('ext-filefield');
element.record = 'value';
let record = element.record;

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

reference : String
immutable imm

<ext-filefield reference="value" />
let element = document.body.querySelector('ext-filefield');
element.reference = 'value';
let reference = element.reference;

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Defaults to:

null

relative : Boolean

<ext-filefield relative="true" />
let element = document.body.querySelector('ext-filefield');
element.relative = true;
let relative = element.relative;

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

false

Available since: 6.2.0

rendered : Boolean
readonly ro

<ext-filefield rendered="true" />
let element = document.body.querySelector('ext-filefield');
let rendered = element.rendered;

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

required : Boolean

<ext-filefield required="true" />
let element = document.body.querySelector('ext-filefield');
element.required = true;
let required = element.required;

true to make this field required.

Defaults to:

false

requiredMessage : String

<ext-filefield requiredMessage="value" />
let element = document.body.querySelector('ext-filefield');
element.requiredMessage = 'value';
let requiredMessage = element.requiredMessage;

The error message to display when required is true and the field's value is "empty" (null, undefined, or empty string).

Defaults to:

'This field is required'

right : Number / String

<ext-filefield right="value" />
let element = document.body.querySelector('ext-filefield');
element.right = 'value';
let right = element.right;

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

ripple : Boolean / Object / String

<ext-filefield ripple="true" />
let element = document.body.querySelector('ext-filefield');
element.ripple = true;
let ripple = element.ripple;

Set to truthy, Color or Object value for the ripple.

Defaults to:

null

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

scrollable : Boolean / String / Object

<ext-filefield scrollable="true" />
let element = document.body.querySelector('ext-filefield');
element.scrollable = true;
let scrollable = element.scrollable;

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

self : Ext.Class
readonly ro protected pro

<ext-filefield self="value" />
let element = document.body.querySelector('ext-filefield');
element.self = 'value';
let self = element.self;

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

session : Boolean / Object / Ext.data.Session

<ext-filefield session="true" />
let element = document.body.querySelector('ext-filefield');
element.session = true;
let session = element.session;

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to:

null

shadow : Boolean

<ext-filefield shadow="true" />
let element = document.body.querySelector('ext-filefield');
element.shadow = true;
let shadow = element.shadow;

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Defaults to:

null

Available since: 6.2.0

shadowCls : String
readonly ro private pri

<ext-filefield shadowCls="value" />
let element = document.body.querySelector('ext-filefield');
let shadowCls = element.shadowCls;

The CSS class to add to this component when it has a shadow.

Defaults to:

Ext.baseCSSPrefix + 'shadow'

shareableName : Boolean
immutable imm

<ext-filefield shareableName="true" />
let element = document.body.querySelector('ext-filefield');
element.shareableName = true;
let shareableName = element.shareableName;

Set to true to allow this component's name to be shared by other items in the same nameHolder. Such items will be returned in an array from lookupName.

Defaults to:

false

shim : Boolean

<ext-filefield shim="true" />
let element = document.body.querySelector('ext-filefield');
element.shim = true;
let shim = element.shim;

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

false

Available since: 6.2.0

shimCls : String
readonly ro private pri

<ext-filefield shimCls="value" />
let element = document.body.querySelector('ext-filefield');
let shimCls = element.shimCls;

The CSS class to add to this component's shim element if enabled.

Defaults to:

"x-shim"

showAnimation : String / Mixed

<ext-filefield showAnimation="value" />
let element = document.body.querySelector('ext-filefield');
element.showAnimation = 'value';
let showAnimation = element.showAnimation;

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

sideError : String
private pri

<ext-filefield sideError="value" />
let element = document.body.querySelector('ext-filefield');
element.sideError = 'value';
let sideError = element.sideError;

Defaults to:

null

stateId : String

<ext-filefield stateId="value" />
let element = document.body.querySelector('ext-filefield');
element.stateId = 'value';
let stateId = element.stateId;

The unique id for this object to use for state management purposes.

Defaults to:

null

stateful : Boolean / Object / String[]

<ext-filefield stateful="true" />
let element = document.body.querySelector('ext-filefield');
element.stateful = true;
let stateful = element.stateful;

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

statefulDefaults : Object / String[]
protected pro

<ext-filefield statefulDefaults="value" />
let element = document.body.querySelector('ext-filefield');
element.statefulDefaults = 'value';
let statefulDefaults = element.statefulDefaults;

The default set of stateful properties. The form of this config is the same as stateful except this config cannot be a Boolean.

This config is intended for classes to specify so that instances can simply enable statefulness using stateful: true.

Defaults to:

null

stripCharsRe : RegExp
immutable imm

<ext-filefield stripCharsRe="value" />
let element = document.body.querySelector('ext-filefield');
element.stripCharsRe = 'value';
let stripCharsRe = element.stripCharsRe;

A JavaScript RegExp object used to strip unwanted content from the value during input. If stripCharsRe is specified, every character sequence matching stripCharsRe will be removed.

style : String / Object

<ext-filefield style="value" />
let element = document.body.querySelector('ext-filefield');
element.style = 'value';
let style = element.style;

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

<ext-filefield tabIndex="10" />
let element = document.body.querySelector('ext-filefield');
element.tabIndex = 10;
let tabIndex = element.tabIndex;

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

tag : String
readonly ro protected pro

<ext-filefield tag="value" />
let element = document.body.querySelector('ext-filefield');
element.tag = 'value';
let tag = element.tag;

The tag name to use for this field's input element. Subclasses should override this property on their class body. Not intended for instance-level use.

Defaults to:

'input'

template : Array
readonly ro protected pro

<ext-filefield template="value" />
let element = document.body.querySelector('ext-filefield');
element.template = 'value';
let template = element.template;

An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.

Defaults to:

[]

textAlign : 'left' / 'center' / 'right'

<ext-filefield textAlign="value" />
let element = document.body.querySelector('ext-filefield');
element.textAlign = 'value';
let textAlign = element.textAlign;

The text alignment of this field.

Defaults to:

'left'

tipError : String
private pri

<ext-filefield tipError="value" />
let element = document.body.querySelector('ext-filefield');
element.tipError = 'value';
let tipError = element.tipError;

Defaults to:

null

titleError : String
private pri

<ext-filefield titleError="value" />
let element = document.body.querySelector('ext-filefield');
element.titleError = 'value';
let titleError = element.titleError;

Defaults to:

null

toFrontOnShow : Boolean

<ext-filefield toFrontOnShow="true" />
let element = document.body.querySelector('ext-filefield');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

tooltip : String / Object

<ext-filefield tooltip="value" />
let element = document.body.querySelector('ext-filefield');
element.tooltip = 'value';
let tooltip = element.tooltip;

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or <ext-tooltip/> config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

top : Number / String

<ext-filefield top="value" />
let element = document.body.querySelector('ext-filefield');
element.top = 'value';
let top = element.top;

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object

<ext-filefield touchAction="{ }" />
let element = document.body.querySelector('ext-filefield');
element.touchAction = { };
let touchAction = element.touchAction;

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

<ext-filefield tpl="value" />
let element = document.body.querySelector('ext-filefield');
element.tpl = 'value';
let tpl = element.tpl;

A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

<ext-filefield tplWriteMode="value" />
let element = document.body.querySelector('ext-filefield');
element.tplWriteMode = 'value';
let tplWriteMode = element.tplWriteMode;

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to:

'overwrite'

translatable : Object
private pri

<ext-filefield translatable="{ }" />
let element = document.body.querySelector('ext-filefield');
element.translatable = { };
let translatable = element.translatable;

Defaults to:

null

triggers : Object

<ext-filefield triggers="{ }" />
let element = document.body.querySelector('ext-filefield');
element.triggers = { };
let triggers = element.triggers;

<ext-trigger/> <ext-trigger.trigger/> to use in this field. The keys in this object are unique identifiers for the triggers. The values in this object are <ext-trigger/> <ext-trigger.trigger/> configuration objects.

Ext.create('Ext.field.Text', {
    label: 'My Custom Field',
    triggers: {

foo: { cls: 'my-foo-trigger', handler: function() { console.log('foo trigger clicked'); } }, bar: { cls: 'my-bar-trigger', handler: function() { console.log('bar trigger clicked'); } } } });

The weight value may be a negative value in order to position custom triggers ahead of default triggers like that of a DatePicker field.

Ext.create('Ext.form.DatePicker', {
    label: 'Pick a Date',
    triggers: {

foo: { cls: 'my-foo-trigger', weight: -2, // negative to place before default triggers handler: function() { console.log('foo trigger clicked'); } }, bar: { cls: 'my-bar-trigger', weight: -1, handler: function() { console.log('bar trigger clicked'); } } } });

Defaults to:

{
    clear: {
        type: 'clear'
    }
}

twoWayBindable : String / String[] / Object

<ext-filefield twoWayBindable="value" />
let element = document.body.querySelector('ext-filefield');
element.twoWayBindable = 'value';
let twoWayBindable = element.twoWayBindable;

This object holds a map of config properties that will update their binding as they are modified. For example, value is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Defaults to:

{
    value: 1
}

ui : String / String[]

<ext-filefield ui="value" />
let element = document.body.querySelector('ext-filefield');
element.ui = 'value';
let ui = element.ui;

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

uiReferences : Object
readonly ro private pri

<ext-filefield uiReferences="{ }" />
let element = document.body.querySelector('ext-filefield');
element.uiReferences = { };
let uiReferences = element.uiReferences;

A map that tracks all reference elements configured with a uiCls. Contains the element reference by default since the element always gets non-suffixed ui-specific CSS class names added to it (see syncUiCls)

underError : String
private pri

<ext-filefield underError="value" />
let element = document.body.querySelector('ext-filefield');
element.underError = 'value';
let underError = element.underError;

Defaults to:

null

userCls : String / String[]

<ext-filefield userCls="value" />
let element = document.body.querySelector('ext-filefield');
element.userCls = 'value';
let userCls = element.userCls;

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

userSelectable : Boolean / String / Object

<ext-filefield userSelectable="true" />
let element = document.body.querySelector('ext-filefield');
element.userSelectable = true;
let userSelectable = element.userSelectable;

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

userSelectableClsMap
readonly ro private pri

<ext-filefield userSelectableClsMap="value" />
let element = document.body.querySelector('ext-filefield');
element.userSelectableClsMap = 'value';
let userSelectableClsMap = element.userSelectableClsMap;

Defaults to:

{
    "true": Ext.baseCSSPrefix + 'user-selectable-auto',
    "false": Ext.baseCSSPrefix + 'user-selectable-none',
    all: Ext.baseCSSPrefix + 'user-selectable-all',
    auto: Ext.baseCSSPrefix + 'user-selectable-auto',
    text: Ext.baseCSSPrefix + 'user-selectable-text',
    none: Ext.baseCSSPrefix + 'user-selectable-none'
}

validRefRe : RegExp
readonly ro private pri

<ext-filefield validRefRe="value" />
let element = document.body.querySelector('ext-filefield');
element.validRefRe = 'value';
let validRefRe = element.validRefRe;

Regular expression used for validating reference values.

Defaults to:

/^[a-z_][a-z0-9_]*$/i

validateDisabled : Boolean

<ext-filefield validateDisabled="true" />
let element = document.body.querySelector('ext-filefield');
element.validateDisabled = true;
let validateDisabled = element.validateDisabled;

true to validate the field, even if it is disabled.

Defaults to:

false

validateOnInit : "none" / "auto" / "all"
readonly ro

<ext-filefield validateOnInit="value" />
let element = document.body.querySelector('ext-filefield');
element.validateOnInit = 'value';
let validateOnInit = element.validateOnInit;

Determines how initial values will handle validation

  • none: Will not validate any initial values
  • auto: Will only validate non-empty initial values
  • all: Will validate all initial values

Defaults to:

'auto'

validationMessage : String

<ext-filefield validationMessage="value" />
let element = document.body.querySelector('ext-filefield');
element.validationMessage = 'value';
let validationMessage = element.validationMessage;

For validation, regex, etc., this is the error message returned if field is invalid.

Defaults to:

'Is in the wrong format'

validators : Mixed

<ext-filefield validators="value" />
let element = document.body.querySelector('ext-filefield');
element.validators = 'value';
let validators = element.validators;

A validator or array of validators to be applied to the field.

When the field is validated, each validator is applied and if any one of them determines the field is invalid, the field will be marked as invalid. If you examine the field's validators, you will get an array of Ext.data.Validators.

Validation currently is synchronous. If you need to validate a field with interaction with a server, you would do this when the form is submitted.

A validator may be:

  • A regexp - if the field fails to match the regexp, it is invalid.
  • A function - the function will be called to validate the field; it should return false if invalid.

  • An object - an object with a member fn that is a function to be called to validate the field.

  • An instantiated Validator Ext.data.validator.Validator

Defaults to:

null

value : Mixed

<ext-filefield value="value" />
let element = document.body.querySelector('ext-filefield');
element.value = 'value';
let value = element.value;

The field's value

Defaults to:

null

viewModel : String / Object / Ext.app.ViewModel

<ext-filefield viewModel="value" />
let element = document.body.querySelector('ext-filefield');
element.viewModel = 'value';
let viewModel = element.viewModel;

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Ext.data.Session. This is determined by calling getInheritedSession.

Defaults to:

null

weight : Number

<ext-filefield weight="10" />
let element = document.body.querySelector('ext-filefield');
element.weight = 10;
let weight = element.weight;

This value controls this item's order in a weighted <ext-container/> (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

0

width : Number / String

<ext-filefield width="value" />
let element = document.body.querySelector('ext-filefield');
element.width = 'value';
let width = element.width;

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

x : Number

<ext-filefield x="10" />
let element = document.body.querySelector('ext-filefield');
element.x = 10;
let x = element.x;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

xtype : String
immutable imm

<ext-filefield xtype="value" />
let element = document.body.querySelector('ext-filefield');
element.xtype = 'value';
let xtype = element.xtype;

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom <ext-component/> like so:

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

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

y : Number

<ext-filefield y="10" />
let element = document.body.querySelector('ext-filefield');
element.y = 10;
let y = element.y;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

zIndex : Number

<ext-filefield zIndex="10" />
let element = document.body.querySelector('ext-filefield');
element.zIndex = 10;
let zIndex = element.zIndex;

The z-index to give this Component when it is rendered.

Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.

Defaults to:

null

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let _addDeclaredListeners = element._addDeclaredListeners(listeners);

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean

true if any listeners were added

_fixReference
private pri

let element = document.body.querySelector('ext-filefield');
element._fixReference();

Sets up a reference on our current reference holder.

_flushStateful
private pri

let element = document.body.querySelector('ext-filefield');
element._flushStateful();

This method is called before destroy to ensure that this instance's stateful properties are saved to persistent storage. Since this object is about to be destroyed, this cannot be delayed.

_getStateId String
private pri

let element = document.body.querySelector('ext-filefield');
let _getStateId = element._getStateId();

Returns the state id for this object.

Returns

:String

The stateId or the configured id.

activatePlugin ( type ) : Ext.plugin.Abstract
private pri

let element = document.body.querySelector('ext-filefield');
let activatePlugin = element.activatePlugin(type);

Creates a particular plugin type if defined in the plugins configuration.

Available since: 6.2.0

Parameters

type :  String

The type of the plugin.

Returns

:Ext.plugin.Abstract

The plugin that was created.

addAfterListener

let element = document.body.querySelector('ext-filefield');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ext-filefield');
element.addBeforeListener();

Alias for onBefore.

addCls ( cls, [prefix], [suffix] )

let element = document.body.querySelector('ext-filefield');
element.addCls(cls, prefix, suffix);

Adds a CSS class (or classes) to this Component's rendered element.

Parameters

cls :  String/String[]

The CSS class(es) to add.

prefix :  String (optional)

Optional prefix to add to each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to add to each class.

Defaults to: ""

addDelegatedListener ( eventName, fn, scope, options, order, caller, manager )
private pri

let element = document.body.querySelector('ext-filefield');
element.addDelegatedListener(eventName, fn, scope, options, order, caller, manager);

Adds a listeners with the "delegate" event option. Users should not invoke this method directly. Use the "delegate" event option of addListener instead.

Parameters

eventName :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  Object

addDeprecations ( deprecations )
private pri

let element = document.body.querySelector('ext-filefield');
element.addDeprecations(deprecations);

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

Parameters

deprecations :  Object

addElementReference ( name, domNode ) : Ext.dom.Element
private pri

let element = document.body.querySelector('ext-filefield');
let addElementReference = element.addElementReference(name, domNode);

Adds an element reference to this Widget instance.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

Returns

:Ext.dom.Element

addElementReferenceOnDemand ( name, domNode )
private pri

let element = document.body.querySelector('ext-filefield');
element.addElementReferenceOnDemand(name, domNode);

Reduces instantiation time for a Widget by lazily instantiating Ext.Element references the first time they are used. This optimization only works for elements with no listeners specified.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

addListener ( eventName, [fn], [scope], [options], [order] ) : Object
chainable ch

let element = document.body.querySelector('ext-filefield');
let addListener = element.addListener(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

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

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to <ext-component/>. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of <ext-component/> which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event arguments>...);

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

let element = document.body.querySelector('ext-filefield');
let addManagedListener = element.addManagedListener(item, ename, fn, scope, options);

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPlugin ( plugin )

let element = document.body.querySelector('ext-filefield');
element.addPlugin(plugin);

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

addTrigger ( name, trigger ) : Ext.field.trigger.Trigger

let element = document.body.querySelector('ext-filefield');
let addTrigger = element.addTrigger(name, trigger);

Adds a trigger to this text field.

Parameters

name :  String

Unique name (within this field) for the trigger. Cannot be the same as the name of an existing trigger for this field.

trigger :  Ext.field.trigger.Trigger/Object

The trigger instance or a config object for a trigger to add

Returns

:Ext.field.trigger.Trigger

The trigger that was added

adjustChildDirtyCount ( dirty )
private pri

let element = document.body.querySelector('ext-filefield');
element.adjustChildDirtyCount(dirty);

This method is called by descendants that use this mixin when their dirty state changes.

Parameters

dirty :  Boolean

The dirty state of the descendant component.

afterEdit
private pri

let element = document.body.querySelector('ext-filefield');
element.afterEdit();

Used to handle joining of a record to a tpl

afterErase
private pri

let element = document.body.querySelector('ext-filefield');
element.afterErase();

Used to handle joining of a record to a tpl

afterRender
template tpl

let element = document.body.querySelector('ext-filefield');
element.afterRender();

This method is called after the component is initially added to the DOM. If this component <ext-container/> other components, the afterRender method for child components is called before the parent's afterRender.

Implementations of this method should avoid reading from the DOM but are free to write to the DOM as needed. To read the DOM, consider implementing onRender instead.

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to manipulate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM in order to be manipulated correctly.

Available since: 6.5.0

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

alignTo ( component, alignment, options )
private pri

let element = document.body.querySelector('ext-filefield');
element.alignTo(component, alignment, options);

Parameters

component :  Object

alignment :  Object

options :  Object

applyBind ( binds, currentBindings ) : Object
private pri

let element = document.body.querySelector('ext-filefield');
let applyBind = element.applyBind(binds, currentBindings);

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyCentered ( centered ) : Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let applyCentered = element.applyCentered(centered);

Parameters

centered :  Boolean

Returns

:Boolean

applyPlugins ( plugins, oldPlugins )
private pri

let element = document.body.querySelector('ext-filefield');
element.applyPlugins(plugins, oldPlugins);

Applier for the plugins config property.

Parameters

plugins :  String[]/Object[]/Ext.plugin.Abstract[]

The new plugins to use.

oldPlugins :  Ext.plugin.Abstract[]

The existing plugins in use.

applySession ( session ) : Ext.data.Session
private pri

let element = document.body.querySelector('ext-filefield');
let applySession = element.applySession(session);

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyStyle ( style, oldStyle )
protected pro

let element = document.body.querySelector('ext-filefield');
element.applyStyle(style, oldStyle);

Parameters

style :  Object

oldStyle :  Object

applyTpl ( tpl )
private pri

let element = document.body.querySelector('ext-filefield');
element.applyTpl(tpl);

Parameters

tpl :  Object

applyValidators ( validators )
private pri

let element = document.body.querySelector('ext-filefield');
element.applyValidators(validators);

Parameters

validators :  Object

applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

let element = document.body.querySelector('ext-filefield');
let applyViewModel = element.applyViewModel(viewModel);

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

beforeInitialize
private pri

let element = document.body.querySelector('ext-filefield');
element.beforeInitialize();

beginSyncChildDirty
private pri

let element = document.body.querySelector('ext-filefield');
element.beginSyncChildDirty();

This method is called when the component hierarchy has changed and the current set of descendants will be reasserting their dirty state. This method is only called on nameHolder containers.

blur
private pri

let element = document.body.querySelector('ext-filefield');
element.blur();

bubble ( fn, [scope], [args] )

let element = document.body.querySelector('ext-filefield');
element.bubble(fn, scope, args);

Bubbles up the getRefOwner hierarchy, calling the specified function with each component. The scope (this reference) of the function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the bubble is stopped.

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope of the function. Defaults to current node.

args :  Array (optional)

The args to call the function with. Defaults to passing the current component.

callOverridden ( args ) : Object
deprecated dep protected pro

let element = document.body.querySelector('ext-filefield');
let callOverridden = element.callOverridden(args);

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

let element = document.body.querySelector('ext-filefield');
let callParent = element.callParent(args);

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

let element = document.body.querySelector('ext-filefield');
let callSuper = element.callSuper(args);

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

center Ext.Component
chainable ch

let element = document.body.querySelector('ext-filefield');
let center = element.center();

Center this cfg-floated or positioned Component in its parent.

Returns

:Ext.Component

this

clearDelegatedListeners
private pri

let element = document.body.querySelector('ext-filefield');
element.clearDelegatedListeners();

Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.

clearInvalid
deprecated dep

let element = document.body.querySelector('ext-filefield');
element.clearInvalid();

Mark field as valid.

Available since: 6.5.0

Deprecated since version 6.5.0
Use setError(null) instead. (for classic compatibility)

clearListeners

let element = document.body.querySelector('ext-filefield');
element.clearListeners();

Removes all listeners for this object including the managed listeners

clearManagedListeners

let element = document.body.querySelector('ext-filefield');
element.clearManagedListeners();

Removes all managed listeners for this object.

clearValue

let element = document.body.querySelector('ext-filefield');
element.clearValue();

Clears the value of this field.

completeEdit
protected pro

let element = document.body.querySelector('ext-filefield');
element.completeEdit();

Called when focus leaves this input field. Used to postprocess raw values and perform conversion and validation.

constructor ( config )

let element = document.body.querySelector('ext-filefield');
element.constructor(config);

Creates new Component.

Parameters

config :  Object

The standard configuration object.

createPlugin ( config ) : Ext.plugin.Abstract
private pri

let element = document.body.querySelector('ext-filefield');
let createPlugin = element.createPlugin(config);

Converts the provided type or config object into a plugin instance.

Parameters

config :  String/Object/Ext.plugin.Abstract

The plugin type, config object or instance.

Returns

:Ext.plugin.Abstract

createRelayer ( newName, [beginEnd] ) : Function
private pri

let element = document.body.querySelector('ext-filefield');
let createRelayer = element.createRelayer(newName, beginEnd);

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

newName :  String

The name under which to re-fire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

createTrigger ( name, trigger )
private pri

let element = document.body.querySelector('ext-filefield');
element.createTrigger(name, trigger);

Parameters

name :  Object

trigger :  Object

destroy

let element = document.body.querySelector('ext-filefield');
element.destroy();

Destroys the Widget. This method should not be overridden in custom Widgets, because it sets the flags and does final cleanup that must go last. Instead, override doDestroy method to add functionality at destruction time.

destroyMembers ( args )

let element = document.body.querySelector('ext-filefield');
element.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.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

let element = document.body.querySelector('ext-filefield');
let destroyPlugin = element.destroyPlugin(plugin);

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

didValueChange ( newVal, oldVal )
private pri

let element = document.body.querySelector('ext-filefield');
element.didValueChange(newVal, oldVal);

Checks if the value has changed. Allows subclasses to override for any more complex logic.

Parameters

newVal :  Object

oldVal :  Object

disable

let element = document.body.querySelector('ext-filefield');
element.disable();

Disables this Component

doAddListener ( name, fn, scope, options, order, caller, manager )
private pri

let element = document.body.querySelector('ext-filefield');
element.doAddListener(name, fn, scope, options, order, caller, manager);

Parameters

name :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  Object

doClearIconTap
private pri

let element = document.body.querySelector('ext-filefield');
element.doClearIconTap();

doDestroy

let element = document.body.querySelector('ext-filefield');
element.doDestroy();

Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component.

If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.

As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.

Available since: 6.2.0

doFireDelegatedEvent ( eventName, args )
private pri

let element = document.body.querySelector('ext-filefield');
element.doFireDelegatedEvent(eventName, args);

Fires a delegated event. Users should not invoke this method directly. It is called automatically by the framework as needed (see the "delegate" event option of addListener for more details.

Parameters

eventName :  Object

args :  Object

doFireEvent ( eventName, args, bubbles )
private pri

let element = document.body.querySelector('ext-filefield');
element.doFireEvent(eventName, args, bubbles);

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doInheritUi
private pri

let element = document.body.querySelector('ext-filefield');
element.doInheritUi();

doKeyUp ( me, e )
private pri

let element = document.body.querySelector('ext-filefield');
element.doKeyUp(me, e);

Called when a key has been pressed in the <input>

Parameters

me :  Object

e :  Object

doUninheritUi
private pri

let element = document.body.querySelector('ext-filefield');
element.doUninheritUi();

doValidate ( value, errors, [skipLazy] )
private pri

let element = document.body.querySelector('ext-filefield');
element.doValidate(value, errors, skipLazy);

This method is called by validate if the value is both non-empty (not null, undefined or '') and if the value can be parsed by the parseValue method. This parsing concern is technically only in play for <ext-textfield/> and derived classes (such as <ext-datefield/> <ext-datepickerfield/> and <ext-numberfield/>) but the guarantee here is that the value will be a parsed value and not the raw string and if the value cannot be parsed, this method will not be called.

Parameters

value :  Mixed

The (parsed) value

errors :  String[]

The array of validation errors

skipLazy :  Boolean (optional)

false (the default) to run all validators.

enable

let element = document.body.querySelector('ext-filefield');
element.enable();

Enables this Component

enableBubble ( eventNames )

let element = document.body.querySelector('ext-filefield');
element.enableBubble(eventNames);

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.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 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable
    // the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

The event name to bubble, or an Array of event names.

findFloatParent ( needsShow )
private pri

let element = document.body.querySelector('ext-filefield');
element.findFloatParent(needsShow);

The method finds this floated component's floatParent. That means a DOM positioning container which acts as a root element for sibling floated components, and allows allows floated components to be absolutely positioned, and their encapsulating elements to be reordered to produce a visual stacking effect.

This component's element is appended to its floatParent.

There is a global floatParent element, created on demand when the first top level floated component is shown. This may be an item child of a container configured with cfg-floated: true, or a free floated component which is programatically shown.

Child items of components inside a floated component may also be configured floated. These are give a floatParent which is created on demand wrapping the nearest floated ancestor. This means that when that ancestor's element is brought to the top of the stack (by moving its element to the end of its own floatParent), the descendant elements will automatically remain above.

Parameters

needsShow :  Object

findFocusTarget Ext.Component
private pri

let element = document.body.querySelector('ext-filefield');
let findFocusTarget = element.findFocusTarget();

Finds an alternate Component to focus if this Component is disabled while focused, or focused while disabled, or otherwise unable to focus.

In both cases, focus must not be lost to document.body, but must move to an intuitively connectible Component, either a sibling, or uncle or nephew.

This is both for the convenience of keyboard users, and also for when focus is tracked within a Component tree such as for ComboBoxes and their dropdowns.

For example, a ComboBox with a PagingToolbar in is BoundList. If the "Next Page" button is hit, the LoadMask shows and focuses, the next page is the last page, so the "Next Page" button is disabled. When the LoadMask hides, it attempt to focus the last focused Component which is the disabled "Next Page" button. In this situation, focus should move to a sibling within the PagingToolbar.

Returns

:Ext.Component

A closely related focusable Component to which focus can move.

findPlugin ( type ) : Ext.plugin.Abstract

let element = document.body.querySelector('ext-filefield');
let findPlugin = element.findPlugin(type);

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

The Plugin's type as specified by the class's alias configuration.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

finishSyncChildDirty
private pri

let element = document.body.querySelector('ext-filefield');
element.finishSyncChildDirty();

This method is called when the component hierarchy has changed after the current set of descendants has reasserted their dirty state. This method is only called on nameHolder containers.

fireAction ( eventName, args, fn, [scope], [options], [order] )
deprecated dep

let element = document.body.querySelector('ext-filefield');
element.fireAction(eventName, args, fn, scope, options, order);

Fires the specified event with the passed parameters and executes a function (action). By default, the action function will be executed after any "before" event handlers (as specified using the order option of addListener), but before any other handlers are fired. This gives the "before" handlers an opportunity to cancel the event by returning false, and prevent the action function from being called.

The action can also be configured to run after normal handlers, but before any "after" handlers (as specified using the order event option) by passing 'after' as the order parameter. This configuration gives any event handlers except for "after" handlers the opportunity to cancel the event and prevent the action function from being called.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function

The action function.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

Event options for the action function. Accepts any of the options of addListener

order :  String (optional)

The order to call the action function relative too the event handlers ('before' or 'after'). Note that this option is simply used to sort the action function relative to the event handlers by "priority". An order of 'before' is equivalent to a priority of 99.5, while an order of 'after' is equivalent to a priority of -99.5. See the priority option of addListener for more details.

Defaults to: 'before'

Deprecated since version 5.5
Use fireEventedAction instead.

fireDirtyChange
private pri

let element = document.body.querySelector('ext-filefield');
element.fireDirtyChange();

fireEvent ( eventName, args ) : Boolean

let element = document.body.querySelector('ext-filefield');
let fireEvent = element.fireEvent(eventName, args);

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventArgs ( eventName, args ) : Boolean

let element = document.body.querySelector('ext-filefield');
let fireEventArgs = element.fireEventArgs(eventName, args);

Fires the specified event with the passed parameter list.

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let fireEventedAction = element.fireEventedAction(eventName, args, fn, scope, fnArgs);

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

Returns

:Boolean

fireKey ( e )
private pri

let element = document.body.querySelector('ext-filefield');
element.fireKey(e);

Parameters

e :  Object

fixDirtyState
private pri

let element = document.body.querySelector('ext-filefield');
element.fixDirtyState();

This method is called after _fixReference() during the reference sync sweep. We need to inform our parent if we are a leaf component and if we are dirty. If we are a nameHolder then we'll inform the parent in finishSyncChildDirty.

focus ( [selectText] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let focus = element.focus(selectText);

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (optional)

If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

formatErrors ( errors ) : String
protected pro

let element = document.body.querySelector('ext-filefield');
let formatErrors = element.formatErrors(errors);

Formats the given error(s) based on the given errorTpl and the specified errorTarget.

Available since: 6.5.0

Parameters

errors :  String[]

Returns

:String

getAlignRegion ( component, alignment, options )
private pri

let element = document.body.querySelector('ext-filefield');
element.getAlignRegion(component, alignment, options);

Parameters

component :  Object

alignment :  Object

options :  Object

getAlignmentInfo ( component, alignment )
protected pro

let element = document.body.querySelector('ext-filefield');
element.getAlignmentInfo(component, alignment);

Prepares information on aligning this to component using alignment. Also checks to see if this is already aligned to component according to alignment.

Parameters

component :  Object

alignment :  Object

getAriaLabelEl ( [reference] ) : Ext.dom.Element
private pri

let element = document.body.querySelector('ext-filefield');
let getAriaLabelEl = element.getAriaLabelEl(reference);

Find component(s) that label or describe this component, and return the id(s) of their ariaEl elements.

Parameters

reference :  Function/String/String[] (optional)

Component reference, or array of component references, or a function that should return the proper attribute string. The function will be called in the context of the labelled component.

Returns

:Ext.dom.Element

Element id string, or null

getBubbleParent Ext.util.Observable
private pri

let element = document.body.querySelector('ext-filefield');
let getBubbleParent = element.getBubbleParent();

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable

The bubble parent. null is returned if no bubble target exists

getClassCls
private pri

let element = document.body.querySelector('ext-filefield');
element.getClassCls();

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

let element = document.body.querySelector('ext-filefield');
let getConfig = element.getConfig(name, peek, ifInitialized);

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.

getController Ext.app.ViewController

let element = document.body.querySelector('ext-filefield');
let getController = element.getController();

Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.

Returns

:Ext.app.ViewController

Returns this component's ViewController or null if one was not configured

getCurrentAlignmentInfo
private pri

let element = document.body.querySelector('ext-filefield');
element.getCurrentAlignmentInfo();

Current Alignment information from the last alignTo call

getCurrentConfig
private pri

let element = document.body.querySelector('ext-filefield');
element.getCurrentConfig();

getElementConfig Object
protected pro

let element = document.body.querySelector('ext-filefield');
let getElementConfig = element.getElementConfig();

A template method for modifying the element config before it is processed. By default adds the result of this.getTemplate() as the children array of element if children were not specified in the original element config. Typically this method should not need to be implemented in subclasses. Instead the element property should be use to configure the element template for a given Widget subclass.

This method is called once when the first instance of each Widget subclass is created. The element config object that is returned is cached and used as the template for all successive instances. The scope object for this method is the class prototype, not the instance.

Returns

:Object

the element config object

getFiles FileList

let element = document.body.querySelector('ext-filefield');
let getFiles = element.getFiles();

Returns the field files.

Returns

:FileList

List of the files selected.

getFloatParent Ext.Component
private pri

let element = document.body.querySelector('ext-filefield');
let getFloatParent = element.getFloatParent();

For cfg-floated components only.

Finds the owning cfg-floated component (if any) responsible for the base z-index stack position of this compoonent, and, if that component is cfg-relative, for the coordinate system in which this component is positioned.

If this is a top level floated component, this method will return null

Returns

:Ext.Component

The owning floated component or null if this component is top level floated.

getFloatWrap Ext.dom.Element
private pri

let element = document.body.querySelector('ext-filefield');
let getFloatWrap = element.getFloatWrap();

This method returns, or creates on demand the floatWrap element which wraps the passed floated component. It enables that floated component to act as a host for descendant floated components.

Returns

:Ext.dom.Element

The passed component's floatWrap element.

getFocusClsEl ( [focusEl] ) : Ext.dom.Element
protected pro

let element = document.body.querySelector('ext-filefield');
let getFocusClsEl = element.getFocusClsEl(focusEl);

Returns the element used to apply focus styling CSS class when Focusable's focusEl becomes focused. By default it is focusEl.

Parameters

focusEl :  Ext.dom.Element (optional)

Return focus styling element for the given focused element. This is used by Components implementing multiple focusable elements.

Returns

:Ext.dom.Element

The focus styling element.

getFocusEl Ext.dom.Element
protected pro

let element = document.body.querySelector('ext-filefield');
let getFocusEl = element.getFocusEl();

Returns the main focus holder element associated with this Focusable, i.e. the element that will be focused when Focusable's focus method is called. For most Focusables, this will be the focusEl.

Returns

:Ext.dom.Element

getHideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

Sets the value of hideMode

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getId String

let element = document.body.querySelector('ext-filefield');
let getId = element.getId();

Retrieves the id. This method Will auto-generate an id if one has not already been configured.

Returns

:String

id

getInherited ( [inner] ) : Object

let element = document.body.querySelector('ext-filefield');
let getInherited = element.getInherited(inner);

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

let element = document.body.querySelector('ext-filefield');
let getInheritedConfig = element.getInheritedConfig(property, skipThis);

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getInitialConfig ( [name] ) : Object/Mixed

let element = document.body.querySelector('ext-filefield');
let getInitialConfig = element.getInitialConfig(name);

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.

getLabelAlign : 'top' / 'left' / 'bottom' / 'right'

Sets the value of labelAlign

getLabelTextAlign : 'top' / 'right' / 'bottom' / 'left'

Sets the value of labelTextAlign

getModalSibling
private pri

let element = document.body.querySelector('ext-filefield');
element.getModalSibling();

Returns the topmost modal floated component (other then this one).

getPlugin ( id ) : Ext.plugin.Abstract

let element = document.body.querySelector('ext-filefield');
let getPlugin = element.getPlugin(id);

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         type: 'pullrefresh',
         id: 'foo'
     }]
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getProxiedConfigs ( name ) : Object
private pri

let element = document.body.querySelector('ext-filefield');
let getProxiedConfigs = element.getProxiedConfigs(name);

This method returns an object of all proxied config values for a given target. This is only useful during the class initialization phase to avoid passing in "wrong" initial config values for a child object and then proxying down all the configs from the parent.

This method is not typically called directly but rather mergeProxiedConfigs is more likely.

Available since: 6.5.0

Parameters

name :  String

The proxy target config name (in the class example, this would be "childThing").

Returns

:Object

getRawValue String

let element = document.body.querySelector('ext-filefield');
let getRawValue = element.getRawValue();

Returns the raw value of the field, without performing any normalization, conversion, or validation. To get a normalized and converted value see getValue.

Available since: 7.0

Returns

:String

value The raw String value of the field

getRefOwner
protected pro

let element = document.body.querySelector('ext-filefield');
element.getRefOwner();

Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.

By default this returns the Container which contains this Component.

This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

getRenderTarget Ext.dom.Element
private pri

let element = document.body.querySelector('ext-filefield');
let getRenderTarget = element.getRenderTarget();

Returns the element into which the html content and items should be rendered. This defaults to the bodyElement but derived classes can override this method to use a different element.

For containers his only applies to inner items, not docked items. The positioned items are rendered to the element returned by the {@link Ext.Container#getPositionedItemTarget method.

Available since: 6.5.0

Returns

:Ext.dom.Element

getScrollableClientRegion Ext.util.Region
private pri

let element = document.body.querySelector('ext-filefield');
let getScrollableClientRegion = element.getScrollableClientRegion();

This method is required by the Scroller to return the scrollable client region

Returns

:Ext.util.Region

The scrolling viewport region.

getSize Object

let element = document.body.querySelector('ext-filefield');
let getSize = element.getSize();

Returns the height and width of the Component.

Returns

:Object

The current height and width of the Component.

width :  Number

height :  Number

getStateBuilder ( [cache] ) : Ext.state.Builder
private pri

let element = document.body.querySelector('ext-filefield');
let getStateBuilder = element.getStateBuilder(cache);

Creates a state builder to access or edit this instance's state object. If this instance has a getStatefulOwner, the returned builder will have a parent reference that owner's state builder. This can be an arbitrarily deep chain but does proceed all the way up to the root instance (with no owner) since that is the instance that determines the ultimate state storage key.

Parameters

cache :  Boolean (optional)

Pass true to return a cached builder.

Defaults to: false

Returns

:Ext.state.Builder

getStatefulOwner Ext.state.Stateful/Array
private pri

let element = document.body.querySelector('ext-filefield');
let getStatefulOwner = element.getStatefulOwner();

This method allows a class to specify an owning stateful object. This is used by Ext.plugin.Abstract to save their state as part of their owning <ext-component/>.

The return value can be either a Stateful object or an array whose first element is a Stateful object. This object's state will be stored inside the state object of the returned Stateful object. If an array is returned, the elements beyond the first are sub-keys in the state object.

For example, Ext.plugin.Abstract implement this method like so:

 getStatefulOwner: function() {
     return [ this.cmp, 'plugins' ];
 }

The effect of this is to produce a state object like so:

 {
     plugins: {
         pluginId1: {
             //...
         }
     }
 }

In order for a child object's state to be saved and restored, all of its parents must also be stateful (i.e., have a stateId).

Returns

:Ext.state.Stateful/Array

getTabIndex Number

let element = document.body.querySelector('ext-filefield');
let getTabIndex = element.getTabIndex();

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getTextAlign : 'left' / 'center' / 'right'

Sets the value of textAlign

getTextSelection Array

let element = document.body.querySelector('ext-filefield');
let getTextSelection = element.getTextSelection();

Returns the selection range of an input element as an array of three values:

 [ start, end, direction ]

These have the same meaning as the parameters to select.

Available since: 6.5.0

Returns

:Array

getValue : Mixed

Sets the value of value

getX : Number

Sets the value of x

getXTypes String

let element = document.body.querySelector('ext-filefield');
let getXTypes = element.getXTypes();

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the <ext-component/> header.

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

Example usage:

var t = new Ext.field.Text();
alert(t.getXTypes());  // alerts 'component/field/textfield'

Returns

:String

The xtype hierarchy string.

getY : Number

Sets the value of y

handleBlurEvent ( info )
private pri

let element = document.body.querySelector('ext-filefield');
element.handleBlurEvent(info);

Parameters

info :  Object

handleFocusEvent ( info )
private pri

let element = document.body.querySelector('ext-filefield');
element.handleFocusEvent(info);

Parameters

info :  Object

hasCls ( className ) : Boolean

let element = document.body.querySelector('ext-filefield');
let hasCls = element.hasCls(className);

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

Parameters

className :  String

The CSS class to check for.

Returns

:Boolean

true if the class exists, else false.

hasConfig ( name )
private pri

let element = document.body.querySelector('ext-filefield');
element.hasConfig(name);

Parameters

name :  String

hasListener ( eventName ) : Boolean

let element = document.body.querySelector('ext-filefield');
let hasListener = element.hasListener(eventName);

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

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

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

hide ( [animation] ) : Ext.Component
chainable ch

let element = document.body.querySelector('ext-filefield');
let hide = element.hide(animation);

Hides this Component optionally using an animation.

Parameters

animation :  Object/Boolean (optional)

You can specify an animation here or a bool to use the hideAnimation config.

Returns

:Ext.Component

initBindable
private pri

let element = document.body.querySelector('ext-filefield');
element.initBindable();

This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

Available since: 5.0.0

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

let element = document.body.querySelector('ext-filefield');
let initConfig = element.initConfig(instanceConfig);

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

initDragConstraints ( draggable )
template tpl

let element = document.body.querySelector('ext-filefield');
element.initDragConstraints(draggable);

This method is called when a drag is initializing. This method should adjust the drag constraints to ensure all drag movements are properly restricted. See Ext.drag.Source#constrain.

Available since: 6.5.0

Parameters

draggable :  Ext.drag.Source

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

initElement
protected pro

let element = document.body.querySelector('ext-filefield');
element.initElement();

Initializes the Element for this Widget instance. If this is the first time a Widget of this type has been instantiated the element config will be processed to create an Element. This Element is then cached on the prototype (see afterCachedConfig) so that future instances can obtain their element by simply cloning the Element that was cached by the first instance.

initElementListeners ( elementConfig )
private pri

let element = document.body.querySelector('ext-filefield');
element.initElementListeners(elementConfig);

Called for the first instance of this Widget to create an object that contains the listener configs for all of the element references keyed by reference name. The object is cached on the prototype and has the following shape:

_elementListeners: {
    element: {
        click: 'onClick',
        scope: this
    },
    fooReference: {
        tap: {
            fn: someFunction,
            delay: 100
        }
    }
}

The returned object is prototype chained to the _elementListeners object of its superclass, and each key in the object is prototype chained to object with the corresponding key in the superclass _elementListeners. This allows element listeners to be inherited and overridden when subclassing widgets.

This method is invoked with the prototype object as the scope

Parameters

elementConfig :  Object

initFocusableElement ( force )
private pri

let element = document.body.querySelector('ext-filefield');
element.initFocusableElement(force);

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

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

Parameters

force :  Object

initFocusableEvents ( force )
protected pro

let element = document.body.querySelector('ext-filefield');
element.initFocusableEvents(force);

Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.

Parameters

force :  Object

initInheritedState ( inheritedState )
protected pro

let element = document.body.querySelector('ext-filefield');
element.initInheritedState(inheritedState);

Called by getInherited to initialize the inheritedState the first time it is requested.

Parameters

inheritedState :  Object

initKeyMap
protected pro

let element = document.body.querySelector('ext-filefield');
element.initKeyMap();

This method should be called when the instance is ready to start listening for keyboard events. This is called automatically for <ext-component/> and derived classes. This is done after the component is rendered.

initUiReference ( referenceName, uiCls, [isInstance] )
private pri

let element = document.body.querySelector('ext-filefield');
element.initUiReference(referenceName, uiCls, isInstance);

Initializes a "uiReference". Ui rerefences are reference elements that have classCls and ui info in their CSS class names. They can be used by setting uiCls in the template, or by invoking this method to setup the ui reference after element/template initialization (Toolable uses this for its dock wrapper)

Parameters

referenceName :  String

uiCls :  String

isInstance :  Boolean (optional)

pass false if this is not an instance-level reference

Defaults to: false

initialize
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.initialize();

Allows addition of behavior to the rendering phase.

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

insertFloatedDom ( needsShow )
private pri

let element = document.body.querySelector('ext-filefield');
element.insertFloatedDom(needsShow);

This method inserts this floated component's DOM into its owning floatParent.

Parameters

needsShow :  Object

invalidateInheritedState
private pri

let element = document.body.querySelector('ext-filefield');
element.invalidateInheritedState();

This method marks the current inherited state as invalid. The next time a call is made to getInherited the objects will be recreated and initialized.

Available since: 5.0.0

is ( selector ) : Boolean

let element = document.body.querySelector('ext-filefield');
let is = element.is(selector);

Tests whether this Widget matches a Ext.ComponentQuery selector string.

Parameters

selector :  String

The selector string to test against.

Returns

:Boolean

true if this Widget matches the selector.

isAncestor ( possibleDescendant ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isAncestor = element.isAncestor(possibleDescendant);

Determines whether this Component is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Component.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Component's subtree.

Returns

:Boolean

isBlurring ( e ) : Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let isBlurring = element.isBlurring(e);

Parameters

e :  Object

Returns

:Boolean

isBound ( [name] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isBound = element.isBound(name);

Determines if the passed property name is bound to ViewModel data.

Available since: 6.5.0

Parameters

name :  String (optional)

The property name to test. Defaults to the defaultBindProperty

Returns

:Boolean

true if the passed property receives data from a ViewModel.

isCentered Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let isCentered = element.isCentered();

Returns

:Boolean

isDescendantOf ( ancestor ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isDescendantOf = element.isDescendantOf(ancestor);

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isDestructing Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let isDestructing = element.isDestructing();

Determines if this Component is inside a Component tree which is destroyed, or is being destroyed.

Returns

:Boolean

true if this Component, or any ancestor is destroyed, or is being destroyed.

isDirty Boolean

let element = document.body.querySelector('ext-filefield');
let isDirty = element.isDirty();

Returns true if the value of this Field has been changed from its originalValue. Will return false if the field is disabled or has not been rendered yet.

Returns

:Boolean

true if this field has been changed from its original value (and is not disabled), false otherwise.

isDisabled Boolean

let element = document.body.querySelector('ext-filefield');
let isDisabled = element.isDisabled();

Returns true if this Component is currently disabled.

Returns

:Boolean

true if currently disabled.

isEnabled Boolean

let element = document.body.querySelector('ext-filefield');
let isEnabled = element.isEnabled();

Returns true if this Component is not currently disabled.

Returns

:Boolean

true if not currently disabled.

isEqual ( value1, value2 ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isEqual = element.isEqual(value1, value2);

Returns whether two field values are logically equal. Field implementations may override this to provide custom comparison logic appropriate for the particular field's data type.

Parameters

value1 :  Object

The first value to compare

value2 :  Object

The second value to compare

Returns

:Boolean

True if the values are equal, false if inequal.

isFocusable ( [deep] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isFocusable = element.isFocusable(deep);

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see <ext-container/> for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isFocusing ( e ) : Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let isFocusing = element.isFocusing(e);

Parameters

e :  Object

Returns

:Boolean

isHeighted
private pri

let element = document.body.querySelector('ext-filefield');
element.isHeighted();

isHidden ( [deep] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isHidden = element.isHidden(deep);

Returns true if this Component is currently hidden.

Parameters

deep :  Boolean/Ext.Widget (optional)

true to check if this component is hidden because a parent container is hidden. Alternatively, a reference to the top-most parent at which to stop climbing.

Defaults to: false

Returns

:Boolean

true if currently hidden.

isPainted
private pri

let element = document.body.querySelector('ext-filefield');
element.isPainted();

isRendered
private pri

let element = document.body.querySelector('ext-filefield');
element.isRendered();

isSuspended ( [event] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isSuspended = element.isSuspended(event);

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

isSyncing ( name ) : Boolean
private pri

let element = document.body.querySelector('ext-filefield');
let isSyncing = element.isSyncing(name);

Checks if a particular binding is synchronizing the value.

Parameters

name :  String

The name of the property being bound to.

Returns

:Boolean

true if the binding is syncing.

isValid

let element = document.body.querySelector('ext-filefield');
element.isValid();

Returns true if field is valid.

isVisible ( [deep] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isVisible = element.isVisible(deep);

Returns true if this Component is currently visible.

A Widget is visible if its element is not hidden, and has been rendered and has not been destroyed.

Parameters

deep :  Boolean (optional)

true to check if this component is visible and all parents are also visible.

Contrast this with the isHidden method which just checks the hidden state of the component.

Defaults to: false

Returns

:Boolean

true if currently visible.

isWidthed
private pri

let element = document.body.querySelector('ext-filefield');
element.isWidthed();

isXType ( xtype, [shallow] ) : Boolean

let element = document.body.querySelector('ext-filefield');
let isXType = element.isXType(xtype, shallow);

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). **If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.__

For a list of all available xtypes, see the <ext-component/> header.

Example usage:

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

Parameters

xtype :  String

The xtype to check for this Component.

shallow :  Boolean (optional)

false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

Returns

:Boolean

true if this component descends from the specified xtype, false otherwise.

loadState ( state, stateful ) : Object
private pri

let element = document.body.querySelector('ext-filefield');
let loadState = element.loadState(state, stateful);

This method is called to load state from the provided state builder. This method should return the config properties loaded from state.

This method, like saveState, can be overridden by derived classes:

 loadState: function(state) {
     var ret = this.callParent([ state ]);

     if (ret.foo) {
         // use custom data...

         delete ret.foo;  // remove it since it isn't a config
     }

     return ret;
 }

When overriding this method, it is also likely necessary to override saveState.

Parameters

state :  Ext.state.Builder

stateful :  Object

The stateful properties as an object keyed by config name.

Returns

:Object

lookupController ( [skipThis] ) : Ext.app.ViewController

let element = document.body.querySelector('ext-filefield');
let lookupController = element.lookupController(skipThis);

Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

Available since: 5.0.1

Parameters

skipThis :  Boolean (optional)

true to not consider the controller directly attached to this view (if it exists).

Defaults to: false

Returns

:Ext.app.ViewController

The controller. null if no controller is found.

lookupNameHolder ( [skipThis] ) : Ext.Component
private pri

let element = document.body.querySelector('ext-filefield');
let lookupNameHolder = element.lookupNameHolder(skipThis);

Gets the Form or Component that is used as the name holder for this component.

Available since: 6.5.0

Parameters

skipThis :  Boolean (optional)

false to return this as the name holder if this instance has set nameHolder. Unlike getInheritedConfig this method defaults to true because it is possible that a name property set by the owner of a component that is also a nameHolder itself. In this case, the name connects not to this component but to the parent nameHolder.

Defaults to: true

Returns

:Ext.Component

The name holder.

lookupReferenceHolder ( [skipThis] ) : Ext.app.ViewController/Ext.Container
private pri

let element = document.body.querySelector('ext-filefield');
let lookupReferenceHolder = element.lookupReferenceHolder(skipThis);

Gets the Controller or Component that is used as the reference holder for this view.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

false to return this as the reference holder if this instance has set referenceHolder. Unlike getInheritedConfig this method defaults to true because it is possible that a reference property set by the owner of a component that is also a referenceHolder itself. In this case, the reference connects not to this component but to the parent referenceHolder.

Defaults to: true

Returns

:Ext.app.ViewController/Ext.Container

The reference holder.

lookupSession ( [skipThis] ) : Ext.data.Session

let element = document.body.querySelector('ext-filefield');
let lookupSession = element.lookupSession(skipThis);

Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass true to ignore a session configured on this instance and only consider an inherited session.

Defaults to: false

Returns

:Ext.data.Session

lookupTpl ( name ) : Ext.XTemplate

let element = document.body.querySelector('ext-filefield');
let lookupTpl = element.lookupTpl(name);

Gets a named template instance for this class. See Ext.XTemplate#getTpl.

Available since: 6.2.0

Parameters

name :  String

The name of the property that holds the template.

Returns

:Ext.XTemplate

The template, null if not found.

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

let element = document.body.querySelector('ext-filefield');
let lookupViewModel = element.lookupViewModel(skipThis);

Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass true to ignore a viewModel configured on this instance and only consider an inherited view model.

Defaults to: false

Returns

:Ext.app.ViewModel

markInvalid ( messages )
deprecated dep

let element = document.body.querySelector('ext-filefield');
element.markInvalid(messages);

Mark field as invalid.

Available since: 6.5.0

Parameters

messages :  Object

Deprecated since version 6.5.0
Use setError instead. (for classic compatibility)

mergeProxiedConfigs ( name, itemConfig, [alwaysClone] ) : Object
private pri

let element = document.body.querySelector('ext-filefield');
let mergeProxiedConfigs = element.mergeProxiedConfigs(name, itemConfig, alwaysClone);

This method accepts the normal config object (itemConfig) for the child object (name) and merges any proxied configs into a new config object. This is useful during the class initialization phase to avoid passing in "wrong" initial config values for a child object and then proxying down the rest of the configs.

This method is typically called during an "applier" method for a proxy target. If called at any other time this method simply returns the given itemConfig. This makes it safe to code such appliers as follows:

 applyChildThing: function(config) {
     config = this.mergeProxiedConfigs('childThing', config);

     return new ChildThing(config);
 }

Available since: 6.5.0

Parameters

name :  String

The proxy target config name (in the class example, this would be "childThing").

itemConfig :  Mixed

The default configuration for the child item.

alwaysClone :  Boolean (optional)

Pass true to ensure a new object is returned.

Returns

:Object

mon ( item, ename, [fn], [scope], [options] ) : Object

let element = document.body.querySelector('ext-filefield');
let mon = element.mon(item, ename, fn, scope, options);

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

mun ( item, ename, [fn], [scope] )

let element = document.body.querySelector('ext-filefield');
element.mun(item, ename, fn, scope);

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

on ( eventName, [fn], [scope], [options], [order] ) : Object

let element = document.body.querySelector('ext-filefield');
let on = element.on(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

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

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to <ext-component/>. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of <ext-component/> which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event arguments>...);

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

onAdded ( parent, instanced )
private pri

let element = document.body.querySelector('ext-filefield');
element.onAdded(parent, instanced);

Parameters

parent :  Object

instanced :  Object

onAfter ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ext-filefield');
element.onAfter(eventName, fn, scope, options);

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

onBefore ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ext-filefield');
element.onBefore(eventName, fn, scope, options);

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

onBlur ( e )
private pri

let element = document.body.querySelector('ext-filefield');
element.onBlur(e);

Parameters

e :  Object

onFocus ( e )
private pri

let element = document.body.querySelector('ext-filefield');
element.onFocus(e);

Parameters

e :  Object

onFocusEnter ( e )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onFocusEnter(e);

Called when focus enters this Component's hierarchy

Parameters

e :  Object

event :  Ext.event.Event

The underlying DOM event.

target :  HTMLElement

The element gaining focus.

relatedTarget :  HTMLElement

The element losing focus.

toComponent :  <ext-component/>

The Component gaining focus.

fromComponent :  <ext-component/>

The Component losing focus.

backwards :  Boolean

true if the fromComponent is after the toComponent* in the DOM tree, indicating that the user usedSHIFT+TABto move focus. Note that settingtabIndexvalues to affect tabbing order can cause this to be incorrect. SettingtabIndex values is not advised.

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

onFocusLeave ( e )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onFocusLeave(e);

Called when focus exits from this Component's hierarchy

Parameters

e :  Ext.event.Event

event :  Ext.event.Event

The underlying DOM event.

target :  HTMLElement

The element gaining focus.

relatedTarget :  HTMLElement

The element losing focus.

toComponent :  <ext-component/>

The Component gaining focus.

fromComponent :  <ext-component/>

The Component losing focus.

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

onFocusMove ( info )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onFocusMove(info);

Called when focus moves within this Component's hierarchy

Parameters

info :  Object

event :  Ext.event.Event

The underlying Event object.

toElement :  HTMLElement

The element gaining focus.

fromElement :  HTMLElement

The element losing focus.

toComponent :  <ext-component/>

The Component gaining focus.

fromComponent :  <ext-component/>

The Component losing focus.

backwards :  Boolean

true if the focus movement is backward in DOM order

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

onInheritedAdd ( parent, instanced )
private pri

let element = document.body.querySelector('ext-filefield');
element.onInheritedAdd(parent, instanced);

Called when this Inheritable is added to a parent

Parameters

parent :  Object

instanced :  Boolean

onInheritedRemove ( destroying )
private pri

let element = document.body.querySelector('ext-filefield');
element.onInheritedRemove(destroying);

Called when this inheritable is removed from a parent

Parameters

destroying :  Boolean

true if this item will be destroyed by it's container

onInitialized ( fn, scope, args )
private pri

let element = document.body.querySelector('ext-filefield');
element.onInitialized(fn, scope, args);

Parameters

fn :  Object

scope :  Object

args :  Object

onRender
template tpl

let element = document.body.querySelector('ext-filefield');
element.onRender();

This method is called the first time a component is inserted into the DOM. If this component <ext-container/> other components, the onRender method for child components is called after the parent's onRender.

Implementations of this method should avoid modifying the DOM but are free to read from and measure elements as needed. To adjust the DOM, consider implementing afterRender instead.

If this method is overridden, be sure to use callParent to call the base class version.

 onRender: function() {
     this.callParent();

     // custom actions
 }

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to interrogate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM. For example to be measured correctly.

Available since: 6.5.0

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

onResize ( width, height, oldWidth, oldHeight )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onResize(width, height, oldWidth, oldHeight);

Optional template method. If implemented, this is called asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

width :  Number

The new width.

height :  Number

The new height.

oldWidth :  Number

The previous width.

oldHeight :  Number

The previous height.

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

onScrollEnd ( x, y )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onScrollEnd(x, y);

Invoked when a scroll operation is completed via this component's scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollMove ( x, y )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onScrollMove(x, y);

Invoked when this component is scrolled via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onScrollStart ( x, y )
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
element.onScrollStart(x, y);

Invoked when a scroll is initiated on this component via its scroller.

Parameters

x :  Number

The current x position

y :  Number

The current y position

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

onStatefulChange
private pri

let element = document.body.querySelector('ext-filefield');
element.onStatefulChange();

This method is called when any of the stateful configs are modified.

owns ( element )
private pri

let element = document.body.querySelector('ext-filefield');
element.owns(element);

Returns true if the passed element is within the container tree of this component.

For example if a menu's submenu contains an Ext.form.field.Date, that top level menu owns the elements of the date picker. Using this method, you can tell if an event took place within a certain component tree.

Parameters

element :  Object

parseValue ( value, errors ) : Mixed
template tpl protected pro

let element = document.body.querySelector('ext-filefield');
let parseValue = element.parseValue(value, errors);

Parses the given value and returns it in the desired representation. By default this will return the value given (no change). Derived classes (such as datefield and numberfield) will override this method and return a Date or a Number, respectively.

If value cannot be parsed, this method will return null, otherwise it will return the parsed value. It is the parsed value that will become the field's value.

This method is not called directly but is called internally by the validate. This call to parse a value is not made on empty or null values.

Note: It is not expected that applications will need to override this method because an application can achieve value parsing by virtue of the validators it defines. These can come from this component or from a bound model field (using modelValidation). In addition, datefield and numberfield both provide default parsing for their values.

Available since: 6.5.1

Parameters

value :  String

The value to parse (never null).

errors :  String[]

The set of validation errors. If the value cannot be parsed, the error message should be added to this array.

Returns

:Mixed

The parsed value.

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

persistState
private pri

let element = document.body.querySelector('ext-filefield');
element.persistState();

Saves the state of this instance to the persistence store. This method is called by the Ext.state.Provider when it is ready to save state to storage.

preprocessShow ( component, alignment, options )
private pri

let element = document.body.querySelector('ext-filefield');
element.preprocessShow(component, alignment, options);

This is the private method to ensure everything is set up for showing. This is called by both show and showBy to set a component up. the user-facing method is beforeShow, this setup must have happened by the time that is called.

Parameters

component :  Object

alignment :  Object

options :  Object

processElementConfig Object
private pri

let element = document.body.querySelector('ext-filefield');
let processElementConfig = element.processElementConfig();

Recursively processes the element templates for this class and its superclasses, ascending the hierarchy until it reaches a superclass whose element template has already been processed. This method is invoked using the prototype as the scope.

Returns

:Object

processRawValue ( value ) : String
private pri

let element = document.body.querySelector('ext-filefield');
let processRawValue = element.processRawValue(value);

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

Available since: 7.0

Parameters

value :  String

The unprocessed string value

Returns

:String

The processed string value

publishState ( [property], [value] )
protected pro

let element = document.body.querySelector('ext-filefield');
element.publishState(property, value);

Publish this components state to the ViewModel. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

This method is called only by component authors.

Available since: 5.0.0

Parameters

property :  String (optional)

The name of the property to update.

value :  Object (optional)

The value of property. Only needed if property is given.

rawToValue ( rawValue ) : Object

let element = document.body.querySelector('ext-filefield');
let rawToValue = element.rawToValue(rawValue);

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This allows controlling the normalization and conversion of user-entered values into field-type-appropriate values, e.g. a Date object for <ext-datefield/> <ext-datepickerfield/>, and is invoked by getValue.

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

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

Available since: 7.0

Parameters

rawValue :  Object

Returns

:Object

The converted value.

readStateObject Object
private pri

let element = document.body.querySelector('ext-filefield');
let readStateObject = element.readStateObject();

Returns this instance's state object from the persistence store. This object should contain config properties.

Returns

:Object

realign ( component, alignment, options )
private pri

let element = document.body.querySelector('ext-filefield');
element.realign(component, alignment, options);

Parameters

component :  Object

alignment :  Object

options :  Object

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

let element = document.body.querySelector('ext-filefield');
let relayEvents = element.relayEvents(origin, events, prefix);

Relays selected events from the specified Observable as if the events were fired by this.

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

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

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

removeAfterListener

let element = document.body.querySelector('ext-filefield');
element.removeAfterListener();

Alias for unAfter.

removeBeforeListener

let element = document.body.querySelector('ext-filefield');
element.removeBeforeListener();

Alias for unBefore.

removeCls ( cls, [prefix], [suffix] )

let element = document.body.querySelector('ext-filefield');
element.removeCls(cls, prefix, suffix);

Removes the given CSS class(es) from this widget's primary element.

Parameters

cls :  String/String[]

The class(es) to remove.

prefix :  String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to append to each class.

Defaults to: ""

removeDelegatedListener ( eventName, fn, scope )
private pri

let element = document.body.querySelector('ext-filefield');
element.removeDelegatedListener(eventName, fn, scope);

Removes delegated listeners for a given eventName, function, and scope. Users should not invoke this method directly. It is called automatically by the framework as part of removeListener processing.

Parameters

eventName :  Object

fn :  Object

scope :  Object

removeListener ( eventName, fn, [scope] ) :
chainable ch

let element = document.body.querySelector('ext-filefield');
let removeListener = element.removeListener(eventName, fn, scope);

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Returns

:

removeManagedListener ( item, ename, [fn], [scope] )

let element = document.body.querySelector('ext-filefield');
element.removeManagedListener(item, ename, fn, scope);

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

removeManagedListenerItem ( isClear, managedListener, item, ename, fn, scope )
private pri

let element = document.body.querySelector('ext-filefield');
element.removeManagedListenerItem(isClear, managedListener, item, ename, fn, scope);

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item

item :  Object

ename :  String

fn :  Function

scope :  Object

See removeManagedListener for other args

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

let element = document.body.querySelector('ext-filefield');
let removePlugin = element.removePlugin(plugin, destroy);

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

removeTrigger ( trigger, [destroy] ) : Ext.field.trigger.Trigger

let element = document.body.querySelector('ext-filefield');
let removeTrigger = element.removeTrigger(trigger, destroy);

Removes a trigger from this text field.

Parameters

trigger :  String/Ext.field.trigger.Trigger

The name of the trigger to remove, or a trigger reference.

destroy :  Boolean (optional)

False to prevent the trigger from being destroyed on removal. Only use this option if you want to reuse the trigger instance.

Defaults to: true

Returns

:Ext.field.trigger.Trigger

The trigger that was removed

replaceCls ( oldCls, newCls, [prefix], [suffix] )

let element = document.body.querySelector('ext-filefield');
element.replaceCls(oldCls, newCls, prefix, suffix);

Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.

Parameters

oldCls :  String/String[]

The class(es) to remove.

newCls :  String/String[]

The class(es) to add.

prefix :  String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix :  String (optional)

Optional suffix to append to each class.

Defaults to: ""

reset

let element = document.body.querySelector('ext-filefield');
element.reset();

Resets the fileField values & input values Along with fileButton dom files.

resetFloating
deprecated dep

let element = document.body.querySelector('ext-filefield');
element.resetFloating();

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

Deprecated since version 6.2
Use resetPositioned instead.

resetOriginalValue

let element = document.body.querySelector('ext-filefield');
element.resetOriginalValue();

Resets the field's originalValue property so it matches the current value. This is called by <ext-formpanel/>.setValues if the form's trackResetOnLoad property is set to true.

resetPositioned

let element = document.body.querySelector('ext-filefield');
element.resetPositioned();

Resets top, right, bottom and left configurations to null, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

resolveListenerScope ( [defaultScope] ) : Object
protected pro

let element = document.body.querySelector('ext-filefield');
let resolveListenerScope = element.resolveListenerScope(defaultScope);

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object

The default event scope

resolveSatelliteListenerScope ( satellite, [defaultScope] ) : Object
protected pro

let element = document.body.querySelector('ext-filefield');
let resolveSatelliteListenerScope = element.resolveSatelliteListenerScope(satellite, defaultScope);

Returns the default listener scope for a "satellite" of this component. Used for resolving scope for observable objects that are not part of the normal Container/Component hierarchy (for example, plugins)

Available since: 5.1.1

Parameters

satellite :  Ext.mixin.Observable

defaultScope :  Object (optional)

Returns

:Object

The listener scope