Class Msg

Index

Properties

Methods

Properties

public static items: IMixedCollection

[Property] (Ext.util.MixedCollection)

public static self: IClass

[Property] (Ext.Class)

Methods

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

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

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

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

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

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

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

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

public static alert(title?: string, message?: string, fn?: any, scope?: any): IMessageBox

[Method] Displays a standard read only message box with an OK button comparable to the basic JavaScript alert prompt

Parameters

  • title?: string optional

    String The title bar text.

  • message?: string optional

    String The message box body text.

  • fn?: any optional

    Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons.

  • scope?: any optional

    Object The scope (this reference) in which the callback is executed. Defaults to: the browser window

Returns

IMessageBox

Ext.MessageBox this

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

public static 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

public static 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

public static 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

public static 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

public static 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

public static clearListeners()

[Method] Removes all listeners for this object

public static confirm(title?: string, message?: string, fn?: any, scope?: any): IMessageBox

[Method] Displays a confirmation message box with Yes and No buttons comparable to JavaScript s confirm

Parameters

  • title?: string optional

    String The title bar text.

  • message?: string optional

    String The message box body text.

  • fn?: any optional

    Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons.

  • scope?: any optional

    Object The scope (this reference) in which the callback is executed. Defaults to: the browser window

Returns

IMessageBox

Ext.MessageBox this

public static destroy()

[Method]

public static disable()

[Method] Disables this Component

public static 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

public static enable()

[Method] Enables this Component

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

public static 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

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

public static getActiveItem(): any

[Method] Returns the value of activeItem

Returns

any

Object/String/Number

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

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

Parameters

  • component?: any optional

    Object

  • alignment?: any optional

    Object

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

public static getAutoDestroy(): boolean

[Method] Returns the value of autoDestroy

Returns

boolean

Boolean

public static getBaseCls(): string

[Method] Returns the value of baseCls

Returns

string

String

public static getBodyBorder(): any

[Method] Returns the value of bodyBorder

Returns

any

Number/Boolean/String

public static getBodyMargin(): any

[Method] Returns the value of bodyMargin

Returns

any

Number/Boolean/String

public static getBodyPadding(): any

[Method] Returns the value of bodyPadding

Returns

any

Number/Boolean/String

public static getBorder(): any

[Method] Returns the value of border

Returns

any

Number/String

public static getBottom(): any

[Method] Returns the value of bottom

Returns

any

Number/String

public static getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

public static getButtons(): any

[Method] Returns the value of buttons

Returns

any

Array/Object

public static getCentered(): boolean

[Method] Returns the value of centered

Returns

boolean

Boolean

public static getCls(): any

[Method] Returns the value of cls

Returns

any

String/String[]

public static 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).

public static getContentEl(): any

[Method] Returns the value of contentEl

Returns

any

Ext.Element/HTMLElement/String

public static getControl(): any

[Method] Returns the value of control

Returns

any

Object

public static getData(): any

[Method] Returns the value of data

Returns

any

Object

public static getDefaultTextHeight(): number

[Method] Returns the value of defaultTextHeight

Returns

number

Number

public static getDefaultType(): string

[Method] Returns the value of defaultType

Returns

string

String

public static getDefaults(): any

[Method] Returns the value of defaults

Returns

any

Object

public static getDisabled(): boolean

[Method] Returns the value of disabled

Returns

boolean

Boolean

public static getDisabledCls(): string

[Method] Returns the value of disabledCls

Returns

string

String

public static getDocked(): string

[Method] Returns the value of docked

Returns

string

String

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

public static getDockedItems(): Array<any>

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

Returns

Array<any>

Array The docked items of this container.

public static getEl(): IElement

[Method] Retrieves the top level element representing this component

Returns

IElement

Ext.dom.Element

public static getEnter(): string

[Method] Returns the value of enter

Returns

string

String

public static getEnterAnimation(): any

[Method] Returns the value of enterAnimation

Returns

any

String/Mixed

public static getExit(): string

[Method] Returns the value of exit

Returns

string

String

public static getExitAnimation(): any

[Method] Returns the value of exitAnimation

Returns

any

String/Mixed

public static getFlex(): number

[Method] Returns the value of flex

Returns

number

Number

public static getFloatingCls(): string

[Method] Returns the value of floatingCls

Returns

string

String

public static getHeight(): any

[Method] Returns the value of height

Returns

any

Number/String

public static getHidden(): boolean

[Method] Returns the value of hidden

Returns

boolean

Boolean

public static getHiddenCls(): string

[Method] Returns the value of hiddenCls

Returns

string

String

public static getHideAnimation(): any

[Method] Returns the value of hideAnimation

Returns

any

Object

public static getHideOnMaskTap(): boolean

[Method] Returns the value of hideOnMaskTap

Returns

boolean

Boolean

public static getHtml(): any

[Method] Returns the value of html

Returns

any

String/Ext.Element/HTMLElement

public static getId(): string

[Method] Retrieves the id of this component

Returns

string

String id

public static 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

public static getInnerItems(): Array<any>

[Method] Returns all inner items of this container

Returns

Array<any>

Array The inner items of this container.

public static getItemId(): string

[Method] Returns the value of itemId

Returns

string

String

public static getItems(): any

[Method] Returns the value of items

Returns

any

Array/Object

public static getLayout(): any

[Method] Returns the value of layout

Returns

any

Object

public static getLeft(): any

[Method] Returns the value of left

Returns

any

Number/String

public static getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

public static getMargin(): any

[Method] Returns the value of margin

Returns

any

Number/String

public static getMasked(): any

[Method] Returns the value of masked

Returns

any

Boolean/Object/Ext.Mask/Ext.LoadMask

public static getMaxHeight(): any

[Method] Returns the value of maxHeight

Returns

any

Number/String

public static getMaxWidth(): any

[Method] Returns the value of maxWidth

Returns

any

Number/String

public static getMinHeight(): any

[Method] Returns the value of minHeight

Returns

any

Number/String

public static getMinWidth(): any

[Method] Returns the value of minWidth

Returns

any

Number/String

public static getPadding(): any

[Method] Returns the value of padding

Returns

any

Number/String

public static getParent(): IComponent

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

Returns

IComponent

Ext.Component The parent of this component.

public static getPlugins(): any

[Method] Returns the value of plugins

Returns

any

Object/Array

public static getPrompt(): any

[Method] Returns the value of prompt

Returns

any

Object

public static getRecord(): IModel

[Method] Returns the value of record

Returns

IModel

Ext.data.Model

public static getRenderTo(): IElement

[Method] Returns the value of renderTo

Returns

IElement

Ext.Element

public static getRight(): any

[Method] Returns the value of right

Returns

any

Number/String

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

public static getShowAnimation(): any

[Method] Returns the value of showAnimation

Returns

any

Object

public static getSize(): any

[Method] Returns the height and width of the Component

Returns

any

Object The current height and width of the Component.

public static getStretchX(): boolean

[Method] Returns the value of stretchX

Returns

boolean

Boolean

public static getStretchY(): boolean

[Method] Returns the value of stretchY

Returns

boolean

Boolean

public static getStyle(): any

[Method] Returns the value of style

Returns

any

String/Object

public static getStyleHtmlCls(): string

[Method] Returns the value of styleHtmlCls

Returns

string

String

public static getStyleHtmlContent(): boolean

[Method] Returns the value of styleHtmlContent

Returns

boolean

Boolean

public static getTitle(): string

[Method] Returns the value of title

Returns

string

String

public static getTop(): any

[Method] Returns the value of top

Returns

any

Number/String

public static getTpl(): any

[Method] Returns the value of tpl

Returns

any

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

public static getTplWriteMode(): string

[Method] Returns the value of tplWriteMode

Returns

string

String

public static getUi(): string

[Method] Returns the value of ui

Returns

string

String

public static getWidth(): any

[Method] Returns the value of width

Returns

any

Number/String

public static getXTypes(): string

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

Returns

string

String The xtype hierarchy string.

public static getZIndex(): number

[Method] Returns the value of zIndex

Returns

number

Number

public static 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

public static hasParent(): boolean

[Method] Returns true if this component has a parent

Returns

boolean

Boolean true if this component has a parent.

public static hide(): IComponent

[Method] Hides this Component optionally using an animation

Returns

IComponent

Ext.Component

public static 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

public static initialize()

[Method] Allows addition of behavior to the rendering phase

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

public static isDisabled(): boolean

[Method] Returns true if this Component is currently disabled

Returns

boolean

Boolean true if currently disabled.

public static isHidden(): boolean

[Method] Returns true if this Component is currently hidden

Returns

boolean

Boolean true if currently hidden.

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

public static mask(mask?: any)

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

Parameters

  • mask?: any optional

    Object

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

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

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

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

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

public static prompt(title?: string, message?: string, fn?: any, scope?: any, multiLine?: any, value?: string, prompt?: any): IMessageBox

[Method] Displays a message box with OK and Cancel buttons prompting the user to enter some text comparable to JavaScript s p

Parameters

  • title?: string optional

    String The title bar text.

  • message?: string optional

    String The message box body text.

  • fn?: any optional

    Function A callback function which is called when the dialog is dismissed by clicking on the configured buttons.

  • scope?: any optional

    Object The scope (this reference) in which the callback is executed. Defaults to: the browser window.

  • multiLine?: any optional

    Boolean/Number true to create a multiline textbox using the defaultTextHeight property, or the height in pixels to create the textbox.

  • value?: string optional

    String Default value of the text input element.

  • prompt?: any optional

    Object The configuration for the prompt. See the prompt documentation in Ext.MessageBox for more information.

Returns

IMessageBox

Ext.MessageBox this

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

public static 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

public static 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

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

public static 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

public static 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

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

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

public static 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

public static 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

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

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

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

public static resetFloating()

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

public static resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

public static setActiveItem(activeItem?: any)

[Method] Sets the value of activeItem

Parameters

  • activeItem?: any optional

    Object/String/Number The new value.

public static setAutoDestroy(autoDestroy?: boolean)

[Method] Sets the value of autoDestroy

Parameters

  • autoDestroy?: boolean optional

    Boolean The new value.

public static setBaseCls(baseCls?: string)

[Method] Sets the value of baseCls

Parameters

  • baseCls?: string optional

    String The new value.

public static setBodyBorder(bodyBorder?: any)

[Method] Sets the value of bodyBorder

Parameters

  • bodyBorder?: any optional

    Number/Boolean/String The new value.

public static setBodyMargin(bodyMargin?: any)

[Method] Sets the value of bodyMargin

Parameters

  • bodyMargin?: any optional

    Number/Boolean/String The new value.

public static setBodyPadding(bodyPadding?: any)

[Method] Sets the value of bodyPadding

Parameters

  • bodyPadding?: any optional

    Number/Boolean/String The new value.

public static setBorder(border?: any)

[Method] Sets the value of border

Parameters

  • border?: any optional

    Number/String The new value.

public static setBottom(bottom?: any)

[Method] Sets the value of bottom

Parameters

  • bottom?: any optional

    Number/String The new value.

public static setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[] The new value.

public static setButtons(buttons?: any)

[Method] Sets the value of buttons

Parameters

  • buttons?: any optional

    Array/Object The new value.

public static setCentered(centered?: boolean)

[Method] Sets the value of centered

Parameters

  • centered?: boolean optional

    Boolean The new value.

public static setCls(cls?: any)

[Method] Sets the value of cls

Parameters

  • cls?: any optional

    String/String[] The new value.

public static setContentEl(contentEl?: any)

[Method] Sets the value of contentEl

Parameters

  • contentEl?: any optional

    Ext.Element/HTMLElement/String The new value.

public static setControl(control?: any)

[Method] Sets the value of control

Parameters

  • control?: any optional

    Object The new value.

public static setData(data?: any)

[Method] Sets the value of data

Parameters

  • data?: any optional

    Object The new value.

public static setDefaultTextHeight(defaultTextHeight?: number)

[Method] Sets the value of defaultTextHeight

Parameters

  • defaultTextHeight?: number optional

    Number The new value.

public static setDefaultType(defaultType?: string)

[Method] Sets the value of defaultType

Parameters

  • defaultType?: string optional

    String The new value.

public static setDefaults(defaults?: any)

[Method] Sets the value of defaults

Parameters

  • defaults?: any optional

    Object The new value.

public static setDisabled(disabled?: boolean)

[Method] Sets the value of disabled

Parameters

  • disabled?: boolean optional

    Boolean The new value.

public static setDisabledCls(disabledCls?: string)

[Method] Sets the value of disabledCls

Parameters

  • disabledCls?: string optional

    String The new value.

public static setDocked(docked?: string)

[Method] Sets the value of docked

Parameters

  • docked?: string optional

    String The new value.

public static setDraggable(draggable?: any)

[Method] Sets the value of draggable

Parameters

  • draggable?: any optional

    Object The new value.

public static setEnter(enter?: string)

[Method] Sets the value of enter

Parameters

  • enter?: string optional

    String The new value.

public static setEnterAnimation(enterAnimation?: any)

[Method] Sets the value of enterAnimation

Parameters

  • enterAnimation?: any optional

    String/Mixed The new value.

public static setExit(exit?: string)

[Method] Sets the value of exit

Parameters

  • exit?: string optional

    String The new value.

public static setExitAnimation(exitAnimation?: any)

[Method] Sets the value of exitAnimation

Parameters

  • exitAnimation?: any optional

    String/Mixed The new value.

public static setFlex(flex?: number)

[Method] Sets the value of flex

Parameters

  • flex?: number optional

    Number The new value.

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

public static setFloatingCls(floatingCls?: string)

[Method] Sets the value of floatingCls

Parameters

  • floatingCls?: string optional

    String The new value.

public static setHeight(height?: any)

[Method] Sets the value of height

Parameters

  • height?: any optional

    Number/String The new value.

public static setHidden(hidden?: boolean)

[Method] Sets the value of hidden

Parameters

  • hidden?: boolean optional

    Boolean The new value.

public static setHiddenCls(hiddenCls?: string)

[Method] Sets the value of hiddenCls

Parameters

  • hiddenCls?: string optional

    String The new value.

public static setHideAnimation(hideAnimation?: any)

[Method] Sets the value of hideAnimation

Parameters

  • hideAnimation?: any optional

    Object The new value.

public static setHideOnMaskTap(hideOnMaskTap?: boolean)

[Method] Sets the value of hideOnMaskTap

Parameters

  • hideOnMaskTap?: boolean optional

    Boolean The new value.

public static setHtml(html?: any)

[Method] Sets the value of html

Parameters

  • html?: any optional

    String/Ext.Element/HTMLElement The new value.

public static setIcon(iconCls?: string): IMessageBox

[Method] Sets icon

Parameters

  • iconCls?: string optional

    String A CSS class name or empty string to clear the icon.

Returns

IMessageBox

Ext.MessageBox this

public static setIconCls(iconCls?: string)

[Method] Sets the value of iconCls

Parameters

  • iconCls?: string optional

    String The new value.

public static setItemId(itemId?: string)

[Method] Sets the value of itemId

Parameters

  • itemId?: string optional

    String The new value.

public static setItems(items?: any)

[Method] Sets the value of items

Parameters

  • items?: any optional

    Array/Object The new value.

public static setLayout(layout?: any)

[Method] Sets the value of layout

Parameters

  • layout?: any optional

    Object The new value.

public static setLeft(left?: any)

[Method] Sets the value of left

Parameters

  • left?: any optional

    Number/String The new value.

public static setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object The new value.

public static setMargin(margin?: any)

[Method] Sets the value of margin

Parameters

  • margin?: any optional

    Number/String The new value.

public static setMasked(masked?: any)

[Method] Sets the value of masked

Parameters

  • masked?: any optional

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

public static setMaxHeight(maxHeight?: any)

[Method] Sets the value of maxHeight

Parameters

  • maxHeight?: any optional

    Number/String The new value.

public static setMaxWidth(maxWidth?: any)

[Method] Sets the value of maxWidth

Parameters

  • maxWidth?: any optional

    Number/String The new value.

public static setMessage(message?: string)

[Method] Sets the value of message

Parameters

  • message?: string optional

    String The new value.

public static setMinHeight(minHeight?: any)

[Method] Sets the value of minHeight

Parameters

  • minHeight?: any optional

    Number/String The new value.

public static setMinWidth(minWidth?: any)

[Method] Sets the value of minWidth

Parameters

  • minWidth?: any optional

    Number/String The new value.

public static setPadding(padding?: any)

[Method] Sets the value of padding

Parameters

  • padding?: any optional

    Number/String The new value.

public static setPlugins(plugins?: any)

[Method] Sets the value of plugins

Parameters

  • plugins?: any optional

    Object/Array The new value.

public static setPrompt(prompt?: any)

[Method] Sets the value of prompt

Parameters

  • prompt?: any optional

    Object The new value.

public static setRecord(record?: IModel)

[Method] Sets the value of record

Parameters

  • record?: IModel optional

    Ext.data.Model The new value.

public static setRenderTo(renderTo?: IElement)

[Method] Sets the value of renderTo

Parameters

  • renderTo?: IElement optional

    Ext.Element The new value.

public static setRight(right?: any)

[Method] Sets the value of right

Parameters

  • right?: any optional

    Number/String The new value.

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

public static setShowAnimation(showAnimation?: any)

[Method] Sets the value of showAnimation

Parameters

  • showAnimation?: any optional

    Object The new value.

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

public static setStretchX(stretchX?: boolean)

[Method] Sets the value of stretchX

Parameters

  • stretchX?: boolean optional

    Boolean The new value.

public static setStretchY(stretchY?: boolean)

[Method] Sets the value of stretchY

Parameters

  • stretchY?: boolean optional

    Boolean The new value.

public static setStyle(style?: any)

[Method] Sets the value of style

Parameters

  • style?: any optional

    String/Object The new value.

public static setStyleHtmlCls(styleHtmlCls?: string)

[Method] Sets the value of styleHtmlCls

Parameters

  • styleHtmlCls?: string optional

    String The new value.

public static setStyleHtmlContent(styleHtmlContent?: boolean)

[Method] Sets the value of styleHtmlContent

Parameters

  • styleHtmlContent?: boolean optional

    Boolean The new value.

public static setTitle(title?: string)

[Method] Sets the value of title

Parameters

  • title?: string optional

    String The new value.

public static setTop(top?: any)

[Method] Sets the value of top

Parameters

  • top?: any optional

    Number/String The new value.

public static setTpl(tpl?: any)

[Method] Sets the value of tpl

Parameters

  • tpl?: any optional

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

public static setTplWriteMode(tplWriteMode?: string)

[Method] Sets the value of tplWriteMode

Parameters

  • tplWriteMode?: string optional

    String The new value.

public static setUi(ui?: string)

[Method] Sets the value of ui

Parameters

  • ui?: string optional

    String The new value.

public static setWidth(width?: any)

[Method] Sets the value of width

Parameters

  • width?: any optional

    Number/String The new value.

public static setZIndex(zIndex?: number)

[Method] Sets the value of zIndex

Parameters

  • zIndex?: number optional

    Number The new value.

public static show(config?: any): IMessageBox

[Method] Displays the Ext MessageBox with a specified configuration

Parameters

  • config?: any optional

    Object An object with the following config options:

Returns

IMessageBox

Ext.MessageBox this

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

public static statics(): IClass

[Method] Get the reference to the class from which this object was instantiated

Returns

IClass

Ext.Class

public static suspendEvents()

[Method] Suspends the firing of all events

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

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

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

public static unmask()

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

public static 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).

public static update()

[Method] Updates the HTML content of the Component

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

[Method] Updates the styleHtmlCls configuration

Parameters

  • newHtmlCls?: any optional

    Object

  • oldHtmlCls?: any optional

    Object

public static updateText(message?: string): IMessageBox

[Method] Sets the value of message

Parameters

  • message?: string optional

    String The new value.

Returns

IMessageBox

Ext.MessageBox this