Interface IDataItem

Hierarchy

Index

Properties

Methods

Properties

optional public activeItem?: any

[Config Option] (Object/String/Number)

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public autoDestroy?: boolean

[Config Option] (Boolean)

optional public baseCls?: string

[Config Option] (String)

optional public border?: any

[Config Option] (Number/String)

optional public bottom?: any

[Config Option] (Number/String)

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public cardSwitchAnimation?: any

[Config Option] (String/Object/Boolean)

optional public centered?: boolean

[Config Option] (Boolean)

optional public cls?: any

[Config Option] (String/String[])

optional public componentCls?: string

[Config Option] (String)

optional public config?: any

[Config Option] (Object)

optional public contentEl?: any

[Config Option] (Ext.Element/HTMLElement/String)

optional public control?: any

[Config Option] (Object)

optional public data?: any

[Config Option] (Object)

optional public dataMap?: any

[Config Option] (Object)

optional public defaultType?: string

[Config Option] (String)

optional public defaults?: any

[Config Option] (Object)

optional public disabled?: boolean

[Config Option] (Boolean)

optional public disabledCls?: string

[Config Option] (String)

optional public dock?: string

[Config Option] (String)

optional public docked?: string

[Config Option] (String)

optional public enterAnimation?: any

[Config Option] (String/Mixed)

optional public exitAnimation?: any

[Config Option] (String/Mixed)

optional public extend?: string

[Config Option] (String)

optional public flex?: number

[Config Option] (Number)

optional public floating?: boolean

[Config Option] (Boolean)

optional public floatingCls?: string

[Config Option] (String)

optional public fullscreen?: boolean

[Config Option] (Boolean)

optional public height?: any

[Config Option] (Number/String)

optional public hidden?: boolean

[Config Option] (Boolean)

optional public hiddenCls?: string

[Config Option] (String)

optional public hideAnimation?: any

[Config Option] (String/Mixed)

optional public hideOnMaskTap?: boolean

[Config Option] (Boolean)

optional public html?: any

[Config Option] (String/Ext.Element/HTMLElement)

optional public id?: string

[Config Option] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public itemCls?: string

[Config Option] (String)

optional public itemId?: string

[Config Option] (String)

optional public items?: any

[Config Option] (Array/Object)

optional public layout?: any

[Config Option] (Object/String)

optional public layoutOnOrientationChange?: boolean

[Config Option] (Boolean)

optional public left?: any

[Config Option] (Number/String)

optional public listeners?: any

[Config Option] (Object)

optional public margin?: any

[Config Option] (Number/String)

optional public masked?: any

[Config Option] (Boolean/Object/Ext.Mask/Ext.LoadMask)

optional public maxHeight?: any

[Config Option] (Number/String)

optional public maxWidth?: any

[Config Option] (Number/String)

optional public minHeight?: any

[Config Option] (Number/String)

optional public minWidth?: any

[Config Option] (Number/String)

optional public mixins?: any

[Config Option] (Object)

optional public modal?: boolean

[Config Option] (Boolean)

optional public monitorOrientation?: boolean

[Config Option] (Boolean)

optional public padding?: any

[Config Option] (Number/String)

optional public platformConfig?: any

[Config Option] (Object)

optional public plugins?: any

[Config Option] (Object/Array)

optional public record?: IModel

[Config Option] (Ext.data.Model)

optional public renderTo?: IElement

[Config Option] (Ext.Element)

optional public right?: any

[Config Option] (Number/String)

optional public scroll?: any

[Config Option] (Boolean/String/Object)

optional public scrollable?: any

[Config Option] (Boolean/String/Object)

optional public self?: IClass

[Property] (Ext.Class)

optional public showAnimation?: any

[Config Option] (String/Mixed)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public stopMaskTapEvent?: boolean

[Config Option] (Boolean)

optional public style?: any

[Config Option] (String/Object)

optional public styleHtmlCls?: string

[Config Option] (String)

optional public styleHtmlContent?: boolean

[Config Option] (Boolean)

optional public top?: any

[Config Option] (Number/String)

optional public tpl?: any

[Config Option] (String/String[]/Ext.Template/Ext.XTemplate[])

optional public tplWriteMode?: string

[Config Option] (String)

optional public ui?: string

[Config Option] (String)

optional public uses?: Array<string>

[Config Option] (String[])

optional public width?: any

[Config Option] (Number/String)

optional public xtype?: string

[Config Option] (String[])

optional public zIndex?: number

[Config Option] (Number)

Methods

optional public add(newItems?: any): IComponent

[Method] Adds one or more Components to this Container

Parameters

  • newItems?: any optional

    Object/Object[]/Ext.Component/Ext.Component[] The new items to add to the Container.

Returns

IComponent

Ext.Component The last item added to the Container from the newItems array.

optional public addAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends an after event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addAll(items?: Array<any>): Array<any>

[Method] Adds an array of Components to this Container

Parameters

  • items?: Array<any> optional

    Array The array of items to add to this container.

Returns

Array<any>

Array The array of items after they have been added.

optional public addBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addCls(cls?: string, prefix?: string, suffix?: string)

[Method] Adds a CSS class or classes to this Component s rendered element

Parameters

  • cls?: string optional

    String The CSS class to add.

  • prefix?: string optional

    String Optional prefix to add to each class.

  • suffix?: string optional

    String Optional suffix to add to each class.

optional public addEvents(eventNames?: any)

[Method] Adds the specified events to the list of events which this Observable may fire

Parameters

  • eventNames?: any optional

    Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

optional public addListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Appends an event handler to this object

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

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

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public addManagedListener(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

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

optional public animateActiveItem(activeItem?: any, animation?: any)

[Method] Animates to the supplied activeItem with a specified animation

Parameters

  • activeItem?: any optional

    Object/Number The item or item index to make active.

  • animation?: any optional

    Object/Ext.fx.layout.Card Card animation configuration or instance.

optional public applyMasked(masked?: any): any

[Method] Changes the masked configuration when its setter is called which will convert the value into a proper object instanc

Parameters

  • masked?: any optional

    Boolean/Object/Ext.Mask/Ext.LoadMask

Returns

any

Object

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the superclass method

optional public child(selector?: string): IComponent

[Method] Retrieves the first direct child of this container which matches the passed selector

Parameters

  • selector?: string optional

    String An Ext.ComponentQuery selector.

Returns

IComponent

Ext.Component

optional public clearListeners()

[Method] Removes all listeners for this object

optional public destroy()

[Method]

optional public disable()

[Method] Disables this Component

optional public down(selector?: string): IComponent

[Method] Retrieves the first descendant of this container which matches the passed selector

Parameters

  • selector?: string optional

    String An Ext.ComponentQuery selector.

Returns

IComponent

Ext.Component

optional public enable()

[Method] Enables this Component

optional public enableBubble(events?: any)

[Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present

Parameters

  • events?: any optional

    String/String[] The event name to bubble, or an Array of event names.

optional public fireAction(eventName?: string, args?: Array<any>, fn?: any, scope?: any): any

[Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste

Parameters

  • eventName?: string optional

    String The name of the event to fire.

  • args?: Array<any> optional

    Array Arguments to pass to handers.

  • fn?: any optional

    Function Action.

  • scope?: any optional

    Object Scope of fn.

Returns

any

Object

optional public fireEvent(eventName: string, args?: Array<any>): boolean

[Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList

Parameters

  • eventName: string

    String The name of the event to fire.

  • args?: Array<any> optional

    Object... Variable number of parameters are passed to handlers.

Returns

boolean

Boolean Returns false if any of the handlers return false.

optional public getActiveItem(): any

[Method] Returns the value of activeItem

Returns

any

Object/String/Number

optional public getAlignmentInfo(component?: any, alignment?: any)

[Method] Prepares information on aligning this to component using alignment

Parameters

  • component?: any optional

    Object

  • alignment?: any optional

    Object

optional public getAt(index?: number): IComponent

[Method] Returns the Component for a given index in the Container s items

Parameters

  • index?: number optional

    Number The index of the Component to return.

Returns

IComponent

Ext.Component The item at the specified index, if found.

optional public getAutoDestroy(): boolean

[Method] Returns the value of autoDestroy

Returns

boolean

Boolean

optional public getBaseCls(): string

[Method] Returns the value of baseCls

Returns

string

String

optional public getBorder(): any

[Method] Returns the value of border

Returns

any

Number/String

optional public getBottom(): any

[Method] Returns the value of bottom

Returns

any

any

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getCentered(): boolean

[Method] Returns the value of centered

Returns

boolean

Boolean

optional public getCls(): any

[Method] Returns the value of cls

Returns

any

any

optional public getComponent(component?: any): IComponent

[Method] Examines this container s items property and gets a direct child component of this container

Parameters

  • component?: any optional

    String/Number This parameter may be any of the following: {String} : representing the itemId or id of the child component. {Number} : representing the position of the child component within the items property. For additional information see Ext.util.MixedCollection.get.

Returns

IComponent

Ext.Component The component (if found).

optional public getContentEl(): any

[Method] Returns the value of contentEl

Returns

any

Ext.Element/HTMLElement/String

optional public getControl(): any

[Method] Returns the value of control

Returns

any

Object

optional public getData(): any

[Method] Returns the value of data

Returns

any

Object

optional public getDataMap(): any

[Method] Returns the value of dataMap

Returns

any

Object

optional public getDefaultType(): string

[Method] Returns the value of defaultType

Returns

string

String

optional public getDefaults(): any

[Method] Returns the value of defaults

Returns

any

Object

optional public getDisabled(): boolean

[Method] Returns the value of disabled

Returns

boolean

Boolean

optional public getDisabledCls(): string

[Method] Returns the value of disabledCls

Returns

string

String

optional public getDocked(): string

[Method] Returns the value of docked

Returns

string

String

optional public getDockedComponent(component?: any): any

[Method] Finds a docked item of this container using a reference idor an index of its location in getDockedItems

Parameters

  • component?: any optional

    String/Number The id or index of the component to find.

Returns

any

Ext.Component/Boolean The docked component, if found.

optional public getDockedItems(): Array<any>

[Method] Returns all the Ext Component docked items in this container

Returns

Array<any>

Array The docked items of this container.

optional public getEl(): IElement

[Method] Retrieves the top level element representing this component

Returns

IElement

Ext.dom.Element

optional public getEnterAnimation(): any

[Method] Returns the value of enterAnimation

Returns

any

String/Mixed

optional public getExitAnimation(): any

[Method] Returns the value of exitAnimation

Returns

any

String/Mixed

optional public getFlex(): number

[Method] Returns the value of flex

Returns

number

Number

optional public getFloatingCls(): string

[Method] Returns the value of floatingCls

Returns

string

String

optional public getHeight(): any

[Method] Returns the value of height

Returns

any

Number/String

optional public getHidden(): boolean

[Method] Returns the value of hidden

Returns

boolean

Boolean

optional public getHiddenCls(): string

[Method] Returns the value of hiddenCls

Returns

string

String

optional public getHideAnimation(): any

[Method] Returns the value of hideAnimation

Returns

any

String/Mixed

optional public getHideOnMaskTap(): boolean

[Method] Returns the value of hideOnMaskTap

Returns

boolean

Boolean

optional public getHtml(): any

[Method] Returns the value of html

Returns

any

String/Ext.Element/HTMLElement

optional public getId(): any

[Method] Retrieves the id of this component

Returns

any

any id

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInnerItems(): Array<any>

[Method] Returns all inner items of this container

Returns

Array<any>

Array The inner items of this container.

optional public getItemCls(): string

[Method] Returns the value of itemCls

Returns

string

String

optional public getItemId(): string

[Method] Returns the value of itemId

Returns

string

String

optional public getItems(): Array<any>

[Method] Returns the value of items

Returns

Array<any>

Array

optional public getLeft(): any

[Method] Returns the value of left

Returns

any

Number/String

optional public getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getMargin(): any

[Method] Returns the value of margin

Returns

any

Number/String

optional public getMasked(): any

[Method] Returns the value of masked

Returns

any

Boolean/Object/Ext.Mask/Ext.LoadMask

optional public getMaxHeight(): any

[Method] Returns the value of maxHeight

Returns

any

Number/String

optional public getMaxWidth(): any

[Method] Returns the value of maxWidth

Returns

any

Number/String

optional public getMinHeight(): any

[Method] Returns the value of minHeight

Returns

any

Number/String

optional public getMinWidth(): any

[Method] Returns the value of minWidth

Returns

any

Number/String

optional public getModal(): boolean

[Method] Returns the value of modal

Returns

boolean

Boolean

optional public getPadding(): any

[Method] Returns the value of padding

Returns

any

Number/String

optional public getParent(): IComponent

[Method] Returns the parent of this component if it has one

Returns

IComponent

Ext.Component The parent of this component.

optional public getPlugins(): any

[Method] Returns the value of plugins

Returns

any

Object/Array

optional public getRecord(): IModel

[Method] Returns the value of record

Returns

IModel

Ext.data.Model

optional public getRenderTo(): IElement

[Method] Returns the value of renderTo

Returns

IElement

Ext.Element

optional public getRight(): any

[Method] Returns the value of right

Returns

any

Number/String

optional public getScrollable(): IView

[Method] Returns an the scrollable instance for this container which is a Ext scroll View class

Returns

IView

Ext.scroll.View The scroll view.

optional public getShowAnimation(): any

[Method] Returns the value of showAnimation

Returns

any

String/Mixed

optional public getSize(): any

[Method] Returns the height and width of the Component

Returns

any

Object The current height and width of the Component.

optional public getStyle(): any

[Method] Returns the value of style

Returns

any

String/Object

optional public getStyleHtmlCls(): string

[Method] Returns the value of styleHtmlCls

Returns

string

String

optional public getStyleHtmlContent(): boolean

[Method] Returns the value of styleHtmlContent

Returns

boolean

Boolean

optional public getTop(): any

[Method] Returns the value of top

Returns

any

Number/String

optional public getTpl(): any

[Method] Returns the value of tpl

Returns

any

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

optional public getTplWriteMode(): string

[Method] Returns the value of tplWriteMode

Returns

string

String

optional public getUi(): string

[Method] Returns the value of ui

Returns

string

String

optional public getWidth(): any

[Method] Returns the value of width

Returns

any

Number/String

optional public getXTypes(): string

[Method] Returns this Component s xtype hierarchy as a slash delimited string

Returns

string

String The xtype hierarchy string.

optional public getZIndex(): number

[Method] Returns the value of zIndex

Returns

number

Number

optional public hasListener(eventName?: string): boolean

[Method] Checks to see if this object has any listeners for a specified event

Parameters

  • eventName?: string optional

    String The name of the event to check for

Returns

boolean

Boolean True if the event is being listened for, else false

optional public hasParent(): boolean

[Method] Returns true if this component has a parent

Returns

boolean

Boolean true if this component has a parent.

optional public hide(): IComponent

[Method] Hides this Component optionally using an animation

Returns

IComponent

Ext.Component

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initialize()

[Method] Allows addition of behavior to the rendering phase

optional public insert(index?: number, item?: any)

[Method] Adds a child Component at the given index

Parameters

  • index?: number optional

    Number The index to insert the Component at.

  • item?: any optional

    Object The Component to insert.

optional public isDisabled(): boolean

[Method] Returns true if this Component is currently disabled

Returns

boolean

Boolean true if currently disabled.

optional public isHidden(): boolean

[Method] Returns true if this Component is currently hidden

Returns

boolean

Boolean true if currently hidden.

optional public isXType(xtype?: string, shallow?: boolean): boolean

[Method] Tests whether or not this Component is of a specific xtype

Parameters

  • xtype?: string optional

    String The xtype to check for this Component.

  • shallow?: boolean optional

    Boolean false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

Returns

boolean

Boolean true if this component descends from the specified xtype, false otherwise.

optional public mask(mask?: any)

[Method] Convenience method which calls setMasked with a value of true to show the mask

Parameters

  • mask?: any optional

    Object

optional public mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

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

optional public mun(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Alias for removeManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public on(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for addListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

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

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public onAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public onBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public query(selector?: string): Array<any>

[Method] Retrieves all descendant components which match the passed selector

Parameters

  • selector?: string optional

    String Selector complying to an Ext.ComponentQuery selector.

Returns

Array<any>

Array Ext.Component's which matched the selector.

optional public relayEvents(object?: any, events?: any): IObservable

[Method] Relays selected events from the specified Observable as if the events were fired by this

Parameters

  • object?: any optional

    Object The Observable whose events this object is to relay.

  • events?: any optional

    String/Array/Object Array of event names to relay.

Returns

IObservable

Ext.mixin.Observable this

optional public remove(item?: any, destroy?: boolean): IComponent

[Method] Removes an item from this Container optionally destroying it

Parameters

  • item?: any optional

    Object The item to remove.

  • destroy?: boolean optional

    Boolean Calls the Component's destroy method if true.

Returns

IComponent

Ext.Component this

optional public removeAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeAll(destroy?: boolean, everything?: boolean): IComponent

[Method] Removes all items currently in the Container optionally destroying them all

Parameters

  • destroy?: boolean optional

    Boolean If true, destroys each removed Component.

  • everything?: boolean optional

    Boolean If true, completely remove all items including docked / centered and floating items.

Returns

IComponent

Ext.Component this

optional public removeAt(index?: number): IContainer

[Method] Removes the Component at the specified index myContainer removeAt 0 removes the first item

Parameters

  • index?: number optional

    Number The index of the Component to remove.

Returns

IContainer

Ext.Container this

optional public removeBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeCls(cls?: string, prefix?: string, suffix?: string)

[Method] Removes the given CSS class es from this Component s rendered element

Parameters

  • cls?: string optional

    String The class(es) to remove.

  • prefix?: string optional

    String Optional prefix to prepend before each class.

  • suffix?: string optional

    String Optional suffix to append to each class.

optional public removeDocked(item?: any, destroy?: boolean): IComponent

[Method] Removes a docked item from this Container

Parameters

  • item?: any optional

    Object The item to remove.

  • destroy?: boolean optional

    Boolean Calls the Component's destroy method if true.

Returns

IComponent

Ext.Component this

optional public removeInnerAt(index?: number): IContainer

[Method] Removes an inner Component at the specified index myContainer removeInnerAt 0 removes the first item of the in

Parameters

  • index?: number optional

    Number The index of the Component to remove.

Returns

IContainer

Ext.Container this

optional public removeListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Removes an event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public removeManagedListener(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public replaceCls(oldCls?: string, newCls?: string, prefix?: string, suffix?: string)

[Method] Replaces specified classes with the newly specified classes

Parameters

  • oldCls?: string optional

    String The class(es) to remove.

  • newCls?: string optional

    String The class(es) to add.

  • prefix?: string optional

    String Optional prefix to prepend before each class.

  • suffix?: string optional

    String Optional suffix to append to each class.

optional public resetFloating()

[Method] Resets top right bottom and left configurations to null which will un float this component

optional public resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

optional public setActiveItem(activeItem?: any)

[Method] Sets the value of activeItem

Parameters

  • activeItem?: any optional

    Object/String/Number The new value.

optional public setAutoDestroy(autoDestroy?: boolean)

[Method] Sets the value of autoDestroy

Parameters

  • autoDestroy?: boolean optional

    Boolean The new value.

optional public setBaseCls(baseCls?: string)

[Method] Sets the value of baseCls

Parameters

  • baseCls?: string optional

    String The new value.

optional public setBorder(border?: any)

[Method] Sets the value of border

Parameters

  • border?: any optional

    Number/String The new value.

optional public setBottom(bottom?: any)

[Method] Sets the value of bottom

Parameters

  • bottom?: any optional

    Number/String The new value.

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[] The new value.

optional public setCentered(centered?: boolean)

[Method] Sets the value of centered

Parameters

  • centered?: boolean optional

    Boolean The new value.

optional public setCls(cls?: any)

[Method] Sets the value of cls

Parameters

  • cls?: any optional

    String/String[] The new value.

optional public setContentEl(contentEl?: any)

[Method] Sets the value of contentEl

Parameters

  • contentEl?: any optional

    Ext.Element/HTMLElement/String The new value.

optional public setControl(control?: any)

[Method] Sets the value of control

Parameters

  • control?: any optional

    Object The new value.

optional public setData(data?: any)

[Method] Sets the value of data

Parameters

  • data?: any optional

    Object The new value.

optional public setDataMap(dataMap?: any)

[Method] Sets the value of dataMap

Parameters

  • dataMap?: any optional

    Object The new value.

optional public setDefaultType(defaultType?: string)

[Method] Sets the value of defaultType

Parameters

  • defaultType?: string optional

    String The new value.

optional public setDefaults(defaults?: any)

[Method] Sets the value of defaults

Parameters

  • defaults?: any optional

    Object The new value.

optional public setDisabled(disabled?: boolean)

[Method] Sets the value of disabled

Parameters

  • disabled?: boolean optional

    Boolean The new value.

optional public setDisabledCls(disabledCls?: string)

[Method] Sets the value of disabledCls

Parameters

  • disabledCls?: string optional

    String The new value.

optional public setDocked(docked?: string)

[Method] Sets the value of docked

Parameters

  • docked?: string optional

    String The new value.

optional public setDraggable(draggable?: any)

[Method] Sets the value of draggable

Parameters

  • draggable?: any optional

    Object The new value.

optional public setEnterAnimation(enterAnimation?: any)

[Method] Sets the value of enterAnimation

Parameters

  • enterAnimation?: any optional

    String/Mixed The new value.

optional public setExitAnimation(exitAnimation?: any)

[Method] Sets the value of exitAnimation

Parameters

  • exitAnimation?: any optional

    String/Mixed The new value.

optional public setFlex(flex?: number)

[Method] Sets the value of flex

Parameters

  • flex?: number optional

    Number The new value.

optional public setFloating(floating?: boolean)

[Method] Used to update the floating state of this component

Parameters

  • floating?: boolean optional

    Boolean true if you want to float this component.

optional public setFloatingCls(floatingCls?: string)

[Method] Sets the value of floatingCls

Parameters

  • floatingCls?: string optional

    String The new value.

optional public setHeight(height?: any)

[Method] Sets the value of height

Parameters

  • height?: any optional

    Number/String The new value.

optional public setHidden(hidden?: boolean)

[Method] Sets the value of hidden

Parameters

  • hidden?: boolean optional

    Boolean The new value.

optional public setHiddenCls(hiddenCls?: string)

[Method] Sets the value of hiddenCls

Parameters

  • hiddenCls?: string optional

    String The new value.

optional public setHideAnimation(hideAnimation?: any)

[Method] Sets the value of hideAnimation

Parameters

  • hideAnimation?: any optional

    String/Mixed The new value.

optional public setHideOnMaskTap(hideOnMaskTap?: boolean)

[Method] Sets the value of hideOnMaskTap

Parameters

  • hideOnMaskTap?: boolean optional

    Boolean The new value.

optional public setHtml(html?: any)

[Method] Sets the value of html

Parameters

  • html?: any optional

    String/Ext.Element/HTMLElement The new value.

optional public setItemCls(itemCls?: string)

[Method] Sets the value of itemCls

Parameters

  • itemCls?: string optional

    String The new value.

optional public setItemId(itemId?: string)

[Method] Sets the value of itemId

Parameters

  • itemId?: string optional

    String The new value.

optional public setItems(items?: Array<any>)

[Method] Sets the value of items

Parameters

  • items?: Array<any> optional

    Array The new value.

optional public setLayout(layout?: any)

[Method] Sets the value of layout

Parameters

  • layout?: any optional

    Object/String The new value.

optional public setLeft(left?: any)

[Method] Sets the value of left

Parameters

  • left?: any optional

    Number/String The new value.

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object The new value.

optional public setMargin(margin?: any)

[Method] Sets the value of margin

Parameters

  • margin?: any optional

    Number/String The new value.

optional public setMasked(masked?: any)

[Method] Sets the value of masked

Parameters

  • masked?: any optional

    Boolean/Object/Ext.Mask/Ext.LoadMask The new value.

optional public setMaxHeight(maxHeight?: any)

[Method] Sets the value of maxHeight

Parameters

  • maxHeight?: any optional

    Number/String The new value.

optional public setMaxWidth(maxWidth?: any)

[Method] Sets the value of maxWidth

Parameters

  • maxWidth?: any optional

    Number/String The new value.

optional public setMinHeight(minHeight?: any)

[Method] Sets the value of minHeight

Parameters

  • minHeight?: any optional

    Number/String The new value.

optional public setMinWidth(minWidth?: any)

[Method] Sets the value of minWidth

Parameters

  • minWidth?: any optional

    Number/String The new value.

optional public setModal(modal?: boolean)

[Method] Sets the value of modal

Parameters

  • modal?: boolean optional

    Boolean The new value.

optional public setPadding(padding?: any)

[Method] Sets the value of padding

Parameters

  • padding?: any optional

    Number/String The new value.

optional public setPlugins(plugins?: any)

[Method] Sets the value of plugins

Parameters

  • plugins?: any optional

    Object/Array The new value.

optional public setRecord(record?: IModel)

[Method] Sets the value of record

Parameters

  • record?: IModel optional

    Ext.data.Model The new value.

optional public setRenderTo(renderTo?: IElement)

[Method] Sets the value of renderTo

Parameters

  • renderTo?: IElement optional

    Ext.Element The new value.

optional public setRight(right?: any)

[Method] Sets the value of right

Parameters

  • right?: any optional

    Number/String The new value.

optional public setScrollable(scrollable?: any): IView

[Method] Sets the value of scrollable

Parameters

  • scrollable?: any optional

    Boolean/String/Object The new value.

Returns

IView

Ext.scroll.View The scroll view.

optional public setShowAnimation(showAnimation?: any)

[Method] Sets the value of showAnimation

Parameters

  • showAnimation?: any optional

    String/Mixed The new value.

optional public setSize(width?: number, height?: number)

[Method] Sets the size of the Component

Parameters

  • width?: number optional

    Number The new width for the Component.

  • height?: number optional

    Number The new height for the Component.

optional public setStyle(style?: any)

[Method] Sets the value of style

Parameters

  • style?: any optional

    String/Object The new value.

optional public setStyleHtmlCls(styleHtmlCls?: string)

[Method] Sets the value of styleHtmlCls

Parameters

  • styleHtmlCls?: string optional

    String The new value.

optional public setStyleHtmlContent(styleHtmlContent?: boolean)

[Method] Sets the value of styleHtmlContent

Parameters

  • styleHtmlContent?: boolean optional

    Boolean The new value.

optional public setTop(top?: any)

[Method] Sets the value of top

Parameters

  • top?: any optional

    Number/String The new value.

optional public setTpl(tpl?: any)

[Method] Sets the value of tpl

Parameters

  • tpl?: any optional

    String/String[]/Ext.Template/Ext.XTemplate[] The new value.

optional public setTplWriteMode(tplWriteMode?: string)

[Method] Sets the value of tplWriteMode

Parameters

  • tplWriteMode?: string optional

    String The new value.

optional public setUi(ui?: string)

[Method] Sets the value of ui

Parameters

  • ui?: string optional

    String The new value.

optional public setWidth(width?: string)

[Method] Sets the value of width

Parameters

  • width?: string optional

    String The new value.

optional public setZIndex(zIndex?: number)

[Method] Sets the value of zIndex

Parameters

  • zIndex?: number optional

    Number The new value.

optional public show(): IComponent

[Method] Shows this component optionally using an animation

Returns

IComponent

Ext.Component

optional public showBy(component?: IComponent, alignment?: string)

[Method] Shows this component by another component

Parameters

  • component?: IComponent optional

    Ext.Component The target component to show this component by.

  • alignment?: string optional

    String The specific alignment.

optional public suspendEvents()

[Method] Suspends the firing of all events

optional public un(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for removeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public unAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public unBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public unmask()

[Method] Convenience method which calls setMasked with a value of false to hide the mask

optional public up(selector?: string): IContainer

[Method] Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector

Parameters

  • selector?: string optional

    String The simple selector to test.

Returns

IContainer

Ext.Container The matching ancestor Container (or undefined if no match was found).

optional public update()

[Method] Updates the HTML content of the Component

optional public updateStyleHtmlCls(newHtmlCls?: any, oldHtmlCls?: any)

[Method] Updates the styleHtmlCls configuration

Parameters

  • newHtmlCls?: any optional

    Object

  • oldHtmlCls?: any optional

    Object