Docs Help

Terms, Icons, and Labels

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

Ext JS 6.2.1 - Classic Toolkit


top

Ext.draw.Container xtype: draw

Summary

The container that holds and manages instances of the Ext.draw.Surface in which Ext.draw.sprite.Sprite are rendered. Draw containers are used as the foundation for all of the chart classes but may also be created directly in order to create custom drawings.

In the previous example we created a draw container and configured it with a single sprite. The type of the sprite is Ext.draw.sprite.Circle, so if you run this code you'll see a green circle.

You can attach sprite event listeners to the draw container with the help of the Ext.draw.plugin.SpriteEvents plugin.

For more information on sprites, the core elements added to a draw container's surface, refer to the Ext.draw.sprite.Sprite documentation.

For more information on surfaces, the interface owned by the draw container used to manage all sprites, see the Ext.draw.Surface documentation.

No members found using the current filters

configs

Optional Configs

actions : Object
bindable bind

An object containing properties which define named Ext.Action for this container and any descendant components.

An Action encapsulates a shareable, reusable set of properties which define a "clickable" UI component such as a Ext.button.Button or Ext.menu.Item, or panel header tool, or an Ext.grid.column.Action

An Action, or more conveniently, the name of an action prefixed with '@' may be used as a config object for creating child components which use a handler config property to reference a Controller method to invoke when the component is clicked.

The property name is the action name, which may then be used as a child item configuration in an items configuration in any descendant component such as a toolbar or a menu, or in a tools configuration of a Panel.

The property value is a configuration object for any clickable component.

See the Ext.Action class for an example of reusable Actions.

Defaults to:

null

Available since: 6.2.0

getActions : Object

Returns the value of actions

Returns

Object

setActions (actions)

Sets the value of actions

Parameters

actions :  Object

activeCounter : Number
bindable bind private pri

An incrementing numeric counter indicating activation index for use by the zIndexManager to sort its stack.

Defaults to:

0

getActiveCounter : Number

Returns the value of activeCounter

Returns

Number

setActiveCounter (activeCounter)

Sets the value of activeCounter

Parameters

activeCounter :  Number

activeItem : String / Number
bindable bind

A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.container.Card and Ext.layout.container.Fit).

Available since: 2.3.0

setActiveItem ( item ) : Ext.Component

Sets a component as the active layout item. This only applies when using a Ext.layout.container.Card layout.

var card1 = Ext.create('Ext.panel.Panel', {itemId: 'card-1'});
var card2 = Ext.create('Ext.panel.Panel', {itemId: 'card-2'});
var panel = Ext.create('Ext.panel.Panel', {
    layout: 'card',
    items: [card1, card2]
});
// These are all equivalent
panel.getLayout().setActiveItem(card2);
panel.getLayout().setActiveItem('card-2');
panel.getLayout().setActiveItem(1);

Parameters

item :  Ext.Component/Number/String

The component, component id, itemId, or index of component.

Returns

:Ext.Component

the activated component or false when nothing activated. False is returned also when trying to activate an already active item.

alignOnScroll : Boolean

By default, when the alignTo method is called, a floating component will scroll to keep aligned with the anchoring element if the anchoring element is part of the scroll.

If this is not necessary, and the alignTo is a one-off operation then set this config to false.

Defaults to:

true

alignTarget : String

A Component or Element by which to position this component according to the defaultAlign. Defaults to the owning Container.

Only applicable if this component is cfg-floating

Used upon first show.

Defaults to:

null

alwaysOnTop : Boolean / Number
bindable bind

A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack.

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

getAlwaysOnTop : Boolean / Number

Returns the value of alwaysOnTop

Returns

Boolean / Number

setAlwaysOnTop (alwaysOnTop)

Sets the value of alwaysOnTop

Parameters

alwaysOnTop :  Boolean / Number

anchor : String

This configuration option is to be applied to child items of a container managed by an Ext.layout.container.Anchor.

This value is what tells the layout how an item should be anchored to the container. items added to an AnchorLayout accept an anchoring-specific config property of anchor which is a string containing two values: the horizontal anchor value and the vertical anchor value (for example, '100% 50%'). The following types of anchor values are supported:

  • Percentage : Any value between 1 and 100, expressed as a percentage.

    The first anchor is the percentage width that the item should take up within the container, and the second is the percentage height. For example:

    // two values specified
    anchor: '100% 50%' // render item complete width of the container and
                       // 1/2 height of the container
    // one value specified
    anchor: '100%'     // the width value; the height will default to auto
    
  • Offsets : Any positive or negative integer value.

    This is a raw adjustment where the first anchor is the offset from the right edge of the container, and the second is the offset from the bottom edge. For example:

    // two values specified
    anchor: '-50 -100' // render item the complete width of the container
                       // minus 50 pixels and
                       // the complete height minus 100 pixels.
    // one value specified
    anchor: '-50'      // anchor value is assumed to be the right offset value
                       // bottom offset will default to 0
    
  • Sides : Valid values are right (or r) and bottom (or b).

    Either the container must have a fixed size or an anchorSize config value defined at render time in order for these to have any effect.

  • Mixed :

    Anchor values can also be mixed as needed. For example, to render the width offset from the container right edge by 50 pixels and 75% of the container's height use:

    anchor:   '-50 75%'
    

anchorSize : Number / Object

Defines the anchoring size of container. Either a number to define the width of the container or an object with width and height fields.

animateShadow : Boolean

true to animate the shadow along with the component while the component is animating. By default the shadow is hidden while the component is animating

Defaults to:

false

animCollapse : Boolean / Number

true to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.fx.Anim class is available, otherwise false). May also be specified as the animation duration in milliseconds.

Defaults to:

Ext.enableFx

ariaAttributes : Object
bindable bind

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

getAriaAttributes : Object

Returns the value of ariaAttributes

Returns

Object

setAriaAttributes (ariaAttributes)

Sets the value of ariaAttributes

Parameters

ariaAttributes :  Object

ariaDescribedBy : String

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.

ariaLabel : String

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

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.

autoDestroy : Boolean

If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually.

Defaults to:

true

Available since: 2.3.0

autoEl : String / Object

A tag name or Ext.dom.Helper spec used to create the Element which will encapsulate this Component.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to 'div'. The more complex Sencha classes use a more complex DOM structure specified by their own cfg-renderTpls.

This is intended to allow the developer to create application-specific utility Components encapsulated by different DOM elements. Example usage:

{
    xtype: 'component',
    autoEl: {
        tag: 'img',
        src: 'http://www.example.com/example.jpg'
    }
}, {
    xtype: 'component',
    autoEl: {
        tag: 'blockquote',
        html: 'autoEl is cool!'
    }
}, {
    xtype: 'container',
    autoEl: 'ul',
    cls: 'ux-unordered-list',
    items: {
        xtype: 'component',
        autoEl: 'li',
        html: 'First list item'
    }
}

Available since: 2.3.0

autoRender : Boolean / String / HTMLElement / Ext.dom.Element

This config is intended mainly for non-cfg-floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show. If cfg-floating is true, the value of this config is omitted as if it is true.

Specify as true to have this Component render to the document body upon first show.

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

Defaults to:

false

autoScroll : Boolean
deprecated dep bindable bind

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content.

This should not be combined with overflowX or overflowY.

Defaults to:

false

Deprecated since version 5.1.0
Use scrollable instead

setAutoScroll ( scroll ) : Ext.Component
chainable ch deprecated dep

Sets the overflow on the content element of the component.

Parameters

scroll :  Boolean

True to allow the Component to auto scroll.

Returns

:Ext.Component

this

Deprecated since version 5.0.0
Use setScrollable instead

autoShow : Boolean

true to automatically show the component upon creation. This config option may only be used for cfg-floating components or components that use autoRender.

Defaults to:

false

Available since: 2.3.0

baseCls : String

The base CSS class to apply to this component's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

Defaults to:

'x-component'

bbar : Object / Object[]

Convenience config. Short for 'Bottom Bar'.

bbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Defaults to:

null

bind : Object / String
bindable 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

getBind : Object / String

Returns the value of bind

Returns

Object / String

setBind (bind)

Sets the value of bind

Parameters

bind :  Object / String

bodyBorder : Boolean

A shortcut to add or remove the border on the body of a panel. In the classic theme this only applies to a panel which has the frame configuration set to true.

Available since: 2.3.0

bodyCls : String / String[]

A CSS class, space-delimited string of classes, or array of classes to be applied to the panel's body element. The following examples are all valid:

bodyCls: 'foo'
bodyCls: 'foo bar'
bodyCls: ['foo', 'bar']

bodyPadding : Number / String

A shortcut for setting a padding style on the body element. The value can either be a number to be applied to all sides, or a normal css string describing padding.

Defaults to:

undefined

bodyStyle : String / Object / Function
bindable bind

Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string, an object containing style property name/value pairs or a function that returns such a string or object. For example, these two formats are interpreted to be equivalent:

bodyStyle: 'background:#ffc; padding:10px;'

bodyStyle: {
    background: '#ffc',
    padding: '10px'
}

Available since: 2.3.0

setBodyStyle ( style, value ) : Ext.panel.Panel
chainable ch

Sets the body style according to the passed parameters.

Parameters

style :  Mixed

A full style specification string, or object, or the name of a style property to set.

value :  String

If the first param was a style property name, the style property value.

Returns

:Ext.panel.Panel

this

border : Boolean
bindable bind

Specify as false to render the Panel with zero width borders.

Leaving the value as true uses the selected theme's Ext.panel.Panel#$panel-border-width

Defaults to false when using or extending Neptune.

Note: is ignored when frame is set to true.

Defaults to:

true

setBorder ( border, targetEl )

Parameters

border :  String/Number

The border, see border. If a falsey value is passed

targetEl :  Object

bubbleEvents : String[]

An array of events that, when fired, should be bubbled to any parent container. See Ext.util.Observable#enableBubble.

Available since: 3.4.0

buttonAlign : String

The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right' for buttons/fbar, 'left' for other toolbar types).

NOTE: The preferred way to specify toolbars is to use the dockedItems config. Instead of buttonAlign you would add the layout: { pack: 'start' | 'center' | 'end' } option to the dockedItem config.

buttons : Object[]

Convenience config used for adding buttons docked to the bottom of the panel. This is a synonym for the fbar config.

buttons: [
  { text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    ui: 'footer',
    defaults: {
        minWidth: 200
    },
    items: [
        { xtype: 'component', flex: 1 },
        { xtype: 'button', text: 'Button 1' }
    ]
}]

The minButtonWidth is used as the default minWidth for each of the buttons in the buttons toolbar.

Defaults to:

null

childEls : Object / String[] / Object[]
bindable bind

The canonical form of childEls is an object keyed by child's property name with values that are objects with the following properties.

  • itemId - The id to combine with the Component's id that is the id of the child element.
  • id - The id of the child element.
  • leaf - Set to true to ignore content when scanning for childEls. This should be set on things like the generated content for an Ext.view.View.
  • select: A selector that will be passed to Ext.dom.Element#method-select.
  • selectNode: A selector that will be passed to Ext.dom.Element#method-selectNode.

For example:

 childEls: {
     button: true,
     buttonText: 'text',
     buttonImage: {
         itemId: 'image'
     }
 }

The above is translated into the following complete form:

 childEls: {
     button: {
         name: 'button',
         itemId: 'button'
     },
     buttonText: {
         name: 'buttonText',
         itemId: 'text'
     },
     buttonImage: {
         name: 'buttonImage',
         itemId: 'image'
     }
 }

The above can be provided as an array like so:

 childEls: [
     'button',
     { name: 'buttonText', itemId: 'text' },
     { name: 'buttonImage', itemId: 'image' }
 }

For example, a Component which renders a title and body text:

Note: childEls in the renderTpl must be referenced in a data-ref attribute. Notice in the above example that the "title" childEl is set in the renderTpl using data-ref="title".

When using select, the property will be an instance of Ext.CompositeElement. In all other cases, the property will be an Ext.dom.Element or null if not found.

Care should be taken when using select or selectNode to find child elements. The following issues should be considered:

  • Performance: using selectors can be 10x slower than id lookup.
  • Over-selecting: selectors are applied after the DOM elements for all children have been rendered, so selectors can match elements from child components (including nested versions of the same component) accidentally.

This above issues are most important when using select since it returns multiple elements.

Defaults to:

{
    frameTable: {
        frame: true
    },
    frameTL: {
        frame: 'tl'
    },
    frameTC: {
        frame: 'tc'
    },
    frameTR: {
        frame: 'tr'
    },
    frameML: {
        frame: 'ml'
    },
    frameBody: {
        frame: 'mc'
    },
    frameMR: {
        frame: 'mr'
    },
    frameBL: {
        frame: 'bl'
    },
    frameBC: {
        frame: 'bc'
    },
    frameBR: {
        frame: 'br'
    }
}

getChildEls : Object / String[] / Object[]

Returns the value of childEls

Returns

Object / String[] / Object[]

setChildEls (childEls)

Sets the value of childEls

Parameters

childEls :  Object / String[] / Object[]

closable : Boolean
bindable bind

True to display the 'close' tool button and allow the user to close the window, false to hide the button and disallow closing the window.

By default, when close is requested by clicking the close button in the header, the method-close method will be called. This will destroy the Panel and its content meaning that it may not be reused.

To make closing a Panel hide the Panel so that it may be reused, set closeAction to 'hide'.

Defaults to:

false

getClosable : Boolean

Returns the value of closable

Returns

Boolean

setClosable (closable)

Sets the value of closable

Parameters

closable :  Boolean

closeAction : String

The action to take when the close header tool is clicked:

Note: This behavior has changed! setting does affect the method-close method which will invoke the appropriate closeAction.

Defaults to:

'destroy'

closeToolText : String

Text to be announced by screen readers when the close Ext.panel.Tool is focused. Will also be set as the close tool's tooltip text.

Note: Applicable when the panel is closable: true

Defaults to:

'Close panel'

cls : String / String[]

An optional extra CSS class that will be added to this component's Element. The value can be a string, a list of strings separated by spaces, or an array of strings. This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

Defaults to:

''

Available since: 1.1.0

collapsed : Boolean
bindable bind

true to render the panel collapsed, false to render it expanded.

Defaults to:

false

getCollapsed Boolean/String

Returns the current collapsed state of the panel.

Returns

:Boolean/String

False when not collapsed, otherwise the value of collapseDirection.

setCollapsed ( collapsed )

Collapses or expands the panel.

Parameters

collapsed :  Boolean

true to collapse the panel, false to expand it.

collapsedCls : String

A CSS class to add to the panel's element after it has been collapsed.

Defaults to:

'collapsed'

collapseDirection : String

The direction to collapse the Panel when the toggle button is clicked.

Defaults to the cfg-headerPosition

Important: This config is ignored for collapsible Panels which are direct child items of a Ext.layout.container.Border.

Specify as 'top', 'bottom', 'left' or 'right'.

collapseFirst : Boolean

true to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last.

Defaults to:

true

collapseMode : String

Important: this config is only effective for collapsible Panels which are direct child items of a Ext.layout.container.Border.

When not a direct child item of a Ext.layout.container.Border, then the Panel's header remains visible, and the body is collapsed to zero dimensions. If the Panel has no header, then a new header (orientated correctly depending on the collapseDirection) will be inserted to show a the title and a re- expand tool.

When a child item of a Ext.layout.container.Border, this config has three possible values:

  • undefined - When collapsed, a placeholder Ext.panel.Header is injected into the layout to represent the Panel and to provide a UI with a Tool to allow the user to re-expand the Panel.

  • "header" - The Panel collapses to leave its header visible as when not inside a Ext.layout.container.Border.

  • "mini" - The Panel collapses without a visible header.

collapseToolText : String

Text to be announced by screen readers when collapse Ext.panel.Tool is focused. Will also be set as the collapse tool's tooltip text.

Note: Applicable when the panel is collapsible: true

Defaults to:

'Collapse panel'

collapsible : Boolean

True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool. When a panel is used in a Ext.layout.container.Border, the floatable option can influence the behavior of collapsing. See collapseMode and collapseDirection

Defaults to:

undefined

columnWidth : Number

Defines the column width inside Ext.layout.container.Column.

The columnWidth property is always evaluated as a percentage and must be a decimal value greater than 0 and less than 1 (e.g., .25). See the description at the top of Ext.layout.container.Column for additional usage details when combining width and columnWidth configs within the layout.

componentCls : String

CSS Class to be added to a components root level element to give distinction to it via styling.

componentLayout : String / Object
bindable bind

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

Generally, developers will not use this configuration as all provided Components which need their internal elements sizing (Such as Ext.form.field.Base) come with their own componentLayout managers.

The Ext.layout.container.Auto will be used on instances of the base Ext.Component class which simply sizes the Component's encapsulating element to the height and width specified in the setSize method.

Defaults to:

'autocomponent'

setComponentLayout ( layout )
private pri

Parameters

layout :  Object

constrain : Boolean

True to constrain the panel within its containing element, false to allow it to fall outside of its containing element. By default floating components such as Windows will be rendered to document.body. To render and constrain the window within another element specify renderTo. Optionally the header only can be constrained using constrainHeader.

Defaults to:

false

constrainHeader : Boolean

True to constrain the panel header within its containing element (allowing the panel body to fall outside of its containing element) or false to allow the header to fall outside its containing element. Optionally the entire panel can be constrained using constrain.

Defaults to:

false

constraintInsets : Object / String

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this component must be constrained when positioning or sizing. example:

constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent

constrainTo : Ext.util.Region / Ext.dom.Element

A Ext.util.Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating.

contentEl : String

Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component.

This config option is used to take an existing HTML element and place it in the layout element of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.

Notes:

The specified HTML element is appended to the layout element of the component after any configured HTML has been inserted, and so the document will not contain this element at the time the event-render event is fired.

The specified HTML element used will not participate in any layout scheme that the Component may use. It is just HTML. Layouts operate on child items.

Add either the x-hidden or the x-hidden-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

Available since: 3.4.0

controller : String / Object / Ext.app.ViewController
bindable bind

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

getController Ext.app.ViewController

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

setController (controller)

Sets the value of controller

Parameters

controller :  String / Object / Ext.app.ViewController

data : Object
bindable bind

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

Defaults to:

null

Available since: 3.4.0

getData : Object

Returns the value of data

Returns

Object

setData (data)

Sets the value of data

Parameters

data :  Object

defaultAlign : String

The default Ext.dom.Element#getAlignToXY anchor position value for this component relative to its alignTarget (which defaults to its owning Container).

Only applicable if this component is cfg-floating

Used upon first show.

Defaults to:

"c-c"

defaultButton : String

Reference name of the component to act as the default button for this Panel. Default button is activated by pressing Enter key while focus is contained within the Panel's defaultButtonTarget.

The most obvious use for defaultButton is submitting a form:

 var loginWindow = new Ext.window.Window({
     autoShow: true,
     width: 300,
     layout: 'form',
     title: 'Enter login information',
     referenceHolder: true,
     defaultFocus: 'textfield',
     defaultButton: 'okButton',

     items: [{
         xtype: 'textfield',
         fieldLabel: 'User name'
     }, {
         xtype: 'textfield',
         fieldLabel: 'Password'
     }],

     buttons: [{
         reference: 'okButton',
         text: 'Login',
         handler: function() {
             Ext.Msg.alert('Submit', 'Your login is being processed');
         }
     }]
 });

defaultButtonTarget : String

Name of the element that will be the target of defaultButton keydown listener. The default element is Panel body, which means that pressing Enter key while focus is on docked items will not fire defaultButton action.

If you want defaultButton action to fire in docked items, set this config to "el".

defaultDockWeights : Object

This object holds the default weights applied to dockedItems that have no weight. These start with a weight of 1, to allow negative weights to insert before top items and are odd numbers so that even weights can be used to get between different dock orders.

To make default docking order match border layout, do this:

 Ext.panel.Panel.prototype.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };

Changing these defaults as above or individually on this object will effect all Panels. To change the defaults on a single panel, you should replace the entire object:

 initComponent: function () {
     // NOTE: Don't change members of defaultDockWeights since the object is shared.
     this.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };

     this.callParent();
 }

To change only one of the default values, you do this:

 initComponent: function () {
     // NOTE: Don't change members of defaultDockWeights since the object is shared.
     this.defaultDockWeights = Ext.applyIf({ top: 10 }, this.defaultDockWeights);

     this.callParent();
 }

Defaults to:

{
    top: {
        render: 1,
        visual: 1
    },
    left: {
        render: 3,
        visual: 5
    },
    right: {
        render: 5,
        visual: 7
    },
    bottom: {
        render: 7,
        visual: 3
    }
}

defaultFocus : String

Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.

getDefaultFocus

Finds the configured default focus item. See defaultFocus.

defaultListenerScope : Boolean
bindable bind

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

getDefaultListenerScope : Boolean

Returns the value of defaultListenerScope

Returns

Boolean

setDefaultListenerScope (defaultListenerScope)

Sets the value of defaultListenerScope

Parameters

defaultListenerScope :  Boolean

defaults : Object / Function

This option is a means of applying default settings to all added items whether added through the cfg-items config or via the method-add or insert methods.

Defaults are applied to both config objects and instantiated components conditionally so as not to override existing properties in the item (see Ext#applyIf).

If the defaults option is specified as a function, then the function will be called using this Container as the scope (this reference) and passing the added item as the first parameter. Any resulting object from that call is then applied to the item as default properties.

For example, to automatically apply padding to the body of each of a set of contained Ext.panel.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.

Usage:

defaults: { // defaults are applied to items, not the container
    scrollable: true
},
items: [
    // default will not be applied here, panel1 will be scrollable: false
    {
        xtype: 'panel',
        id: 'panel1',
        scrollable: false
    },
    // this component will have scrollable: true
    new Ext.panel.Panel({
        id: 'panel2'
    })
]

Available since: 2.3.0

defaultType : String

The default Ext.Component of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component.

Defaults to:

"panel"

Available since: 2.3.0

detachOnRemove : Boolean

True to move any component to the detachedBody when the component is removed from this container. This option is only applicable when the component is not destroyed while being removed, see autoDestroy and method-remove. If this option is set to false, the DOM of the component will remain in the current place until it is explicitly moved.

Defaults to:

true

disabled : Boolean
bindable bind

true to disable the component.

Defaults to:

false

Available since: 2.3.0

setDisabled ( disabled )
chainable ch

Enable or disable the component.

Parameters

disabled :  Boolean

true to disable.

disabledCls : String

CSS class to add when the Component is disabled.

Defaults to:

'x-item-disabled'

dock : 'top' / 'bottom' / 'left' / 'right'
bindable bind

The side of the Ext.panel.Panel where this component is to be docked when specified in the panel's dockedItems config.

Possible values are:

  • top
  • bottom
  • left
  • right

setDock ( dock ) : Ext.Component
chainable ch

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

dock :  Object

The dock position.

Returns

:Ext.Component

this

dockedItems : Object / Object[]

A component or series of components to be added as docked items to this panel. The docked items can be docked to either the top, right, left or bottom of a panel. This is typically used for things like toolbars or tab bars:

var panel = new Ext.panel.Panel({
    dockedItems: [{
        xtype: 'toolbar',
        dock: 'top',
        items: [{
            text: 'Docked to the top'
        }]
    }]
});

Defaults to:

null

getDockedItems ( selector, beforeBody ) : Ext.Component[]

Retrieves an array of all currently docked Components.

For example to find a toolbar that has been docked at top:

panel.getDockedItems('toolbar[dock="top"]');

Parameters

selector :  String

A Ext.ComponentQuery selector string to filter the returned items.

beforeBody :  Boolean

An optional flag to limit the set of items to only those before the body (true) or after the body (false). All components are returned by default.

Returns

:Ext.Component[]

The array of docked components meeting the specified criteria.

draggable : Boolean / Object

Specify as true to make a cfg-floating Component draggable using the Component's encapsulating element as the drag handle.

This may also be specified as a config object for the Ext.util.ComponentDragger which is instantiated to perform dragging.

For example to create a Component which may only be dragged around using a certain internal element as the drag handle, use the delegate option:

new Ext.Component({
    constrain: true,
    floating: true,
    style: {
        backgroundColor: '#fff',
        border: '1px solid black'
    },
    html: '<h1 style="cursor:move">The title</h1><p>The content</p>',
    draggable: {
        delegate: 'h1'
    }
}).show();

NOTE: The private Ext.panel.DD class is used instead of ComponentDragger when simpleDrag is false (default). In this case you may pass a config for Ext.dd.DragSource.

See also dd.

Defaults to:

false

engine : String

Defines the engine (type of surface) used to render draw container contents.

The render engine is selected automatically depending on the platform used. Priority is given to the Ext.draw.engine.Canvas engine due to its performance advantage.

You may also set the engine config to be Ext.draw.engine.Svg if so desired.

Defaults to:

"Ext.draw.engine.Canvas"

expandToolText : String

Text to be announced by screen readers when expand Ext.panel.Tool is focused. Will also be set as the expand tool's tooltip text.

Note: Applicable when the panel is collapsible: true

Defaults to:

'Expand panel'

fbar : Object / Object[]

Convenience config used for adding items to the bottom of the panel. Short for Footer Bar.

fbar: [
  { type: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    ui: 'footer',
    defaults: {
        minWidth: 200
    },
    items: [
        { xtype: 'component', flex: 1 },
        { xtype: 'button', text: 'Button 1' }
    ]
}]

The minButtonWidth is used as the default minWidth for each of the buttons in the fbar.

Defaults to:

null

fixed : Boolean

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling the document.

Defaults to:

false

flex : Number
bindable bind

Flex may be applied to child items of a box layout (Ext.layout.container.VBox or Ext.layout.container.HBox). Each child item with a flex property will fill space (horizontally in hbox, vertically in vbox) according to that item's relative flex value compared to the sum of all items with a flex value specified.

Any child items that have either a flex of 0 or undefined will not be 'flexed' (the initial size will not be changed).

setFlex ( flex )
private pri

Sets the flex property of this component. Only applicable when this component is an item of a box layout

Parameters

flex :  Number

floatable : Boolean

Important: This config is only effective for collapsible Panels which are direct child items of a Ext.layout.container.Border.

true to allow clicking a collapsed Panel's placeholder to display the Panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again.

Defaults to:

true

floating : Boolean

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

Components such as Ext.window.Windows and Ext.menu.Menus are floating by default.

Floating Components that are programmatically rendered will register themselves with the global Ext.WindowManager

Floating Components as child items of a Container

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by examining the ownerCt chain.

When configured as floating, Components acquire, at render time, a Ext.ZIndexManager which manages a stack of related floating Components. The ZIndexManager sorts its stack according to an incrementing access counter and the alwaysOnTop config when the Component's toFront method is called.

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative to any siblings, but always above that floating ancestor Container.

If no floating ancestor is found, a floating Component registers itself with the default Ext.WindowManager.

Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly method-show them.

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container. If no floating ancestor Container was found the floatParent property will not be set.

Defaults to:

false

focusCls : String

CSS class that will be added to focused Component, and removed when Component blurs.

Defaults to:

'x-focus'

focusOnToFront : Boolean

Specifies whether the floated component should be automatically focused when it is brought to the front.

Defaults to:

true

formBind : Boolean

When inside FormPanel, any component configured with formBind: true will be enabled/disabled depending on the validity state of the form. See Ext.form.Panel for more information and example.

Defaults to:

false

frame : Boolean

True to apply a frame to the panel.

Note: frame: true overrides border:false

Defaults to:

false

frameHeader : Boolean

True to apply a frame to the panel panels header (if 'frame' is true).

Defaults to:

true

glyph : Number / String
bindable bind

A numeric unicode character code to use as the icon. The default font-family for glyphs can be set globally using glyphFontFamily application config or the Ext.setGlyphFontFamily() method. It is initially set to 'Pictos'.

The following shows how to set the glyph using the font icons provided in the SDK (assuming the font-family has been configured globally):

// assumes the glyphFontFamily is "Pictos"
glyph: 'x48'       // the "home" icon (H character)

// assumes the glyphFontFamily is "Pictos"
glyph: 72          // The "home" icon (H character)

// assumes the glyphFontFamily is "Pictos"
glyph: 'H'         // the "home" icon

Alternatively, this config option accepts a string with the charCode and font-family separated by the @ symbol.

// using Font Awesome
glyph: 'xf015@FontAwesome'     // the "home" icon

// using Pictos
glyph: 'H@Pictos'              // the "home" icon

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Defaults to:

null

getGlyph : Number / String

Returns the value of glyph

Returns

Number / String

setGlyph (glyph)

Sets the value of glyph

Parameters

glyph :  Number / String

gradients : Object[]
bindable bind

Defines a set of gradients that can be used as color properties (fillStyle and strokeStyle, but not shadowColor) in sprites. The gradients array is an array of objects with the following properties:

  • id - string - The unique name of the gradient.
  • type - string, optional - The type of the gradient. Available types are: 'linear', 'radial'. Defaults to 'linear'.
  • angle - number, optional - The angle of the gradient in degrees.
  • stops - array - An array of objects with 'color' and 'offset' properties, where 'offset' is a real number from 0 to 1.

For example:

gradients: [{
    id: 'gradientId1',
    type: 'linear',
    angle: 45,
    stops: [{
        offset: 0,
        color: 'red'
    }, {
       offset: 1,
       color: 'yellow'
    }]
}, {
   id: 'gradientId2',
   type: 'radial',
   stops: [{
       offset: 0,
       color: '#555',
   }, {
       offset: 1,
       color: '#ddd',
   }]
}]

Then the sprites can use 'gradientId1' and 'gradientId2' by setting the color attributes to those ids, for example:

sprite.setAttributes({
    fillStyle: 'url(#gradientId1)',
    strokeStyle: 'url(#gradientId2)'
});

Defaults to:

[]

getGradients : Object[]

Returns the value of gradients

Returns

Object[]

setGradients (gradients)

Sets the value of gradients

Parameters

gradients :  Object[]

header : Boolean / Object

Pass as false to prevent a Header from being created and shown.

Pass as a config object (optionally containing an xtype) to custom-configure this Panel's header.

See Ext.panel.Header for all the options that may be specified here.

A Ext.panel.Header is a Ext.container.Container which contains the Panel's title and tools. You may also configure the Panel's header option with its own child items which go before the tools

By default the panel title is inserted after items configured in this config, but before any tools. To insert the title at any point in the full array, specify the titlePosition config:

new Ext.panel.Panel({
    title: 'Test',
    tools: [{
        type: 'refresh'
    }, {
        type: 'help'
    }],
    titlePosition: 2 // Title will come AFTER the two tools
    ...
});

getHeader Ext.panel.Header

Gets the Ext.panel.Header for this panel.

Returns

:Ext.panel.Header

headerOverCls : String

Optional CSS class to apply to the header element on mouseover

headerPosition : 'top' / 'bottom' / 'left' / 'right'
bindable bind

Specify as 'top', 'bottom', 'left' or 'right'.

Defaults to:

'top'

getHeaderPosition : 'top' / 'bottom' / 'left' / 'right'

Returns the value of headerPosition

Returns

'top' / 'bottom' / 'left' / 'right'

setHeaderPosition (headerPosition)

Sets the value of headerPosition

Parameters

headerPosition :  'top' / 'bottom' / 'left' / 'right'

height : Number / String
bindable bind

The height of this component. A numeric value will be interpreted as the number of pixels; a string value will be treated as a CSS value with units.

getHeight Number

Gets the current height of the component's underlying element.

Returns

:Number

setHeight ( height ) : Ext.Component

Sets the height of the component. This method fires the resize event.

Parameters

height :  Number

The new height to set. This may be one of:

  • A Number specifying the new height in pixels.
  • A String used to set the CSS height style.
  • undefined to leave the height unchanged.
  • null to clear the height.

Returns

:Ext.Component

this

hidden : Boolean
bindable bind

true to hide the component.

Defaults to:

false

Available since: 2.3.0

setHidden ( hidden ) : Ext.Component

Sets the hidden state of this component. This is basically the same as setVisible but the boolean parameter has the opposite meaning.

Parameters

hidden :  Boolean

Returns

:Ext.Component

hideCollapseTool : Boolean

true to hide the expand/collapse toggle button when collapsible == true, false to display it.

Defaults to:

false

hideMode : String

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:

  • 'display' : The Component will be hidden using the display: none style.
  • 'visibility' : The Component will be hidden using the visibility: hidden style.
  • 'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to:

'display'

Available since: 1.1.0

html : String / Object
bindable bind

An HTML fragment, or a Ext.dom.Helper specification to use as the layout element content. The HTML content is added after the component is rendered, so the document will not contain this HTML at the time the event-render event is fired. This content is inserted into the body before any configured contentEl is appended.

Defaults to:

''

Available since: 3.4.0

setHtml ( htmlOrData, [loadScripts], [callback], [scriptScope] )

Update the content area of a component.

Available since: 3.4.0

Parameters

htmlOrData :  String/Object

If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update.

loadScripts :  Boolean (optional)

Only legitimate when using the html configuration. Causes embedded script tags to be executed. Inline source will be executed with this Component as the scope (this reference).

Defaults to: false

callback :  Function (optional)

Only legitimate when using the html configuration. Callback to execute when scripts have finished loading.

scriptScope :  Object (optional)

The scope (this reference) in which to execute inline script elements content. Scripts with a src attribute cannot be executed with this scope.

Defaults to: `this`

icon : String
bindable bind

Path to an image to use as an icon.

For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.

Defaults to:

null

getIcon : String

Returns the value of icon

Returns

String

setIcon (icon)

Sets the value of icon

Parameters

icon :  String

iconAlign : 'top' / 'right' / 'bottom' / 'left'
bindable bind

The side of the title to render the icon.

Defaults to:

'left'

getIconAlign : 'top' / 'right' / 'bottom' / 'left'

Returns the value of iconAlign

Returns

'top' / 'right' / 'bottom' / 'left'

setIconAlign (iconAlign)

Sets the value of iconAlign

Parameters

iconAlign :  'top' / 'right' / 'bottom' / 'left'

iconCls : String
bindable bind

One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.

An example of specifying a custom icon class would be something like:

// specify the property in the config for the class:
iconCls: 'my-home-icon'

// css rule specifying the background image to be used as the icon image:
.my-home-icon {
    background-image: url(../images/my-home-icon.gif) !important;
}

In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:

// using Font Awesome
iconCls: 'x-fa fa-home'

// using Pictos
iconCls: 'pictos pictos-home'

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

Defaults to:

null

getIconCls : String

Returns the value of iconCls

Returns

String

setIconCls (iconCls)

Sets the value of iconCls

Parameters

iconCls :  String

id : String

The unique id of this component instance.

Use of this config should be considered carefully as this value must be unique across all existing components. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, consider a reference config and a ViewController to respond to events and perform processing upon this Component.

Alternatively, itemId and Ext.ComponentQuery can be used to perform selector-based searching for Components analogous to DOM querying. The Ext.container.Container class contains several helpful 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.

Defaults to an auto-assigned id.

Note: Valid identifiers start with a letter or underscore and are followed by (optional) additional letters, underscores, digits or hyphens.

Available since: 1.1.0

getId String

Retrieves the id of this component. Will auto-generate an id if one has not already been set.

Returns

:String

itemId : String

The unique id of this component instance within its container. See also the reference config.

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 getCmp, use itemId with getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal collection, the itemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentManager, which requires a unique id value.

var c = new Ext.panel.Panel({ //
    height: 300,
    renderTo: document.body,
    layout: 'auto',
    items: [{
        itemId: 'p1',
        title: 'Panel 1',
        height: 150
    },{
        itemId: 'p2',
        title: 'Panel 2',
        height: 150
    }]
});

p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
console.log(p1);
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling
console.log(p2);

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

Note: Valid identifiers start with a letter or underscore and are followed by (optional) additional letters, underscores, digits or hyphens.

Note: to access the container of an item see ownerCt.

Available since: 3.4.0

getItemId String

Returns the value of itemId assigned to this component, or when that is not set, returns the value of id.

Returns

:String

items : Object / Object[]

A single item, or an array of child Components to be added to this container

Unless configured with a layout, a Container simply renders child Components serially into its encapsulating element and performs no sizing or positioning upon them.

Example:

// specifying a single item
items: {...},
layout: 'fit',    // The single items is sized to fit

// specifying multiple items
items: [{...}, {...}],
layout: 'hbox', // The items are arranged horizontally

Each item may be:

If a configuration object is specified, the actual type of Component to be instantiated my be indicated by using the xtype option.

Every Component class has its own xtype.

If an xtype is not explicitly specified, the cfg-defaultType for the Container is used, which by default is usually panel.

Notes:

Ext uses lazy rendering. Child Components will only be rendered should it become necessary. Items are automatically laid out when they are first shown (no sizing is done while hidden), or in response to a method-updateLayout call.

Do not specify contentEl or html with items.

Defaults to:

undefined

Available since: 2.3.0

keyMap : Object
bindable bind

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.

getKeyMap : Object

Returns the value of keyMap

Returns

Object

setKeyMap (keyMap)

Sets the value of keyMap

Parameters

keyMap :  Object

keyMapEnabled : Boolean
bindable bind

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

getKeyMapEnabled : Boolean

Returns the value of keyMapEnabled

Returns

Boolean

setKeyMapEnabled (keyMapEnabled)

Sets the value of keyMapEnabled

Parameters

keyMapEnabled :  Boolean

keyMapTarget : String
protected pro

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'

layout : Ext.enums.Layout / Object
bindable bind

Important: In order for child items to be correctly sized and positioned, typically a layout manager must be specified through the layout configuration option.

The sizing and positioning of child cfg-items is the responsibility of the Container's layout manager which creates and manages the type of layout you have in mind. For example:

If the layout configuration is not explicitly specified for a general purpose container (e.g. Container or Panel) the Ext.layout.container.Auto will be used which does nothing but render child components sequentially into the Container (no sizing or positioning will be performed in this situation).

layout may be specified as either as an Object or as a String:

Specify as an Object

Example usage:

layout: {
    type: 'vbox',
    align: 'left'
}
  • type

    The layout type to be used for this container. If not specified, a default Ext.layout.container.Auto will be created and used.

    Valid layout type values are listed in Ext.enums.Layout.

  • Layout specific configuration properties

    Additional layout specific configuration properties may also be specified. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified.

Specify as a String

Example usage:

layout: 'vbox'
  • layout

    The layout type to be used for this container (see Ext.enums.Layout for list of valid values).

    Additional layout specific configuration properties. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the layout specified.

Configuring the default layout type

If a certain Container class has a default layout (For example a Ext.toolbar.Toolbar with a default Box layout), then to simply configure the default layout, use an object, but without the type property:

xtype: 'toolbar',
layout: {
    pack: 'center'
}

Defaults to:

'auto'

Available since: 2.3.0

getLayout Ext.layout.container.Container

Returns the Ext.layout.container.Container instance currently associated with this Container. If a layout has not been instantiated yet, that is done first

Returns

:Ext.layout.container.Container

The layout

setLayout ( configuration )

Reconfigures the initially configured layout.

NOTE: this method cannot be used to change the "type" of layout after the component has been rendered to the DOM. After rendering, this method can only modify the existing layout's configuration properties. The reason for this restriction is that many container layouts insert special wrapping elements into the dom, and the framework does not currently support dynamically changing these elements once rendered.

Parameters

configuration :  Object

object for the layout

lbar : Object / Object[]

Convenience config. Short for 'Left Bar' (left-docked, vertical toolbar).

lbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'left',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Defaults to:

null

liquidLayout : Boolean

Components that achieve their internal layout results using solely CSS with no JS intervention must set this to true. This allows the component to opt out of the layout run when used inside certain container layouts such as Ext.layout.container.Form and Ext.layout.container.Auto resulting in a performance gain. The following components currently use liquid layout (liquidLayout: true):

It is important to keep in mind that components using liquidLayout do not fire the following events:

In addition liquidLayout components do not call the following template methods:

Any component that needs to fire these events or to have these methods called during its life cycle needs to set liquidLayout to false. The following example demonstrates how to enable the resize event for a Ext.form.field.TextArea:

Use caution when setting liquidLayout to false as it carries a performance penalty since it means the layout system must perform expensive DOM reads to determine the Component's size.

Defaults to:

false

listeners : Object
bindable bind

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 Ext.view.View'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'); }
        }
    }
});

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

liveDrag : Boolean

True to drag the component itself. Else a lightweight version of the component will be shown (using the component's ghost() method).

Note: This config is only relevant when used with dragging implemented via Ext.util.ComponentDragger.

Defaults to:

false

loader : Ext.ComponentLoader / Object

A configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component.

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});

getLoader Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component.

Returns

:Ext.ComponentLoader

The loader instance, null if it doesn't exist.

manageHeight : Boolean

When true, the dock component layout writes height information to the panel's DOM elements based on its shrink wrap height calculation. This ensures that the browser respects the calculated height. When false, the dock component layout will not write heights on the panel or its body element. In some simple layout cases, not writing the heights to the DOM may be desired because this allows the browser to respond to direct DOM manipulations (like animations).

Defaults to:

true

margin : Number / String
bindable bind

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

setMargin ( margin )

Sets the margin on the target element.

Parameters

margin :  Number/String

The margin to set. See the margin config.

maskElement : String

The name of the element property in this Panel to mask when masked by a LoadMask.

Defaults to "el" to indicate that any LoadMask should be rendered into this Panel's encapsulating element.

This could be configured to be "body" so that only the body is masked and toolbars and the header are still mouse-accessible.

Defaults to:

"el"

maxHeight : Number
bindable bind

The maximum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Defaults to:

null

getMaxHeight : Number

Returns the value of maxHeight

Returns

Number

setMaxHeight (maxHeight)

Sets the value of maxHeight

Parameters

maxHeight :  Number

maxWidth : Number
bindable bind

The maximum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Defaults to:

null

getMaxWidth : Number

Returns the value of maxWidth

Returns

Number

setMaxWidth (maxWidth)

Sets the value of maxWidth

Parameters

maxWidth :  Number

minButtonWidth : Number

Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default value for the Ext.button.Button#minWidth config of each Button added to the footer toolbar via the fbar or buttons configurations. It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.

Defaults to:

75

minHeight : Number
bindable bind

The minimum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

Defaults to:

null

getMinHeight : Number

Returns the value of minHeight

Returns

Number

setMinHeight (minHeight)

Sets the value of minHeight

Parameters

minHeight :  Number

minWidth : Number
bindable bind

The minimum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

Defaults to:

null

getMinWidth : Number

Returns the value of minWidth

Returns

Number

setMinWidth (minWidth)

Sets the value of minWidth

Parameters

minWidth :  Number

modal : Boolean

True to make the floated component modal and mask everything behind it when displayed, false to display it without restricting access to other UI elements.

Defaults to:

false

modelValidation : Boolean

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

When set to true by a component or not set by a component but inherited from an ancestor container, Ext.data.Validation records are used to automatically bind validation results for any form field to which a value is bound.

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}'
     }]
 }

The above is equivalent to the following manual binding of validation:

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

Notice that "validation" is a pseudo-association defined for all entities. See Ext.data.Model#getValidation for further details.

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

Defaults to:

''

Available since: 2.3.0

overflowX : String
deprecated dep

Possible values are:

  • 'auto' to enable automatic horizontal scrollbar (Style overflow-x: 'auto').
  • 'scroll' to always enable horizontal scrollbar (Style overflow-x: 'scroll').

The default is overflow-x: 'hidden'. This should not be combined with autoScroll.

Deprecated since version 5.1.0
Use scrollable instead

overflowY : String
deprecated dep

Possible values are:

  • 'auto' to enable automatic vertical scrollbar (Style overflow-y: 'auto').
  • 'scroll' to always enable vertical scrollbar (Style overflow-y: 'scroll').

The default is overflow-y: 'hidden'. This should not be combined with autoScroll.

Deprecated since version 5.1.0
Use scrollable instead

overlapHeader : Boolean

True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is done automatically for you). Otherwise it is undefined. If you manually add rounded corners to a panel header which does not have frame:true, this will need to be set to true.

padding : Number / String

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

placeholder : Ext.Component / Object

Important: This config is only effective for collapsible Panels which are direct child items of a Ext.layout.container.Border when not using the 'header' collapseMode.

Optional. A Component (or config object for a Component) to show in place of this Panel when this Panel is collapsed by a Ext.layout.container.Border. Defaults to a generated Ext.panel.Header containing a Ext.panel.Tool to re-expand the Panel.

placeholderCollapseHideMode : Number

The mode for hiding collapsed panels when using collapseMode "placeholder".

Defaults to:

Ext.Element.VISIBILITY

plugins : Ext.plugin.Abstract[] / Ext.plugin.Abstract / Object[] / Object / Ext.enums.Plugin[] / Ext.enums.Plugin

An array of plugins to be added to this component. Can also be just a single plugin instead of array.

Plugins provide custom functionality for a component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

Plugins can be added to component by either directly referencing the plugin instance:

plugins: [Ext.create('Ext.grid.plugin.CellEditing', {clicksToEdit: 1})],

By using config object with ptype:

plugins: {ptype: 'cellediting', clicksToEdit: 1},

Or with just a ptype:

plugins: ['cellediting', 'gridviewdragdrop'],

See Ext.enums.Plugin for list of all ptypes.

Available since: 2.3.0

getPlugins
private pri

Returns an array of current fully constructed plugin instances.

preventHeader : Boolean
deprecated dep

Defaults to:

false

Deprecated since version 4.1.0
Use header instead. Prevent a Header from being created and shown.

previewAltText : String

The text to place in the Preview image alt attribute.

Defaults to:

'Chart preview'

previewTitleText : String

The text to place in Preview Chart window title.

Defaults to:

'Chart Preview'

publishes : String / String[] / Object
bindable bind

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:

null

Available since: 5.0.0

getPublishes : String / String[] / Object

Returns the value of publishes

Returns

String / String[] / Object

setPublishes (publishes)

Sets the value of publishes

Parameters

publishes :  String / String[] / Object

rbar : Object / Object[]

Convenience config. Short for 'Right Bar' (right-docked, vertical toolbar).

rbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'right',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Defaults to:

null

reference : String
bindable bind

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

getReference : String

Returns the value of reference

Returns

String

setReference (reference)

Sets the value of reference

Parameters

reference :  String

referenceHolder : Boolean
bindable bind

If true, this container will be marked as being a point in the hierarchy where references to items with a specified reference config will be held. The container will automatically become a referenceHolder if a controller is specified.

See the introductory docs for Ext.container.Container for more information about references & reference holders.

Defaults to:

false

getReferenceHolder : Boolean

Returns the value of referenceHolder

Returns

Boolean

setReferenceHolder (referenceHolder)

Sets the value of referenceHolder

Parameters

referenceHolder :  Boolean

region : "north" / "south" / "east" / "west" / "center"

Defines the region inside Ext.layout.container.Border.

Possible values:

  • north - Positions component at top.
  • south - Positions component at bottom.
  • east - Positions component at right.
  • west - Positions component at left.
  • center - Positions component at the remaining space. There must be a component with region: "center" in every border layout.

Defaults to:

undefined

getRegion ( [contentBox] ) : Ext.util.Region

Returns a region object that defines the area of this element.

Parameters

contentBox :  Boolean (optional)

If true a box for the content of the element is returned.

Returns

:Ext.util.Region

A Region containing "top, left, bottom, right" properties.

renderConfig : Object

renderConfig wraps configs that do not get applied until after the component is rendered. Unlike normal config system properties, renderConfigs use a special setter method to store values on the instance instead of running the apply and update methods if it is called before the component is rendered. Then, after the component has been rendered, these values are processed by the normal apply and update method for the config.

This means that calling the get method for the config prior to render will return whatever raw value has been set, while calling the getter after render will return the value after processing by the config's apply method. If this distinction needs to be made, it is the caller's responsibility to check for the rendered state and handle such intermediate config values.

renderData : Object

The data used by renderTpl in addition to the following property values of the component:

  • id
  • ui
  • uiCls
  • baseCls
  • componentCls
  • frame

See renderSelectors and cfg-childEls for usage examples.

renderSelectors : Object
deprecated dep

An object containing properties specifying CSS selectors which identify child elements created by the render process.

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through, and the found Elements are added as properties to the Component using the renderSelector property name.

For example, a Component which renders a title and description into its element:

 Ext.create('Ext.Component', {
     renderTo: Ext.getBody(),
     renderTpl: [
         '<h1 class="title">{title}</h1>',
         '<p>{desc}</p>'
     ],
     renderData: {
         title: "Error",
         desc: "Something went wrong"
     },
     renderSelectors: {
         titleEl: 'h1.title',
         descEl: 'p'
     },
     listeners: {
         afterrender: function(cmp){
             // After rendering the component will have a titleEl and descEl properties
             cmp.titleEl.setStyle({color: "red"});
         }
     }
 });

The use of renderSelectors is deprecated (for performance reasons). The above code should be refactored into something like this:

 Ext.create('Ext.Component', {
     renderTo: Ext.getBody(),
     renderTpl: [
         '<h1 class="title" id="{id}-titleEl" data-ref="titleEl">{title}</h1>',
         '<p id="{id}-descEl" data-ref="descEl">{desc}</p>'
     ],
     renderData: {
         title: "Error",
         desc: "Something went wrong"
     },
     childEls: [
         'titleEl',
         'descEl'
     ]
 });

To use childEls yet retain the use of selectors (which remains as expensive as renderSelectors):

 Ext.create('Ext.Component', {
     renderTo: Ext.getBody(),
     renderTpl: [
         '<h1 class="title">{title}</h1>',
         '<p>{desc}</p>'
     ],
     renderData: {
         title: "Error",
         desc: "Something went wrong"
     },
     childEls: {
         titleEl: { selectNode: 'h1.title' },
         descEl: { selectNode: 'p' }
     }
 });

Deprecated since version 5.0
Use cfg-childEls instead.

renderTo : String / HTMLElement / Ext.dom.Element

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.

Notes:

Do not use this option if the Component is to be a child item of a Ext.container.Container. It is the responsibility of the Ext.container.Container's layout manager to render and manage its child items.

When using this config, a call to render() is not required.

See also: method-render.

Available since: 2.3.0

renderTpl : Ext.XTemplate / String / String[]
protected pro

An Ext.XTemplate used to create the internal structure inside this Component's encapsulating Element.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized classes with complex DOM structures provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors and cfg-childEls options.

Defaults to:

'{%this.renderContent(out,values)%}'

resizable : Boolean / Object

Specify as true to apply a Ext.resizer.Resizer to this Component after rendering.

May also be specified as a config object to be passed to the constructor of Ext.resizer.Resizer to override any defaults. By default the Component passes its minimum and maximum size, and uses Ext.resizer.Resizer#dynamic: false

resizeHandler : Function
bindable bind

The resize function that can be configured to have a behavior, e.g. resize draw surfaces based on new draw container dimensions. The resizeHandler function takes a single parameter - the size object with width and height properties.

Note: Since resize events trigger renderFrame calls automatically, return false from the resize function, if it also calls renderFrame, to prevent double rendering.

Defaults to:

null

getResizeHandler : Function

Returns the value of resizeHandler

Returns

Function

setResizeHandler (resizeHandler)

Sets the value of resizeHandler

Parameters

resizeHandler :  Function

resizeHandles : String

A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.

Defaults to:

'all'

saveDelay : Number

A buffer to be applied if many state events are fired within a short period.

Defaults to:

100

scrollable : Boolean / String / Object
bindable bind

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

getScrollable : Boolean / String / Object

Returns the value of scrollable

Returns

Boolean / String / Object

setScrollable (scrollable)

Sets the value of scrollable

Parameters

scrollable :  Boolean / String / Object

session : Boolean / Object / Ext.data.Session
bindable bind

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

getSession : Boolean / Object / Ext.data.Session

Returns the value of session

Returns

Boolean / Object / Ext.data.Session

setSession (session)

Sets the value of session

Parameters

session :  Boolean / Object / Ext.data.Session

shadow : String / Boolean

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow#mode. Set to false to disable the shadow.

Defaults to:

'sides'

shadowOffset : Number

Number of pixels to offset the shadow.

shim : Boolean

true to enable an iframe shim for this Component to keep windowed objects from showing through.

shrinkWrap : Number

The possible values for shrinkWrap are:

  • 0 (or false): Neither width nor height depend on content.
  • 1: Width depends on content (shrink wraps), but height does not.
  • 2: Height depends on content (shrink wraps), but width does not.
  • 3 (or true): Both width and height depend on content (shrink wrap).

In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element.

Panels (subclasses and instances)

By default, when a panel is configured to shrink wrap in a given dimension, only the panel's "content" (items and html content inside the panel body) contributes to its size, and the content of docked items is ignored. Optionally you can use the shrinkWrapDock config to allow docked items to contribute to the panel's size as well. For example, if shrinkWrap and shrinkWrapDock are both set to true, the width of the panel would be the width of the panel's content and the panel's header text.

Defaults to:

2

shrinkWrapDock : Boolean / Number

Allows for this panel to include the dockedItems when trying to determine the overall size of the panel. This option is only applicable when this panel is also shrink wrapping in the same dimensions. See Ext.Panel#shrinkWrap for an explanation of the configuration options.

Defaults to:

false

simpleDrag : Boolean

When cfg-draggable is true, Specify this as true to cause the draggable config to work the same as it does in Ext.window.Window. This Panel just becomes movable. No DragDrop instances receive any notifications. For example:

Defaults to:

false

sprites : Object[]
bindable bind

Defines a set of sprites to be added to the drawContainer surface.

For example:

 sprites: [{
      type: 'circle',
      fillStyle: '#79BB3F',
      r: 100,
      x: 100,
      y: 100
 }]

Defaults to:

null

getSprites : Object[]

Returns the value of sprites

Returns

Object[]

setSprites (sprites)

Sets the value of sprites

Parameters

sprites :  Object[]

stateEvents : String[]

An array of events that, when fired, should trigger this object to save its state. stateEvents defaults to the stateEvents associated with the component you are using. Any events you statically set will be appended to that list. stateEvents may be any type of event supported by this object, including browser or custom events (e.g., ['click', 'customerchange']).

See stateful for an explanation of saving and restoring object state. By default the following stateEvents are added:

stateful : Boolean / Object
bindable bind

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. The object must have a stateId for state to be managed.

Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a object.

For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available.

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({ expires: new Date(new Date().getTime()+(10006060247)), //7 days from now }));

A stateful object attempts to save state when one of the events listed in the stateEvents configuration fires.

To save state, a stateful object first serializes its state by calling getState.

The Component base class implements getState to save its width and height within the state only if they were initially configured, and have changed from the configured value.

The Panel class saves its collapsed state in addition to that.

The Grid class saves its column state and store state (sorters and filters and grouper) in addition to its superclass state.

If there is more application state to be save, the developer must provide an implementation which first calls the superclass method to inherit the above behaviour, and then injects new properties into the returned object.

The value yielded by getState is passed to Ext.state.Manager#set which uses the configured Ext.state.Provider to save the object keyed by the stateId.

During construction, a stateful object attempts to restore its state by calling Ext.state.Manager#get passing the stateId

The resulting object is passed to applyState*. The default implementation of applyState simply copies properties into the object, but a developer may override this to support restoration of more complex application state.

You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events. In some simple cases, passing an object for the stateful config may suffice. If an object is provided, the properties of that object are used to include or exclude stateful properties returned by getState. For example:

 stateful: {
     height: false, // never persist the height
     width: true    // always persist the width
 }

The above is roughly equivalent to the following:

 getState: function () {
     var state = this.callParent();

     delete state.height;
     state.width = this.width;

     return state;
 }

Defaults to:

false

getStateful : Boolean / Object

Returns the value of stateful

Returns

Boolean / Object

setStateful (stateful)

Sets the value of stateful

Parameters

stateful :  Boolean / Object

stateId : String

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

See stateful for an explanation of saving and restoring state.

getStateId String
private pri

Gets the state id for this object.

Returns

:String

The 'stateId' or the implicit 'id' specified by component configuration.

style : String / Object
bindable bind

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.dom.Element#applyStyles.

new Ext.panel.Panel({
    title: 'Some Title',
    renderTo: Ext.getBody(),
    width: 400, height: 300,
    layout: 'form',
    items: [{
        xtype: 'textarea',
        style: {
            width: '95%',
            marginBottom: '10px'
        }
    },
    new Ext.button.Button({
        text: 'Send',
        minWidth: '100',
        style: {
            marginBottom: '10px'
        }
    })
    ]
});

Available since: 1.1.0

setStyle ( property, [value] ) : Ext.Component
chainable ch

Sets the style for this Component's primary element.

Styles should be a valid DOM element style property. Valid style property names (along with the supported CSS version for each)

var name = Ext.create({
    xtype: 'component',
    renderTo: Ext.getBody(),
    html: 'Phineas Flynn'
});

// two-param syntax
name.setStyle('color', 'white');

// single-param syntax
name.setStyle({
    fontWeight: 'bold',
    backgroundColor: 'gray',
    padding: '10px'
});

Parameters

property :  String/Object

The style property to be set, or an object of multiple styles.

value :  String (optional)

The value to apply to the given property, or null if an object was passed.

Returns

:Ext.Component

this

suspendLayout : Boolean

If true, suspend calls to updateLayout. Useful when batching multiple adds to a container and not passing them as multiple arguments or an array.

Defaults to:

false

tabGuard : Boolean
private pri

When set to true, two elements are added to the container's element. These are the tabGuardBeforeEl and tabGuardAfterEl.

Available since: 6.0.0

tabIndex : Number
bindable bind

DOM tabIndex attribute for this Focusable's focusEl.

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

setTabIndex ( newTabIndex )

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

tbar : Object / Object[]

Convenience config. Short for 'Top Bar'.

tbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'top',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Defaults to:

null

title : String / Object
bindable bind

The title text or config object for the Ext.panel.Title component. When a title is specified, the Ext.panel.Header will automatically be created and displayed unless header is set to false.

Defaults to:

null

getTitle : String / Object

Returns the value of title

Returns

String / Object

setTitle ( title )

Sets the title of this panel.

Parameters

title :  String

The new title

titleAlign : 'left' / 'center' / 'right'
bindable bind

The alignment of the title text within the available space between the icon and the tools.

Defaults to:

'left'

getTitleAlign : 'left' / 'center' / 'right'

Returns the value of titleAlign

Returns

'left' / 'center' / 'right'

setTitleAlign (titleAlign)

Sets the value of titleAlign

Parameters

titleAlign :  'left' / 'center' / 'right'

titleCollapse : Boolean

true to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false) to allow it only by clicking to tool button). When a panel is used in a Ext.layout.container.Border, the floatable option can influence the behavior of collapsing.

Defaults to:

undefined

titleRotation : 'default' / 0 / 1 / 2
bindable bind

The rotation of the header's title text. Can be one of the following values:

  • 'default' - use the default rotation, depending on the dock position of the header
  • 0 - no rotation
  • 1 - rotate 90deg clockwise
  • 2 - rotate 90deg counter-clockwise

The default behavior of this config depends on the dock position of the header:

  • 'top' or 'bottom' - 0
  • 'right' - 1
  • 'left' - 1

Defaults to:

'default'

getTitleRotation : 'default' / 0 / 1 / 2

Returns the value of titleRotation

Returns

'default' / 0 / 1 / 2

setTitleRotation (titleRotation)

Sets the value of titleRotation

Parameters

titleRotation :  'default' / 0 / 1 / 2

toFrontOnShow : Boolean

True to automatically call toFront when the method-show method is called on an already visible, floating component.

Defaults to:

true

tools : Object[] / Ext.panel.Tool[]

An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as child components of the header container. They can be accessed using down and {#query}, as well as the other component methods. The toggle tool is automatically created if collapsible is set to true.

Note that, apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior.

Example usage:

tools:[{
    type:'refresh',
    tooltip: 'Refresh form Data',
    // hidden:true,
    handler: function(event, toolEl, panelHeader) {
        // refresh logic
    }
},
{
    type:'help',
    tooltip: 'Get Help',
    callback: function(panel, tool, event) {
        // show help here
    }
}]

The difference between handler and callback is the signature. For details on the distinction, see Ext.panel.Tool.

touchAction : Object
bindable bind

Emulates the behavior of the CSS href="https://www.w3.org/TR/pointerevents/#the-touch-action-css-property" class="external-link" target="_blank">https://www.w3.org/TR/pointerevents/#the-touch-action-css-property 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 child elements using the child 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.Component', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

getTouchAction : Object

Returns the value of touchAction

Returns

Object

setTouchAction (touchAction)

Sets the value of touchAction

Parameters

touchAction :  Object

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

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

Available since: 3.4.0

getTpl ( name )
private pri

Parameters

name :  Object

tplWriteMode : String

The Ext.(X)Template method to use when updating the content area of the Component. See Ext.XTemplate#overwrite for information on default mode.

Defaults to:

'overwrite'

Available since: 3.4.0

twoWayBindable : String / String[] / Object
bindable bind

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:

null

getTwoWayBindable : String / String[] / Object

Returns the value of twoWayBindable

Returns

String / String[] / Object

setTwoWayBindable (twoWayBindable)

Sets the value of twoWayBindable

Parameters

twoWayBindable :  String / String[] / Object

ui : String
bindable bind

A UI style for a component.

Defaults to:

'default'

setUI ( ui )

Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any uiCls set on the component and rename them so they include the new UI.

Parameters

ui :  String

The new UI for the component.

uiCls : String[]
private pri

An array of of classNames which are currently applied to this component.

Defaults to:

[]

userCls : String / String[]
bindable bind

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

getUserCls : String / String[]

Returns the value of userCls

Returns

String / String[]

setUserCls (userCls)

Sets the value of userCls

Parameters

userCls :  String / String[]

viewModel : String / Object / Ext.app.ViewModel
bindable bind

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

getViewModel : String / Object / Ext.app.ViewModel

Returns the value of viewModel

Returns

String / Object / Ext.app.ViewModel

setViewModel (viewModel)

Sets the value of viewModel

Parameters

viewModel :  String / Object / Ext.app.ViewModel

weight : Number

A value to control how Components are laid out in a Ext.layout.container.Border layout or as docked items.

In a Border layout, this can control how the regions (not the center) region lay out if the west or east take full height or if the north or south region take full width. Also look at the Ext.layout.container.Border#regionWeights on the Border layout. An example to show how you can take control of this is:

Ext.create('Ext.container.Viewport', {
    layout      : 'border',
    defaultType : 'panel',
    items       : [
        {
            region : 'north',
            title  : 'North',
            height : 100
        },
        {
            region : 'south',
            title  : 'South',
            height : 100,
            weight : -25
        },
        {
            region : 'west',
            title  : 'West',
            width  : 200,
            weight : 15
        },
        {
            region : 'east',
            title  : 'East',
            width  : 200
        },
        {
            region : 'center',
            title  : 'center'
        }
    ]
});

If docked items, the weight will order how the items are laid out. Here is an example to put a Ext.toolbar.Toolbar above a Ext.panel.Panel's header:

Ext.create('Ext.panel.Panel', {
    renderTo    : document.body,
    width       : 300,
    height      : 300,
    title       : 'Panel',
    html        : 'Panel Body',
    dockedItems : [
        {
            xtype : 'toolbar',
            items : [
                {
                    text : 'Save'
                }
            ]
        },
        {
            xtype  : 'toolbar',
            weight : -10,
            items  : [
                {
                    text : 'Remove'
                }
            ]
        }
    ]
});

Defaults to:

null

width : Number / String
bindable bind

The width of this component. A numeric value will be interpreted as the number of pixels; a string value will be treated as a CSS value with units.

getWidth Number

Gets the current width of the component's underlying element.

Returns

:Number

setWidth ( width ) : Ext.Component

Sets the width of the component. This method fires the resize event.

Parameters

width :  Number

The new width to set. This may be one of:

  • A Number specifying the new width in pixels.
  • A String used to set the CSS width style.
  • undefined to leave the width unchanged.
  • null to clear the width.

Returns

:Ext.Component

this

xtype : Ext.enums.Widget

Note: Only applies to Ext.Component derived classes when used as a config in Ext.define.

This property provides a shorter alternative to creating objects than using a full class name. Using xtype is the most common way to define component instances, especially in a container. For example, the items in a form containing text fields could be created explicitly like so:

 items: [
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Foo'
     }),
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Bar'
     }),
     Ext.create('Ext.form.field.Number', {
         fieldLabel: 'Num'
     })
 ]

But by using xtype, the above becomes:

 items: [
     {
         xtype: 'textfield',
         fieldLabel: 'Foo'
     },
     {
         xtype: 'textfield',
         fieldLabel: 'Bar'
     },
     {
         xtype: 'numberfield',
         fieldLabel: 'Num'
     }
 ]

When the xtype is common to many items, Ext.container.Container#defaultType is another way to specify the xtype for all items that don't have an explicit xtype:

 defaultType: 'textfield',
 items: [
     { fieldLabel: 'Foo' },
     { fieldLabel: 'Bar' },
     { fieldLabel: 'Num', xtype: 'numberfield' }
 ]

Each member of the items array is now just a "configuration object". These objects are used to create and configure component instances. A configuration object can be manually used to instantiate a component using Ext#widget:

 var text1 = Ext.create('Ext.form.field.Text', {
     fieldLabel: 'Foo'
 });

 // or alternatively:

 var text1 = Ext.widget({
     xtype: 'textfield',
     fieldLabel: 'Foo'
 });

This conversion of configuration objects into instantiated components is done when a container is created as part of its {Ext.container.AbstractContainer#initComponent} process. As part of the same process, the items array is converted from its raw array form into a Ext.util.MixedCollection instance.

You can define your own xtype on a custom Ext.Component by specifying the xtype property in Ext#define. For example:

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

Care should be taken when naming an xtype in a custom component because there is a single, shared scope for all xtypes. Third part components should consider using a prefix to avoid collisions.

Ext.define('Foo.form.CoolButton', {
    extend: 'Ext.button.Button',
    xtype: 'ux-coolbutton',
    text: 'Cool!'
});

See Ext.enums.Widget for list of all available xtypes.

Available since: 2.3.0

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

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

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

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

Defaults to:

true

Available since: 5.0.0

$eventOptions
private pri

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
}

$vetoClearingPrototypeOnDestroy
private pri

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

_applyDefaultsOptions
private pri

Defaults to:

{
    defaults: true,
    strict: false
}

_isLayoutRoot : Boolean
protected pro

Setting this property to true causes the isLayoutRoot method to return true and stop the search for the top-most component for a layout.

Defaults to:

false

_renderState : Number
readonly ro private pri

This property holds one of the following values during the render process:

  • 0 - The component is not rendered.
  • 1 - The component has fired beforerender and is about to call beforeRender. The component has just started rendering.
  • 2 - The component has finished the beforeRender process and is about to call onRender. This is when rendering is set to true.
  • 3 - The component has started onRender. This is when rendered is set to true.
  • 4 - The component has finished its afterrender process.

Defaults to:

0

Available since: 5.0.0

allowDomMove
private pri

Defaults to:

true

ariaEl : String
readonly ro private pri

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

ariaRenderAttributes : Object
private pri

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

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

autoGenId : Boolean
private pri

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

Defaults to:

false

body : Ext.dom.Element
readonly ro

The Panel's body Ext.dom.Element which may be used to contain HTML content. The content may be specified in the html config, or it may be loaded using the loader config. Read-only.

If this is used to load visible HTML elements in either way, then the Panel may not be used as a Layout for hosting nested Panels.

If this Panel is intended to be used as the host of a Layout (See layout then the body Element must not be loaded or changed - it is under the control of the Panel's Layout.

borderBoxCls
private pri

Defaults to:

Ext.baseCSSPrefix + 'border-box'

clearPropertiesOnDestroy : Boolean / "async"
protected pro

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

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

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

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

Defaults to:

false

Available since: 6.2.0

componentLayoutCounter : Number
private pri

The number of component layout calls made on this object.

Defaults to:

0

contentPaddingProperty : String

The name of the padding property that is used by the layout to manage padding. See managePadding

Defaults to:

'bodyPadding'

dd : Ext.dd.DragSource / Ext.util.ComponentDragger
private pri

Only present if this Panel has been configured with cfg-draggable true.

Simple dragging

If this Panel is configured cfg-simpleDrag true (the default is false), this property will reference an instance of Ext.util.ComponentDragger (A subclass of Ext.dd.DragTracker) which handles moving the Panel's DOM Element, and constraining according to the constrain and constrainHeader .

This object fires various events during its lifecycle and during a drag operation.

Complex dragging interacting with other DragDrop instances

By default, this property in a cfg-draggable Panel will contain an instance of Ext.dd.DragSource which handles dragging the Panel.

The developer must provide implementations of the abstract methods of Ext.dd.DragSource in order to supply behaviour for each stage of the drag/drop process.

See also cfg-draggable.

Defaults to:

new Ext.panel.DD(me, Ext.isBoolean(me.draggable) ? null : me.draggable)

defaultBindProperty : String
protected pro

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:

null

defaultDownloadServerUrl : String

The default URL used by download.

Defaults to:

"http://svg.sencha.io"

deferLayouts
private pri

Defaults to:

false

destroyed : Boolean
protected pro

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

Defaults to:

false

dockOrder
private pri

Values to decide which side of the body element docked items must go This overides any weight. A left/top will always sort before a right/bottom regardless of any weight value. Weights sort at either side of the "body" dividing point.

Defaults to:

{
    top: -1,
    left: -1,
    right: 1,
    bottom: 1
}

eventsSuspended
private pri

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

Defaults to:

0

floating : Boolean
readonly ro private pri

The value true indicates that this Component is floating.

floatingItems : Ext.util.MixedCollection

The MixedCollection containing all the floating child items of this container. Will be undefined if there are no floating child items.

Available since: 4.1.0

floatParent : Ext.container.Container
readonly ro

Only present for cfg-floating Components which were inserted as child items of Containers.

There are other similar relationships such as the Ext.button.Button which activates a menu, or the Ext.menu.Item which activated a submenu, or the Ext.grid.column.Column which activated the column menu.

These differences are abstracted away by the up method.

Floating Components that are programmatically rendered will not have a floatParent property.

See cfg-floating and zIndexManager

focusable : Boolean
readonly ro

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

Note: Plain components are static, so not focusable.

Defaults to:

false

focusEl : Ext.dom.Element
private pri

The component's focusEl. Available after rendering.

frameSize : Object
readonly ro

Indicates the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config. This property is null if the component is not framed.

This is an object containing the frame width in pixels for all four sides of the Component containing the following properties:

Defaults to:

null

Properties

top : Number

The width of the top framing element in pixels.

Defaults to: 0

right : Number

The width of the right framing element in pixels.

Defaults to: 0

bottom : Number

The width of the bottom framing element in pixels.

Defaults to: 0

left : Number

The width of the left framing element in pixels.

Defaults to: 0

width : Number

The total width of the left and right framing elements in pixels.

Defaults to: 0

height : Number

The total height of the top and right bottom elements in pixels.

Defaults to: 0

hasFocus : Boolean
private pri

true if this component has focus.

Defaults to:

false

hasListeners : Object
readonly ro

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);
 }

horizontalDocks
private pri

Number of dock 'left' and 'right' items.

Defaults to:

0

horizontalPosProp
private pri

Defaults to:

'left'

initialConfig : Object
readonly ro

The config object passed to the constructor during Component creation.

Defaults to:

config

isComponent : Boolean

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

Defaults to:

true

isConfiguring : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isContainer : Boolean

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

Defaults to:

true

isFirstInstance : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

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

Defaults to:

true

isObservable : Boolean

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

Defaults to:

true

isPanel : Boolean

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

Defaults to:

true

items : Ext.util.ItemCollection

The Collection containing all the child items of this container.

Defaults to:

new Ext.util.ItemCollection()

Available since: 2.3.0

layoutCounter : Number
private pri

The number of container layout calls made on this object.

Defaults to:

0

layoutSuspendCount
private pri

Defaults to:

0

maskOnDisable : Boolean

This is an internal flag that you use when creating custom components. By default this is set to true which means that every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

Defaults to:

true

ownerCt : Ext.container.Container
readonly ro

This Component's owner Ext.container.Container (is set automatically when this Component is added to a Container).

Important. This is not a universal upwards navigation pointer. It indicates the Container which owns and manages this Component if any. There are other similar relationships such as the Ext.button.Button which activates a menu, or the Ext.menu.Item which activated a submenu, or the Ext.grid.column.Column which activated the column menu.

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

rendered : Boolean
readonly ro

Indicates whether or not the component has been rendered.

Defaults to:

false

Available since: 1.1.0

rootCls
private pri

Defaults to:

Ext.baseCSSPrefix + 'body'

scrollerCls
private pri

Defaults to:

Ext.baseCSSPrefix + 'scroll-scroller'

scrollFlags : Object
readonly ro private pri

An object property which provides unified information as to which dimensions are scrollable based upon the scrollable settings (And for views of trees and grids, the owning panel's scroll setting).

Note that if you set overflow styles using the style config or bodyStyle config, this object does not include that information. Use scrollable if you need to access these flags.

This object has the following properties:

Defaults to:

{
    auto: {
        // x:auto, y:auto
        auto: {
            overflowX: 'auto',
            overflowY: 'auto',
            x: true,
            y: true,
            both: true
        },
        // x:auto, y:false
        'false': {
            overflowX: 'auto',
            overflowY: 'hidden',
            x: true,
            y: false,
            both: false
        },
        // x:auto, y:scroll
        scroll: {
            overflowX: 'auto',
            overflowY: 'scroll',
            x: true,
            y: true,
            both: true
        }
    },
    'false': {
        // x:false, y:auto
        auto: {
            overflowX: 'hidden',
            overflowY: 'auto',
            x: false,
            y: true,
            both: false
        },
        // x:false, y:false
        'false': {
            overflowX: 'hidden',
            overflowY: 'hidden',
            x: false,
            y: false,
            both: false
        },
        // x:false, y:scroll
        scroll: {
            overflowX: 'hidden',
            overflowY: 'scroll',
            x: false,
            y: true,
            both: false
        }
    },
    scroll: {
        // x:scroll, y:auto
        auto: {
            overflowX: 'scroll',
            overflowY: 'auto',
            x: true,
            y: true,
            both: true
        },
        // x:scroll, y:false
        'false': {
            overflowX: 'scroll',
            overflowY: 'hidden',
            x: true,
            y: false,
            both: false
        },
        // x:scroll, y:scroll
        scroll: {
            overflowX: 'scroll',
            overflowY: 'scroll',
            x: true,
            y: true,
            both: true
        }
    },
    none: {
        overflowX: '',
        overflowY: '',
        x: false,
        y: false,
        both: false
    }
}

Properties

x : Boolean

true if this Component is scrollable horizontally - style setting may be 'auto' or 'scroll'.

y : Boolean

true if this Component is scrollable vertically - style setting may be 'auto' or 'scroll'.

both : Boolean

true if this Component is scrollable both horizontally and vertically.

overflowX : String

The overflow-x style setting, 'auto' or 'scroll' or ''.

overflowY : String

The overflow-y style setting, 'auto' or 'scroll' or ''.

self : Ext.Class
protected pro

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

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

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

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


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

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

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

Defaults to:

Base

supportedFormats : Array
private pri

A list of export types supported by the server.

Defaults to:

["png", "pdf", "jpeg", "gif"]

synthetic : Boolean
private pri

This property is true if the component was created internally by the framework and is not explicitly user-defined. This is set for such things as Splitter instances managed by border and box layouts.

Defaults to:

false

tabGuardAfterEl : Ext.dom.Element
private pri

This element reference is generated when tabGuard is true. This element is generated after all dockedItems in the DOM.

Available since: 6.0.0

tabGuardAfterIndex : Number
private pri

The tabIndex attribute value to assign to the "after" tab guard element. Default is undefined for automatic detection from the DOM.

Available since: 6.2.0

tabGuardBeforeEl : Ext.dom.Element
private pri

This element reference is generated when tabGuard is true. This element is generated before all dockedItems in the DOM.

Available since: 6.0.0

tabGuardBeforeIndex : Number
private pri

The tabIndex attribute value to assign to the "before" tab guard element. Default is undefined for automatic detection from the DOM.

Available since: 6.2.0

tabGuardElements : Object
private pri

Read only object containing property names for tab guard elements, keyed by position.

Defaults to:

{
    before: 'tabGuardBeforeEl',
    after: 'tabGuardAfterEl'
}

Available since: 6.2.0

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

This template is used to generate the tabGuard elements. It is used once per element (see tabGuardBeforeEl and tabGuardAfterEl).

Defaults to:

// We use span instead of div because of IE bug/misfeature: it will focus
// block elements upon clicking or calling node.focus() regardless of
// tabIndex attribute. It doesn't do that with inline elements, hence span.
'<span id="{id}-{tabGuardEl}" data-ref="{tabGuardEl}" aria-hidden="true"' + ' class="' + Ext.baseCSSPrefix + 'tab-guard ' + Ext.baseCSSPrefix + 'tab-guard-{tabGuardPosition}"' + ' style="width:0px;height:0px;">' + '</span>'

Available since: 6.0.0

validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to:

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

zIndexManager : Ext.ZIndexManager
readonly ro

Only present for floating Components after they have been rendered.

A reference to the ZIndexManager which is managing this Component's z-index.

The Ext.ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal mask which is insert just beneath the topmost visible modal floating Component.

Floating Components may be brought to the front or sent to the back of the z-index stack.

This defaults to the global Ext.WindowManager for floating Components that are programatically rendered.

For floating Components that are added to a Container, the ZIndexManager is acquired from the first ancestor Container found that is floating. If no floating ancestor is found, the global Ext.WindowManager is used.

See Ext.Component#cfg-floating and zIndexParent

zIndexParent : Ext.container.Container
readonly ro

Only present for Ext.Component#cfg-floating Components which were inserted as child items of Containers, and which have a floating Container in their containment ancestry.

For Ext.Component#cfg-floating Components which are child items of a Container, the zIndexParent will be a floating ancestor Container which is responsible for the base z-index value of all its floating descendants. It provides a Ext.ZIndexManager which provides z-indexing services for all its descendant floating Components.

Floating Components that are programmatically rendered will not have a zIndexParent property.

For example, the dropdown Ext.view.BoundList of a ComboBox which is in a Window will have the Window as its zIndexParent, and will always show above that Window, wherever the Window is placed in the z-index stack.

See Ext.Component#cfg-floating and zIndexManager

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean

true if any listeners were added

add ( component ) : Ext.Component[]/Ext.Component

Adds Ext.Component(s) to this Container.

Description:

Notes:

If the Container is already rendered when add is called, it will render the newly added Component into its content area.

If the Container was configured with a size-managing layout manager, the Container will recalculate its internal layout at this time too.

Note that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.

If adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.

tb = new Ext.toolbar.Toolbar({
    renderTo: document.body
});  // toolbar is rendered
// add multiple items.
// default type for Toolbar is 'button')
tb.add([{text:'Button 1'}, {text:'Button 2'}]);

To inject components between existing ones, use the insert method.

Warning:

Components directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for Ext.layout.container.Border for more details.

Available since: 2.3.0

Parameters

component :  Ext.Component[]/Object[]/Ext.Component.../Object...

Either one or more Components to add or an Array of Components to add. See cfg-items for additional information.

Returns

:Ext.Component[]/Ext.Component

The Components that were added.

addBindableUpdater ( property )
private pri

Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.

Available since: 5.0.0

Parameters

property :  String

The name of the config property.

addBodyCls ( cls ) : Ext.panel.Panel
chainable ch

Adds a CSS class to the body element. If not rendered, the class will be added when the panel is rendered.

Parameters

cls :  String/String[]

The class to add

Returns

:Ext.panel.Panel

this

addChildEl ( childEl )
private pri

Add a childEl specific to this instance. This must be called before render.

Available since: 6.0.0

Parameters

childEl :  Object

addClass ( cls ) : Ext.Component
deprecated dep

Adds a CSS class to the top level element representing this component.

Available since: 2.3.0

Parameters

cls :  String/String[]

The CSS class name to add.

Returns

:Ext.Component

Returns the Component to allow method chaining.

Deprecated since version 4.1
Use addCls instead.

addCls ( cls ) : Ext.Component
chainable ch

Adds a CSS class to the top level element representing this component.

Parameters

cls :  String/String[]

The CSS class name to add.

Returns

:Ext.Component

Returns the Component to allow method chaining.

addClsWithUI ( classes, [skip] )

Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component.

Parameters

classes :  String/String[]

A string or an array of strings to add to the uiCls.

skip :  Boolean (optional)

true to skip adding it to the class and do it later (via the return).

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

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

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

Parameters

deprecations :  Object

addDocked ( items, [pos] ) : Ext.Component[]

Adds docked item(s) to the container.

Parameters

items :  Object/Object[]

The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left').

pos :  Number (optional)

The index at which the Component will be added

Returns

:Ext.Component[]

The added components.

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

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.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

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

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.SomeGlobalSharedMenu, '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 )
protected pro

Adds a plugin. May be called at any time in the component's life cycle.

Parameters

plugin :  Object

addPropertyToState ( state, propName, [value] ) : Object
protected pro

Save a property to the given state object if it is not its default or configured value.

Parameters

state :  Object

The state object.

propName :  String

The name of the property on this object to save.

value :  String (optional)

The value of the state property (defaults to this[propName]).

Returns

:Object

The state object or a new object if state was null and the property was saved.

addStateEvents ( events )

Add events that will trigger the state to be saved. If the first argument is an array, each element of that array is the name of a state event. Otherwise, each argument passed to this method is the name of a state event.

Parameters

events :  String/String[]

The event name or an array of event names.

addTool ( tools )

Add tools to this panel

Parameters

tools :  Object[]/Ext.panel.Tool[]

The tools to add.

By default the tools will be accessible via keyboard, with the exception of automatically added collapse/expand and close tools.

If you implement keyboard equivalents of your tools' actions elsewhere and do not want the tools to participate in keyboard navigation, you can make them presentational instead:

 panel.addTool({
     type: 'mytool',
     focusable: false,
     ariaRole: 'presentation',
     ...
 });

addTools
template tpl protected pro

Template method to be implemented in subclasses to add their tools after the collapsible tool.

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

addUIClsToElement ( cls )

Method which adds a specified UI + uiCls to the components element. Can be overridden to add the UI to more than just the component's element.

Parameters

cls :  Object

addUIToElement
private pri

Method which adds a specified UI to the components element.

adjustForConstraints ( xy, parent )
private pri

Parameters

xy :  Object

parent :  Object

adjustPosition ( x, y )
private pri

Parameters

x :  Object

y :  Object

afterClassMixedIn ( targetClass )
private pri

Called after the mixin is applied. We need to see if childEls were used by the targetClass and apply them to the config.

Parameters

targetClass :  Ext.Class

afterCollapse ( animated )
template tpl protected pro

Invoked after the Panel is Collapsed.

Parameters

animated :  Boolean

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

afterComponentLayout ( width, height, oldWidth, oldHeight )
template tpl protected pro

Called by the layout system after the Component has been laid out.

This method is not called on components that use cfg-liquidLayout, such as Ext.button.Button and Ext.form.field.Base.

Parameters

width :  Number

The width that was set

height :  Number

The height that was set

oldWidth :  Number/undefined

The old width, or undefined if this was the initial layout.

oldHeight :  Number/undefined

The old height, or undefined if this was the initial layout.

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

afterExpand ( animated )
template tpl protected pro

Invoked after the Panel is Expanded.

Parameters

animated :  Boolean

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

afterHide ( [callback], [scope] )
template tpl protected pro

Invoked after the Component has been hidden.

Gets passed the same callback and scope parameters that #onHide received.

Parameters

callback :  Function (optional)

scope :  Object (optional)

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

afterLayout ( layout )
template tpl protected pro

Invoked after the Container has laid out (and rendered if necessary) its child Components.

Parameters

layout :  Ext.layout.container.Container

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

afterRender
template tpl protected pro

Allows additional behavior after rendering is complete. At this stage, the Ext.Component Element will have been styled according to the configuration, will have had any configured CSS class names added, and will be in the configured visibility and configured enable state.

Note: If the Component has a ViewController and the controller has an afterRender method it will be called passing the Component as the single param.

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

afterSetPosition ( x, y )
template tpl protected pro

Template method called after a Component has been positioned.

Parameters

x :  Number

y :  Number

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

afterShow ( [animateTarget], [callback], [scope] )
template tpl protected pro

Invoked after the Component is shown (after #onShow is called).

Gets passed the same parameters as #show.

Parameters

animateTarget :  String/Ext.dom.Element (optional)

callback :  Function (optional)

scope :  Object (optional)

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

alignTo ( element, [position], [offsets] ) : Ext.util.Positionable

Aligns the element with another element relative to the specified anchor points. If the other element is the document it aligns it to the viewport. The position parameter is optional, and can be specified in any one of the following formats:

  • Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
  • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.
  • Two edge/offset descriptors: An edge/offset descriptor is an edge initial (t/r/b/l) followed by a percentage along that side. This describes a point to align with a similar point in the target. So 't0-b0' would be the same as 'tl-bl', 'l0-r50' would place the top left corner of this item halfway down the right edge of the target item. This allows more flexibility and also describes which two edges are considered adjacent when positioning a tip pointer.

In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints. Following are all of the supported anchor positions:

 Value  Description
 -----  -----------------------------
 tl     The top left corner
 t      The center of the top edge
 tr     The top right corner
 l      The center of the left edge
 c      The center
 r      The center of the right edge
 bl     The bottom left corner
 b      The center of the bottom edge
 br     The bottom right corner

Example Usage:

// align el to other-el using the default positioning
// ("tl-bl", non-constrained)
el.alignTo("other-el");

// align the top left corner of el with the top right corner of other-el
// (constrained to viewport)
el.alignTo("other-el", "tl-tr?");

// align the bottom right corner of el with the center left edge of other-el
el.alignTo("other-el", "br-l?");

// align the center of el with the bottom left corner of other-el and
// adjust the x position by -6 pixels (and the y position by 0)
el.alignTo("other-el", "c-bl", [-6, 0]);

// align the 25% point on the bottom edge of this el
// with the 75% point on the top edge of other-el.
el.alignTo("other-el", 'b25-c75');

Parameters

element :  Ext.util.Positionable/HTMLElement/String

The Positionable, HTMLElement, or id of the element to align to.

position :  String (optional)

The position to align to

Defaults to: "tl-bl?"

offsets :  Number[] (optional)

Offset the positioning by [x, y] Element animation config object

Returns

:Ext.util.Positionable

this

anchorTo ( anchorToEl, [alignment], [offsets], [animate], [monitorScroll], [callback] ) : Ext.util.Positionable
chainable ch

Anchors an element to another element and realigns it when the window is resized.

Parameters

anchorToEl :  Ext.util.Positionable/HTMLElement/String

The Positionable, HTMLElement, or id of the element to align to.

alignment :  String (optional)

The position to align to

Defaults to: "tl-bl?"

offsets :  Number[] (optional)

Offset the positioning by [x, y]

animate :  Boolean/Object (optional)

true for the default animation or a standard Element animation config object

monitorScroll :  Boolean/Number (optional)

True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds.

Defaults to: 50

callback :  Function (optional)

The function to call after the animation finishes

Returns

:Ext.util.Positionable

this

anim ( config )
private pri

Process the passed fx configuration.

Parameters

config :  Object

animate ( config ) : Object
chainable ch

Performs custom animation on this object.

This method is applicable to both the Ext.Component class and the Ext.draw.sprite.Sprite class. It performs animated transitions of certain properties of this object over a specified timeline.

Animating a Ext.Component

When animating a Component, the following properties may be specified in from, to, and keyframe objects:

  • x - The Component's page X position in pixels.

  • y - The Component's page Y position in pixels

  • left - The Component's left value in pixels.

  • top - The Component's top value in pixels.

  • width - The Component's width value in pixels.

  • height - The Component's height value in pixels.

The following property may be set on the animation config root:

  • dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

For example, to animate a Window to a new size, ensuring that its internal layout and any shadow is correct:

myWindow = Ext.create('Ext.window.Window', {
    title: 'Test Component animation',
    width: 500,
    height: 300,
    layout: {
        type: 'hbox',
        align: 'stretch'
    },
    items: [{
        title: 'Left: 33%',
        margin: '5 0 5 5',
        flex: 1
    }, {
        title: 'Left: 66%',
        margin: '5 5 5 5',
        flex: 2
    }]
});
myWindow.show();
myWindow.header.el.on('click', function() {
    myWindow.animate({
        to: {
            width: (myWindow.getWidth() == 500) ? 700 : 500,
            height: (myWindow.getHeight() == 300) ? 400 : 300
        }
    });
});

For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

Parameters

config :  Object

Configuration for Ext.fx.Anim. Note that the to config is required.

Returns

:Object

this

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyDefaults ( config )
private pri

Parameters

config :  Object

applyRenderSelectors
private pri

Sets references to elements inside the component. This applies renderSelectors as well as childEls.

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

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyState ( state )

Applies the state to the object. This should be overridden in subclasses to do more complex state operations. By default it applies the state properties onto the current object.

Parameters

state :  Object

The state

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

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

attachChildEls ( el, owner )
private pri

Sets references to elements inside the component.

Parameters

el :  Object

owner :  Object

attachReference ( component )
private pri

Sets up a component reference.

Parameters

component :  Ext.Component

The component to reference.

beforeBlur ( e )
protected pro

Template method to do any pre-blur processing.

Parameters

e :  Ext.event.Event

The event object

beforeDestroy
deprecated dep template tpl protected pro

Invoked before the Component is destroyed. This method is deprecated, override onDestroy instead.

Deprecated since version 6.2.0
Please override onDestroy instead

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

beforeFocus ( e )
protected pro

Template method to do any pre-focus processing.

Parameters

e :  Ext.event.Event

The event object

beforeLayout
template tpl protected pro

Occurs before componentLayout is run. In previous releases, this method could return false to prevent its layout but that is not supported in Ext JS 4.1 or higher. This method is simply a notification of the impending layout to give the component a chance to adjust the DOM. Ideally, DOM reads should be avoided at this time to reduce expensive document reflows.

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

beforeRender
template tpl protected pro

Allows additional behavior before rendering.

Note: If the Component has a ViewController and the controller has a beforeRender method it will be called passing the Component as the single param.

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

beforeSetPosition ( x, y, animate )
private pri

Template method called before a Component is positioned.

Ensures that the position is adjusted so that the Component is constrained if so configured.

Parameters

x :  Object

y :  Object

animate :  Object

beforeShow
template tpl protected pro

Invoked before the Component is shown.

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

beginCollapse
private pri

Called before the change from default, configured state into the collapsed state. This method may be called at render time to enable rendering in an initially collapsed state, or at runtime when an existing, fully laid out Panel may be collapsed. It basically saves configs which need to be clobbered for the duration of the collapsed state.

blur
chainable ch private pri

Returns

:

bubble ( fn, [scope], [args] ) : Ext.Component
chainable ch

Bubbles up the component/container hierarchy, calling the specified function with each component. The scope (this) of 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.

Returns

:Ext.Component

this

cacheRefEls ( el )
private pri

Ensures that all elements with "data-ref" attributes get loaded into the cache. This really helps on IE8 where getElementById is a search not a lookup. By populating our cache with one search of the DOM we then have random access to the elements as we do our childEls wire up.

Parameters

el :  Object

calculateAnchorXY ( [anchor], [extraX], [extraY], [size] ) : Number[]
private pri

Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values.

Parameters

anchor :  String (optional)

The specified anchor position. See alignTo for details on supported anchor positions.

Defaults to: 'tl'

extraX :  Number (optional)

value to be added to the x coordinate

extraY :  Number (optional)

value to be added to the y coordinate

size :  Object (optional)

An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

:Number[]

[x, y] An array containing the element's x and y coordinates

calculateConstrainedPosition ( constrainTo, proposedPosition, local, proposedSize )
private pri

Override of Positionable method to calculate constrained position based upon possibly only constraining our header.

Parameters

constrainTo :  Object

proposedPosition :  Object

local :  Object

proposedSize :  Object

callOverridden ( args ) : Object
deprecated dep protected pro

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

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

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

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the overridden method

Deprecated since version 4.1.0
Use method-callParent instead.

callParent ( args ) : Object
protected pro

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

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

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

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

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

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

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

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

 var obj = new My.Derived();

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

This also works with static and private methods.

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

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

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

Lastly, it also works with overridden static methods.

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

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

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

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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

Consider:

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

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

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

cancelFocus
protected pro

Cancel any deferred focus on this component

cascade ( fn, [scope], [args] ) : Ext.container.Container
chainable ch

Cascades down the component/container heirarchy from this component (passed in the first call), 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 cascade is stopped on that branch.

Available since: 2.3.0

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope of the function (defaults to current component)

args :  Array (optional)

The args to call the function with. The current component always passed as the last argument.

Returns

:Ext.container.Container

this

center Ext.Component
chainable ch

Center this Component in its container.

Returns

:Ext.Component

this

changeConstraint ( newValue, oldValue, constrainMethod, styleName, sizeName )
private pri

Parameters

newValue :  Object

oldValue :  Object

constrainMethod :  Object

styleName :  Object

sizeName :  Object

child ( [selector] ) : Ext.Component

Retrieves the first direct child of this container which matches the passed selector or component. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.

Returns

:Ext.Component

The matching child Ext.Component (or null if no match was found).

clearClip
private pri

Clears any clipping applied to this component by method-clipTo.

clearDelegatedListeners
private pri

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.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

clearReference ( component )
private pri

Clear a component reference.

Parameters

component :  Ext.Component

The component to remove.

clearReferences
private pri

Invalidates the references collection. Typically called when removing a container from this container, since it's difficult to know what references got removed.

clipTo ( clippingEl, sides )
private pri

Clips this Component/Element to fit within the passed element's or component's view area

Parameters

clippingEl :  Ext.Component/Ext.dom.Element/Ext.util.Region

The Component or element or Region which should clip this element even if this element is outside the bounds of that region.

sides :  Number

The sides to clip 1=top, 2=right, 4=bottom, 8=left.

This is to support components being clipped to their logical owner, such as a grid row editor when the row being edited scrolls out of sight. The editor should be clipped at the edge of the scrolling element.

clipToScroller ( scroller )
private pri

Clips this floating element to the scrolling element in line with how its topmost anchoring element is clipped.

Parameters

scroller :  Object

cloneConfig ( overrides ) : Ext.Component

Clone the current component using the original config values passed into this instance by default.

Parameters

overrides :  Object

A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates.

Returns

:Ext.Component

clone The cloned copy of this component

close

Closes the Panel. By default, this method, removes it from the DOM, destroys the Panel object and all its descendant Components. The beforeclose event is fired before the close happens and will cancel the close action if it returns false.

Note: This method is also affected by the closeAction setting. For more explicit control use method-destroy and method-hide methods.

collapse ( [direction], [animate] ) : Ext.panel.Panel
chainable ch

Collapses the panel body so that the body becomes hidden. Docked Components parallel to the border towards which the collapse takes place will remain visible. Fires the beforecollapse event which will cancel the collapse action if it returns false.

Parameters

direction :  String (optional)

The direction to collapse towards. Must be one of

  • Ext.Component.DIRECTION_TOP
  • Ext.Component.DIRECTION_RIGHT
  • Ext.Component.DIRECTION_BOTTOM
  • Ext.Component.DIRECTION_LEFT

Defaults to collapseDirection.

animate :  Boolean/Number (optional)

True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds.

Returns

:Ext.panel.Panel

this

constrainBox ( box )
private pri

Parameters

box :  Object

constructPlugin ( plugin )
private pri

Parameters

plugin :  String/Object

string or config object containing a ptype property.

Constructs a plugin according to the passed config object/ptype string.

Ensures that the constructed plugin always has a cmp reference back to this component. The setting up of this is done in PluginManager. The PluginManager ensures that a reference to this component is passed to the constructor. It also ensures that the plugin's setCmp method (if any) is called.

constructPlugins
private pri

Returns an array of fully constructed plugin instances. This converts any configs into their appropriate instances.

It does not mutate the plugins array. It creates a new array.

constructor ( config )

Creates new Component.

Parameters

config :  Ext.dom.Element/String/Object

The configuration options may be specified as either:

  • an element : it is set as the internal element and its id used as the component id
  • a string : it is assumed to be the id of an existing element and is used as the component id
  • anything else : it is assumed to be a standard config object and is applied to the component

contains ( comp, [deep] ) : Boolean

Determines whether the passed Component is either an immediate child of this Container, or whether it is a descendant.

Parameters

comp :  Ext.Component

The Component to test.

deep :  Boolean (optional)

Pass true to test for the Component being a descendant at any level.

Defaults to: false

Returns

:Boolean

true if the passed Component is contained at the specified level.

convertCollapseDir ( collapseDir )

converts a collapsdDir into an anchor argument for Element.slideIn overridden in rtl mode to switch "l" and "r"

Parameters

collapseDir :  Object

convertPositionSpec ( posSpec )
private pri

This function converts a legacy alignment string such as 't-b' into a pair of edge, offset objects which describe the alignment points of the two regions.

So tl-br becomes {myEdge:'t', offset:0}, {otherEdge:'b', offset:100}

This not only allows more flexibility in the alignment possibilities, but it also resolves any ambiguity as to chich two edges are desired to be adjacent if an anchor pointer is required.

Parameters

posSpec :  Object

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

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

destroy

Destroys the Component. This method must not be overridden because Component destruction sequence is conditional; if a beforedestroy handler returns false we must abort destruction.

To add extra functionality to destruction time in a subclass, override the doDestroy method.

Available since: 1.1.0

disable ( silent ) :
chainable ch

Disables all child input fields and buttons.

Parameters

silent :  Object

Returns

:

doApplyRenderTpl ( out, values )
private pri

Called from the selected frame generation template to insert this Component's inner structure inside the framing structure.

When framing is used, a selected frame generation template is used as the primary template of the #getElConfig instead of the configured renderTpl. The renderTpl is invoked by this method which is injected into the framing template.

Parameters

out :  Object

values :  Object

doAutoRender
private pri

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

doComponentLayout Ext.Component
chainable ch deprecated dep

This method needs to be called whenever you change something on this component that requires the Component's layout to be recalculated.

Returns

:Ext.Component

this

Deprecated since version 4.1
Use Ext.Component#method-updateLayout instead.

doConstrain ( [constrainTo] )

Moves this floating Component into a constrain region.

By default, this Component is constrained to be within the container it was added to, or the element it was rendered to.

An alternative constraint may be passed.

Parameters

constrainTo :  String/HTMLElement/Ext.dom.Element/Ext.util.Region (optional)

The Element or Ext.util.Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered.

doDestroy
private pri

Perform the actual destruction sequence.

As a rule of thumb, subclasses should destroy their child Components 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

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

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doRemove ( component, flags )
private pri

Parameters

component :  Object

flags :  Object

down ( [selector] ) : Ext.Component

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned.

Returns

:Ext.Component

The matching descendant Ext.Component (or null if no match was found).

download ( [config] ) : Boolean

Downloads an image or PDF of the chart / drawing or opens it in a separate browser tab/window if the download can't be triggered. The exact behavior is platform and browser specific. For more consistent results on mobile devices use the preview method instead. This method doesn't work in IE8.

Important: The default download mechanism sends image data to http://svg.sencha.io, which is a server operated by Sencha. Using this default setting will generate a warning due to potential security concerns (since user data may be exposed).

You can deploy your own server by using the code from the server directory in the Charts package. The server is Node.js based and uses PhantomJS to generate images and PDFs from received data.

The warning that the default download server is used can be suppressed by explicitly providing the url option.

Parameters

config :  Object (optional)

The following config options are supported:

url :  String (optional)

The url to post the data to. Defaults to the defaultDownloadServerUrl configuration on the class which will result in a warning as discussed above. Passing any value explicitly disables this warning.

format :  String

The format of image to export. See the supportedFormats. Defaults to 'png' on the Sencha IO server. Note that you can't export to 'svg' format if the Ext.draw.engine.Canvas engine is used.

width :  Number

A width to send to the server for configuring the image width. Defaults to natural image width on the Sencha IO server.

height :  Number

A height to send to the server for configuring the image height. Defaults to natural image height on the Sencha IO server.

filename :  String

The filename of the downloaded image. Defaults to 'chart' on the Sencha IO server. The config.format is used as a filename extension.

scale :  Number

The scaling of the downloaded image. Defaults to 1 on the Sencha IO server. The server will try to determine the natural size of the image unless the width/height configs have been set. If the Ext.draw.engine.Canvas engine is used the natural image size will depend on the value of the window.devicePixelRatio. For example, for devices with devicePixelRatio of 2 the produced image will be two times larger than for devices with devicePixelRatio of 1 for the same drawing. This is done so that the users with devices with HiDPI screens get a downloaded image that looks as crisp on their device as the original drawing. If you want image size to be consistent across devices with different device pixel ratios, you can set the value of this config to 1/devicePixelRatio. This parameter is ignored by the Sencha IO server if config.format is set to 'svg'.

pdf :  Object

PDF specific options. This config is only used if config.format is set to 'pdf'. The given object should be in either this format:

{
  width: '200px',
  height: '300px',
  border: '0px'
}

or this format:

{
  format: 'A4',
  orientation: 'portrait',
  border: '1cm'
}

Supported dimension units are: 'mm', 'cm', 'in', 'px'. No unit means 'px'. Supported formats are: 'A3', 'A4', 'A5', 'Legal', 'Letter', 'Tabloid'. Orientation ('portrait', 'landscape') is optional and defaults to 'portrait'.

jpeg :  Object

JPEG specific options. This config is only used if config.format is set to 'jpeg'. The given object should be in this format:

{
  quality: 80
}

Where quality is an integer between 0 and 100.

Returns

:Boolean

True if request was successfully sent to the server.

enable ( silent ) :
chainable ch

Enables all child input fields and buttons.

Parameters

silent :  Object

Returns

:

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.

ensureAttachedToBody ( [runLayout] )

Ensures that this component is attached to document.body. If the component was rendered to Ext#getDetachedBody, then it will be appended to document.body. Any configured position is also restored.

Parameters

runLayout :  Boolean (optional)

True to run the component's layout.

Defaults to: false

expand ( [animate] ) : Ext.panel.Panel
chainable ch

Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the expand action if it returns false.

Parameters

animate :  Boolean (optional)

True to animate the transition, else false (defaults to the value of the animCollapse panel config). May also be specified as the animation duration in milliseconds.

Returns

:Ext.panel.Panel

this

findFocusTarget Ext.Component
private pri

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.

findParentBy ( fn ) : Ext.container.Container

Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned.

See also the up method.

Parameters

fn :  Function

The custom function to call with the arguments (container, this component).

Returns

:Ext.container.Container

The first Container for which the custom function returns true

findParentByType ( xtype ) : Ext.container.Container

Find a container above this component at any level by xtype or class

See also the up method.

Parameters

xtype :  String/Ext.Class

The xtype string for a component, or the class of the component directly

Returns

:Ext.container.Container

The first Container which matches the given xtype or class

findPlugin ( ptype ) : Ext.plugin.Abstract

Retrieves plugin from this component's collection by its ptype.

var grid = Ext.create('Ext.grid.Panel', {
    store: {
        fields: ['name'],
        data: [{
            name: 'Scott Pilgrim'
        }]
    },
    columns: [{
        header: 'Name',
        dataIndex: 'name',
        editor: 'textfield',
        flex: 1
    }],
    selType: 'cellmodel',
    plugins: {
        ptype: 'cellediting',
        clicksToEdit: 1,
        id: 'myplugin'
    },
    height: 200,
    width: 400,
    renderTo: Ext.getBody()
});

grid.findPlugin('cellediting');  // the cellediting plugin

Note: See also getPlugin

Parameters

ptype :  String

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

Returns

:Ext.plugin.Abstract

plugin instance or undefined if not found

finishRender ( containerIdx )
private pri

This method visits the rendered component tree in a "top-down" order. That is, this code runs on a parent component before running on a child. This method calls the onRender method of each component.

Parameters

containerIdx :  Number

The index into the Container items of this Component.

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

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.

fireEvent ( eventName, args ) : Boolean

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

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

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

fireHierarchyEvent ( eventName )
private pri

This method fires an event on Ext.GlobalEvents allowing interested parties to know of certain critical events for this component. This is done globally because the (few) listeners can immediately receive the event rather than bubbling the event only to reach the top and have no listeners.

The main usage for these events is to do with floating components. For example, the load mask is a floating component. The component it is masking may be inside several containers. As such, they need to know when component is hidden, either directly, or via a parent container being hidden. To do this they subscribe to these events and filter out the appropriate container.

This functionality is contained in Component (as opposed to Container) because a Component can be the ownerCt for a floating component (loadmask), and the loadmask needs to know when its owner is shown/hidden so that its hidden state can be synchronized.

Available since: 4.2.0

Parameters

eventName :  String

The event name.

fitContainer ( animate )
private pri

Parameters

animate :  Object

fixReference
private pri

Sets up a reference on our current reference holder.

focus ( [selectText], [delay], [callback], [scope] ) : Ext.Component
chainable ch

Try to focus this component.

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

Parameters

selectText :  Mixed (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.

delay :  Boolean/Number (optional)

Delay the focus this number of milliseconds (true for 10 milliseconds).

callback :  Function (optional)

Only needed if the delay parameter is used. A function to call upon focus.

scope :  Function (optional)

Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback.

Returns

:Ext.Component

The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Ext.window.Windows can do this through their defaultFocus config option. If this component is disabled, a closely related component will be focused and that will be returned.

forceComponentLayout ( [options] )
deprecated dep

Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

Parameters

options :  Object (optional)

An object with layout options.

defer :  Boolean

true if this layout should be deferred.

isRoot :  Boolean

true if this layout should be the root of the layout.

Deprecated since version 4.1
Use Ext.Component#method-updateLayout instead.

getAction ( name )

Retrieves the named Ext.Action from this view or any ancestor which has that named Action. See actions

Parameters

name :  Object

getActiveAnimation Ext.fx.Anim/Boolean

Returns the current animation if this object has any effects actively running or queued, else returns false.

Returns

:Ext.fx.Anim/Boolean

Anim if element has active effects, else false

getAlignToXY ( alignToEl, [position], [offsets] ) : Number[]

Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported position values.

Parameters

alignToEl :  Ext.util.Positionable/HTMLElement/String

The Positionable, HTMLElement, or id of the element to align to.

position :  String (optional)

The position to align to

Defaults to: "tl-bl?"

offsets :  Number[] (optional)

Offset the positioning by [x, y]

Returns

:Number[]

[x, y]

getAnchorToXY ( el, [anchor], [local], [size] ) : Number[]
private pri

Gets the x,y coordinates of an element specified by the anchor position on the element.

Parameters

el :  Ext.dom.Element

The element

anchor :  String (optional)

The specified anchor position. See alignTo for details on supported anchor positions.

Defaults to: 'tl'

local :  Boolean (optional)

True to get the local (element top/left-relative) anchor position instead of page coordinates

size :  Object (optional)

An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

:Number[]

[x, y] An array containing the element's x and y coordinates

getAnchorXY ( [anchor], [local], [size] ) : Number[]

Gets the x,y coordinates specified by the anchor position on the element.

Parameters

anchor :  String (optional)

The specified anchor position. See alignTo for details on supported anchor positions.

Defaults to: 'tl'

local :  Boolean (optional)

True to get the local (element top/left-relative) anchor position instead of page coordinates

size :  Object (optional)

An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

Returns

:Number[]

[x, y] An array containing the element's x and y coordinates

getAnimationProps
private pri

Get animation properties

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

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

getBorderPadding Object
private pri

Returns the size of the element's borders and padding.

Returns

:Object

an object with the following numeric properties

  • beforeX
  • afterX
  • beforeY
  • afterY

getBox ( [contentBox], [local] ) : Object

Return an object defining the area of this Element which can be passed to setBox to set another Element's size/location to match this element.

Parameters

contentBox :  Boolean (optional)

If true a box for the content of the element is returned.

local :  Boolean (optional)

If true the element's left and top relative to its offsetParent are returned instead of page x/y.

Returns

:Object

An object in the format

x :  Number

The element's X position.

y :  Number

The element's Y position.

width :  Number

The element's width.

height :  Number

The element's height.

bottom :  Number

The element's lower bound.

right :  Number

The element's rightmost bound.

The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable

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

getBubbleTarget
protected pro

Implements an upward event bubbling policy. By default a Component bubbles events up to its reference owner.

Component subclasses may implement a different bubbling strategy by overriding this method.

getChildByElement ( el, deep ) : Ext.Component

Return the immediate child Component in which the passed element is located.

Parameters

el :  Ext.dom.Element/HTMLElement/String

The element to test (or ID of element).

deep :  Boolean

If true, returns the deepest descendant Component which contains the passed element.

Returns

:Ext.Component

The child item which contains the passed element.

getChildItemsToDisable Ext.Component[]
private pri

Gets a list of child components to enable/disable when the container is enabled/disabled

Returns

:Ext.Component[]

Items to be enabled/disabled

getClientRegion Ext.util.Region

Returns a region object that defines the client area of this element.

That is, the area within any scrollbars.

Returns

:Ext.util.Region

A Region containing "top, left, bottom, right" properties.

getComponent ( comp ) : Ext.Component

Attempts a default component lookup (see Ext.container.Container#getComponent). If the component is not found in the normal items, the dockedItems are searched and the matched component (if any) returned (see getDockedComponent). Note that docked items will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.

Available since: 2.3.0

Parameters

comp :  String/Number

The component id, itemId or position to find

Returns

:Ext.Component

The component (if found)

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

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

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

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

Defaults to: false

Returns

:Object

The config property value.

getConstrainRegion Ext.util.Region

Returns the content region of this element for purposes of constraining or clipping floating children. That is the region within the borders and scrollbars, but not within the padding.

Returns

:Ext.util.Region

A Region containing "top, left, bottom, right" properties.

getConstrainVector ( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean

Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain within the passed constraint. Returns false if the element does not need to be moved.

Priority is given to constraining the top and left within the constraint.

The constraint may either be an existing element into which the element is to be constrained, or a Ext.util.Region into which this element is to be constrained.

By default, any extra shadow around the element is not included in the constrain calculations - the edges of the element are used as the element bounds. To constrain the shadow within the constrain region, set the constrainShadow property on this element to true.

Parameters

constrainTo :  Ext.util.Positionable/HTMLElement/String/Ext.util.Region (optional)

The Positionable, HTMLElement, element id, or Region into which the element is to be constrained.

proposedPosition :  Number[] (optional)

A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position

proposedSize :  Number[] (optional)

A proposed [width, height] size to constrain instead of using the element's current size

Returns

:Number[]/Boolean

If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false.

getDockedComponent ( comp ) : Ext.Component

Finds a docked component by id, itemId or position. Also see getDockedItems

Parameters

comp :  String/Number

The id, itemId or position of the docked component (see getComponent for details)

Returns

:Ext.Component

The docked component (if found)

getEl Ext.dom.Element

Retrieves the top level element representing this component.

Available since: 1.1.0

Returns

:Ext.dom.Element

getFocusClsEl Ext.dom.Element
protected pro

Returns the focus styling holder element associated with this Focusable. By default it is the same element as getFocusEl.

Returns

:Ext.dom.Element

The focus styling element.

getFocusEl Ext.dom.Element
protected pro

Returns the focus holder element associated with this Container. By default, this is the Container's target element; however if defaultFocus is defined, the child component referenced by that property will be found and returned instead.

Returns

:Ext.dom.Element

the focus holding element.

getFrameInfo Boolean
private pri

On render, reads an encoded style attribute, "filter" from the style of this Component's element. This information is memoized based upon the CSS class name of this Component's element. Because child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted into the document to receive the document element's CSS class name, and therefore style attributes.

Returns

:Boolean

getFrameTpl ( table )
private pri

Parameters

table :  Object

getHeaderCollapsedClasses ( header )
private pri

Create the class array to add to the Header when collapsed.

Parameters

header :  Object

getImage ( [format] ) : Object

Produces an image of the chart / drawing.

Parameters

format :  String (optional)

Possible options are 'image' (the method will return an Image object) and 'stream' (the method will return the image as a byte stream). If missing, the data URI of the drawing's (or chart's) image will be returned. Note: for an SVG based drawing/chart in IE/Edge browsers the method will always return SVG markup instead of a data URI, as 'img' elements won't accept a data URI anyway in those browsers.

Returns

:Object

data :  String

Image element, byte stream or DataURL.

type :  String

The type of the data (e.g. 'png' or 'svg').

getInherited ( [inner] ) : Object

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

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

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.

getInsertPosition ( position ) : HTMLElement

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insertBefore.

Parameters

position :  String/Number/Ext.dom.Element/HTMLElement

Index, element id or element you want to put this component before.

Returns

:HTMLElement

DOM element that you can use in the insertBefore

getLocalX Number

Returns the x coordinate of this element reletive to its offsetParent.

Returns

:Number

The local x coordinate

getLocalXY Number[]

Returns the x and y coordinates of this element relative to its offsetParent.

Returns

:Number[]

The local XY position of the element

getLocalY Number

Returns the y coordinate of this element reletive to its offsetParent.

Returns

:Number

The local y coordinate

getMaskTarget
protected pro

Returns the element which is masked by the mask method, or into which the LoadMask is rendered into.

The default implementation uses the maskElement configuration to access the Component's child element by name. By default, maskElement is null which means that null is returned from this method indicating that the mask needs to be rendered into the document because component structure should not be contaminated by mask elements.

Some subclasses may override this method if they have knowledge about external structures where a mask could usefully be rendered.

For example a Ext.view.Table will request that its owning Ext.panel.Table be masked. The GridPanel will have its own implementation of getMaskTarget which will return the element dictated by its own maskElement Panels use "el" as their maskElement by default, but that could be overridden to be "body" to leave toolbars and the header mouse-accessible.

getMemento ( name )
private pri

Memento Factory method

Parameters

name :  String

Name of the Memento (used as prefix for named Memento)

getOffsetsTo ( offsetsTo ) : Number[]

Returns the offsets of this element from the passed element. The element must both be part of the DOM tree and not have display:none to have page coordinates.

Parameters

offsetsTo :  Ext.util.Positionable/HTMLElement/String

The Positionable, HTMLElement, or element id to get get the offsets from.

Returns

:Number[]

The XY page offsets (e.g. [100, -200])

getOverflowEl
private pri

Get an el for overflowing, defaults to the target el

getOverflowStyle
private pri

Returns the CSS style object which will set the Component's scroll styles. This must be applied to the target element.

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin from this component's collection by its id.

var grid = Ext.create('Ext.grid.Panel', {
    store: {
        fields: ['name'],
        data: [{
            name: 'Scott Pilgrim'
        }]
    },
    columns: [{
        header: 'Name',
        dataIndex: 'name',
        editor: 'textfield',
        flex: 1
    }],
    selType: 'cellmodel',
    plugins: {
        ptype: 'cellediting',
        clicksToEdit: 1,
        id: 'myplugin'
    },
    height: 200,
    width: 400,
    renderTo: Ext.getBody()
});

grid.getPlugin('myplugin');  // the cellediting plugin

Note: See also findPlugin. Prior to 6.2.0 the plugin had to have a pluginId property but this can now be just id. Both are supported (so plugins with a matching pluginId are still found) but id is preferred.

Parameters

id :  String

The id set on the plugin config object.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found

getPosition ( [local] ) : Number[]

Gets the current XY position of the component's underlying element.

Parameters

local :  Boolean (optional)

If true the element's left and top are returned instead of page XY.

Defaults to: false

Returns

:Number[]

The XY position of the element (e.g., [100, 200])

getRefItems ( deep )
protected pro

Used by Ext.ComponentQuery, child and down to retrieve all of the items which can potentially be considered a child of this Container.

This may be overriden by Components which have ownership of Components that are not contained in the property-items collection.

NOTE: IMPORTANT note for maintainers: Items are returned in tree traversal order. Each item is appended to the result array followed by the results of that child's getRefItems call. Floating child items are appended after internal child items.

Parameters

deep :  Object

getRefOwner
protected pro

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.

getReferences Object

Returns an object holding the descendants of this view keyed by their reference. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with reference values of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var refs = this.getReferences();

     // using "refs" we can access any descendant by its "reference"

     refs.foo.getValue() + refs.bar.getValue() + refs.baz.getValue();
 }

If this component has a reference assigned to it, that is not included in this object. That reference is understood to belong to the ancestor container configured as the referenceHolder.

Available since: 5.0.0

Returns

:Object

An object with each child reference. This will be null if this container has no descendants with a reference specified.

getScrollX Number

Returns the "x" scroll position for this component. Only applicable for scrollable components

Returns

:Number

getScrollY Number

Returns the "y" scroll position for this component. Only applicable for scrollable components

Returns

:Number

getSize ( [contentSize] ) : Object

Gets the current size of the component's underlying element.

Parameters

contentSize :  Boolean (optional)

true to get the width/size minus borders and padding

Returns

:Object

An object containing the element's size:

width :  Number

height :  Number

getSizeModel ( ownerCtSizeModel ) : Object
protected pro

Returns an object that describes how this component's width and height are managed. All of these objects are shared and should not be modified.

Parameters

ownerCtSizeModel :  Object

Returns

:Object

The size model for this component.

width :  Ext.layout.SizeModel

The Ext.layout.SizeModel for the width.

height :  Ext.layout.SizeModel

The Ext.layout.SizeModel for the height.

getState Object

The supplied default state gathering method for the Component class.

This method returns dimension settings such as flex, anchor, width and height along with collapsed state.

Subclasses which implement more complex state should call the superclass's implementation, and apply their state to the result if this basic state is to be saved.

Note that Component state will only be saved if the Component has a stateId and there as a StateProvider configured for the document.

Returns

:Object

getStyleProxy ( cls )
private pri

Returns an offscreen div with the same class name as the element this is being rendered. This is because child item rendering takes place in a detached div which, being not part of the document, has no styling.

Parameters

cls :  Object

getSurface ( [id] ) : Ext.draw.Surface

Get a surface by the given id or create one if it doesn't exist. This will automatically call the resizeHandler. Which means that, if no custom resize handler has been provided, the surface will be sized to match the container. If the add method is used, it is the responsibility of the user to call the handleResize method, to update the size of all added surfaces.

Parameters

id :  String (optional)

Defaults to: "main"

Returns

:Ext.draw.Surface

getTargetEl
private pri

This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

getTdCls
private pri

Needed for when widget is rendered into a grid cell. The class to add to the cell element.

getTdType
private pri

Partner method to getTdCls.

Returns the base type for the component. Defaults to return this.xtype, but All derived classes of Ext.form.field.Text can return the type 'textfield', and all derived classes of Ext.button.Button can return the type 'button'

getTopAlignTarget Ext.dom.Element/Ext.Component
private pri

Gets the topmost non floating alignTo target if there are multiple aligns such as a menu stack hanging off a button or grid column header.

Returns

:Ext.dom.Element/Ext.Component

The topmost, non floating alignTo target.

getViewRegion Ext.util.Region

Returns the content region of this element. That is the region within the borders and padding.

Returns

:Ext.util.Region

A Region containing "top, left, bottom, right" member data.

getX Number

Gets the current X position of the DOM element based on page coordinates.

Returns

:Number

The X position of the element

getXType String

Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all available xtypes, see the Ext.Component header. Example usage:

var t = new Ext.form.field.Text();
alert(t.getXType());  // alerts 'textfield'

Returns

:String

The xtype

getXTypes String

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.

If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

Example usage:

Available since: 2.3.0

Returns

:String

The xtype hierarchy string