Interface ICompositeElement

Hierarchy

Index

Properties

Methods

Properties

optional public DISPLAY?: number

[Property] (Number)

optional public OFFSETS?: number

[Property] (Number)

optional public VISIBILITY?: number

[Property] (Number)

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public defaultUnit?: string

[Property] (String)

optional public dom?: HTMLElement

[Property] (HTMLElement)

optional public elements?: Array<HTMLElement>

[Property] (HTMLElement[])

optional public extend?: string

[Config Option] (String)

optional public id?: string

[Property] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public listeners?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public platformConfig?: any

[Config Option] (Object)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public add(els?: any, root?: any): ICompositeElementLite

[Method] Adds elements to this Composite object

Parameters

  • els?: any optional

    HTMLElement[]/Ext.dom.CompositeElementLite Either an Array of DOM elements to add, or another Composite object who's elements should be added.

  • root?: any optional

    HTMLElement/String The root element of the query or id of the root.

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite This Composite object.

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 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(names?: string, prefix?: string, suffix?: string): IElement

[Method] Adds the given CSS class es to this Element

Parameters

  • names?: string optional

    String The CSS class(es) to add to this element.

  • prefix?: string optional

    String Prefix to prepend to each class.

  • suffix?: string optional

    String Suffix to append to each class.

Returns

IElement

Ext.dom.Element this

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, handler?: any, scope?: any, opt?: any): ICompositeElementLite

[Method] fixes scope with flyweight

Parameters

  • eventName?: any optional

    Object

  • handler?: any optional

    Object

  • scope?: any optional

    Object

  • opt?: any optional

    Object

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite this

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 appendChild(element?: any): IElement

[Method] Appends the passed element s to this element

Parameters

  • element?: any optional

    HTMLElement/Ext.dom.Element a DOM Node or an existing Element.

Returns

IElement

Ext.dom.Element This element.

optional public appendTo(el?: any): IElement

[Method] Appends this element to the passed element

Parameters

  • el?: any optional

    String/HTMLElement/Ext.dom.Element The new parent element. The id of the node, a DOM Node or an existing Element.

Returns

IElement

Ext.dom.Element This element.

optional public applyStyles(styles?: any): IElement

[Method] More flexible version of setStyle for setting style properties

Parameters

  • styles?: any optional

    String/Object/Function A style specification string, e.g. "width:100px", or object in the form {width:"100px"}, or a function which returns such a specification.

Returns

IElement

Ext.dom.Element this

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, returnDom?: boolean): any

[Method] Selects a single direct child based on the passed CSS selector the selector should not contain an id

Parameters

  • selector?: string optional

    String The CSS selector.

  • returnDom?: boolean optional

    Boolean true to return the DOM node instead of Ext.dom.Element.

Returns

any

HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true)

optional public clear()

[Method] Removes all elements

optional public clearListeners()

[Method] Removes all listeners for this object

optional public contains(el?: any): boolean

[Method] Returns true if this composite contains the passed element

Parameters

  • el?: any optional

    String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.Element, or an HtmlElement to find within the composite collection.

Returns

boolean

Boolean

optional public createChild(config?: any, insertBefore?: HTMLElement, returnDom?: boolean): IElement

[Method] Creates the passed DomHelper config and appends it to this element or optionally inserts it before the passed child e

Parameters

  • config?: any optional

    Object DomHelper element config object. If no tag is specified (e.g., {tag:'input'}) then a div will be automatically generated with the specified attributes.

  • insertBefore?: HTMLElement optional

    HTMLElement a child element of this element.

  • returnDom?: boolean optional

    Boolean true to return the dom node instead of creating an Element.

Returns

IElement

Ext.dom.Element The new child element.

optional public cssTranslate()

[Method] Translates an element using CSS 3 in 2D

optional public destroy()

[Method] Removes this element s DOM reference

optional public down(selector?: string, returnDom?: boolean): any

[Method] Selects a single child at any depth below this element based on the passed CSS selector the selector should not cont

Parameters

  • selector?: string optional

    String The CSS selector.

  • returnDom?: boolean optional

    Boolean true to return the DOM node instead of Ext.dom.Element.

Returns

any

HTMLElement/Ext.dom.Element The child Ext.dom.Element (or DOM node if returnDom is true).

optional public each(fn?: any, scope?: any): ICompositeElementLite

[Method] Calls the passed function for each element in this composite

Parameters

  • fn?: any optional

    Function The function to call.

  • scope?: any optional

    Object The scope (this reference) in which the function is executed. Defaults to the Element.

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite this

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 fill(els?: any): ICompositeElementLite

[Method] Clears this Composite and adds the elements passed

Parameters

  • els?: any optional

    HTMLElement[]/Ext.dom.CompositeElementLite Either an array of DOM elements, or another Composite from which to fill this Composite.

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite this

optional public filter(selector?: any): ICompositeElementLite

[Method] Filters this composite to only elements that match the passed selector

Parameters

  • selector?: any optional

    String/Function A string CSS selector or a comparison function. The comparison function will be called with the following arguments:

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite this

optional public findParent(simpleSelector?: string, maxDepth?: any, returnEl?: boolean): any

[Method] Looks at this node and then at parent nodes for a match of the passed simple selector e g

Parameters

  • simpleSelector?: string optional

    String The simple selector to test.

  • maxDepth?: any optional

    Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 50 || document.body)

  • returnEl?: boolean optional

    Boolean true to return a Ext.Element object instead of DOM node.

Returns

any

HTMLElement/null The matching DOM node (or null if no match was found).

optional public findParentNode(simpleSelector?: string, maxDepth?: any, returnEl?: boolean): any

[Method] Looks at parent nodes for a match of the passed simple selector e g

Parameters

  • simpleSelector?: string optional

    String The simple selector to test.

  • maxDepth?: any optional

    Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body).

  • returnEl?: boolean optional

    Boolean true to return a Ext.Element object instead of DOM node.

Returns

any

HTMLElement/null The matching DOM node (or null if no match was found).

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 first(selector?: string, returnDom?: boolean): any

[Method] Gets the first child skipping text nodes

Parameters

  • selector?: string optional

    String Find the next sibling that matches the passed simple selector.

  • returnDom?: boolean optional

    Boolean true to return a raw DOM node instead of an Ext.dom.Element.

Returns

any

Ext.dom.Element/HTMLElement/null The first child or null.

optional public getAlignToXY(element?: any, position?: string, offsets?: Array<any>): Array<any>

[Method] Gets the x y coordinates to align this element with another element

Parameters

  • element?: any optional

    Mixed The element to align to.

  • position?: string optional

    String The position to align to.

  • offsets?: Array<any> optional

    Array Offset the positioning by [x, y].

Returns

Array<any>

Array [x, y]

optional public getAnchorXY(anchor?: string, local?: boolean, size?: any): Array<any>

[Method] Gets the x y coordinates specified by the anchor position on the element

Parameters

  • anchor?: string optional

    String The specified anchor position.

  • local?: boolean optional

    Boolean true to get the local (element top/left-relative) anchor position instead of page coordinates.

  • size?: any optional

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

Returns

Array<any>

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

optional public getAttribute(name?: string, namespace?: string): string

[Method] Returns the value of an attribute from the element s underlying DOM node

Parameters

  • name?: string optional

    String The attribute name.

  • namespace?: string optional

    String The namespace in which to look for the attribute.

Returns

string

String The attribute value.

optional public getBorderWidth(side?: string): number

[Method] Gets the width of the border s for the specified side s

Parameters

  • side?: string optional

    String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the border left width + the border right width.

Returns

number

Number The width of the sides passed added together

optional public getBottom(): number

[Method] Gets the bottom Y coordinate of the element element Y position element height

Returns

number

Number

optional public getBox(contentBox?: boolean, local?: boolean): any

[Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati

Parameters

  • contentBox?: boolean optional

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

  • local?: boolean optional

    Boolean If true the element's left and top are returned instead of page x/y.

Returns

any

Object An object in the format

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getCount(): number

[Method] Returns the number of elements in this Composite

Returns

number

Number

optional public getHTML(): string

[Method] Returns the innerHTML of an element

Returns

string

String

optional public getHeight(contentHeight?: boolean): number

[Method] Returns the offset height of the element

Parameters

  • contentHeight?: boolean optional

    Boolean true to get the height minus borders and padding.

Returns

number

Number The element's height.

optional public getHtml(): string

[Method] Returns the innerHTML of an element

Returns

string

String

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 getLeft(): number

[Method] Gets the left X coordinate

Returns

number

Number

optional public getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getMargin(sides?: string): any

[Method] Returns an object with properties top left right and bottom representing the margins of this element unless sides i

Parameters

  • sides?: string optional

    String Any combination of 'l', 'r', 't', 'b' to get the sum of those sides.

Returns

any

Object/Number

optional public getOffsetsTo(element?: any): Array<any>

[Method] Returns the offsets of this element from the passed element

Parameters

  • element?: any optional

    Mixed The element to get the offsets from.

Returns

Array<any>

Array The XY page offsets (e.g. [100, -200])

optional public getOuterHeight()

[Method] Retrieves the height of the element account for the top and bottom margins

optional public getOuterWidth()

[Method] Retrieves the width of the element accounting for the left and right margins

optional public getPadding(side?: string): number

[Method] Gets the width of the padding s for the specified side s

Parameters

  • side?: string optional

    String Can be t, l, r, b or any combination of those to add multiple values. For example, passing 'lr' would get the padding left + the padding right.

Returns

number

Number The padding of the sides passed added together.

optional public getPageBox(asRegion?: boolean): any

[Method] Return an object defining the area of this Element which can be passed to setBox to set another Element s size locati

Parameters

  • asRegion?: boolean optional

    Boolean If true an Ext.util.Region will be returned.

Returns

any

Object box An object in the format: { x: <Element's X position>, y: <Element's Y position>, width: <Element's width>, height: <Element's height>, bottom: <Element's lower bound>, right: <Element's rightmost bound> } The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. So the result may also be used for setXY.

optional public getRight(): number

[Method] Gets the right X coordinate of the element element X position element width

Returns

number

Number

optional public getScrollParent()

[Method] Gets the Scroller instance of the first parent that has one

optional public getSize(contentSize?: boolean): any

[Method] Returns the size of the element

Parameters

  • contentSize?: boolean optional

    Boolean true to get the width/size minus borders and padding.

Returns

any

Object An object containing the element's size:

optional public getStyle(prop?: string): string

[Method] Normalizes currentStyle and computedStyle

Parameters

  • prop?: string optional

    String The style property whose value is returned.

Returns

string

String The current value of the style property for this element.

optional public getTop(): number

[Method] Gets the top Y coordinate

Returns

number

Number

optional public getValue(asNumber?: boolean): any

[Method] Returns the value of the value attribute

Parameters

  • asNumber?: boolean optional

    Boolean true to parse the value as a number.

Returns

any

String/Number

optional public getViewSize(): any

[Method] Returns the dimensions of the element available to lay content out in

Returns

any

Object Object describing width and height:

optional public getWidth(contentWidth?: boolean): number

[Method] Returns the offset width of the element

Parameters

  • contentWidth?: boolean optional

    Boolean true to get the width minus borders and padding.

Returns

number

Number The element's width.

optional public getX(): number

[Method] Gets the current X position of the element based on page coordinates

Returns

number

Number The X position of the element

optional public getXY(): Array<any>

[Method] Gets the current position of the element based on page coordinates

Returns

Array<any>

Array The XY position of the element

optional public getY(): number

[Method] Gets the current Y position of the element based on page coordinates

Returns

number

Number The Y position of the element

optional public hasCls(name?: string): boolean

[Method] Checks if the specified CSS class exists on this element s DOM node

Parameters

  • name?: string optional

    String The CSS class to check for.

Returns

boolean

Boolean true if the class exists, else false.

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 hide()

[Method] Hides this element

optional public indexOf(el?: any): number

[Method] Find the index of the passed element within the composite collection

Parameters

  • el?: any optional

    String/HTMLElement/Ext.Element/Number The id of an element, or an Ext.dom.Element, or an HtmlElement to find within the composite collection.

Returns

number

Number The index of the passed Ext.dom.Element in the composite collection, or -1 if not found.

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 insertAfter(el?: any): IElement

[Method] Inserts this element after the passed element in the DOM

Parameters

  • el?: any optional

    String/HTMLElement/Ext.dom.Element The element to insert after. The id of the node, a DOM Node or an existing Element.

Returns

IElement

Ext.dom.Element This element.

optional public insertBefore(el?: any): IElement

[Method] Inserts this element before the passed element in the DOM

Parameters

  • el?: any optional

    String/HTMLElement/Ext.dom.Element The element before which this element will be inserted. The id of the node, a DOM Node or an existing Element.

Returns

IElement

Ext.dom.Element This element.

optional public insertFirst(element?: any): IElement

[Method] Inserts an element as the first child of this element

Parameters

  • element?: any optional

    String/HTMLElement/Ext.dom.Element The id or element to insert.

Returns

IElement

Ext.dom.Element this

optional public insertHtml(where?: string, html?: string, returnEl?: boolean): any

[Method] Inserts an HTML fragment into this element

Parameters

  • where?: string optional

    String Where to insert the HTML in relation to this element - 'beforeBegin', 'afterBegin', 'beforeEnd', 'afterEnd'. See Ext.DomHelper.insertHtml for details.

  • html?: string optional

    String The HTML fragment

  • returnEl?: boolean optional

    Boolean true to return an Ext.dom.Element.

Returns

any

HTMLElement/Ext.dom.Element The inserted node (or nearest related if more than 1 inserted).

optional public insertSibling(el?: any, where?: string, returnDom?: boolean): IElement

[Method] Inserts or creates the passed element or DomHelper config as a sibling of this element

Parameters

  • el?: any optional

    String/HTMLElement/Ext.dom.Element/Object/Array The id, element to insert or a DomHelper config to create and insert or an array of any of those.

  • where?: string optional

    String 'before' or 'after'.

  • returnDom?: boolean optional

    Boolean true to return the raw DOM element instead of Ext.dom.Element.

Returns

IElement

Ext.dom.Element The inserted Element. If an array is passed, the last inserted element is returned.

optional public is(selector?: string): boolean

[Method] Returns true if this element matches the passed simple selector e g

Parameters

  • selector?: string optional

    String The simple selector to test.

Returns

boolean

Boolean true if this element matches the selector, else false.

optional public isDescendent()

[Method] Determines if this element is a descendant of the passed in Element

optional public isStyle(style?: string, value?: string): boolean

[Method] Checks if the current value of a style is equal to a given value

Parameters

  • style?: string optional

    String property whose value is returned.

  • value?: string optional

    String to check against.

Returns

boolean

Boolean true for when the current value equals the given value.

optional public isTransparent(prop?: string): boolean

[Method] Returns true if the value of the given property is visually transparent

Parameters

  • prop?: string optional

    String The style property whose value is to be tested.

Returns

boolean

Boolean true if the style property is visually transparent.

optional public item(index?: number): IElement

[Method] Returns a flyweight Element of the dom element object at the specified index

Parameters

  • index?: number optional

    Number

Returns

IElement

Ext.dom.Element

optional public last(selector?: string, returnDom?: boolean): any

[Method] Gets the last child skipping text nodes

Parameters

  • selector?: string optional

    String Find the previous sibling that matches the passed simple selector.

  • returnDom?: boolean optional

    Boolean true to return a raw DOM node instead of an Ext.dom.Element.

Returns

any

Ext.dom.Element/HTMLElement/null The last child or null.

optional public mask()

[Method] Puts a mask over this element to disable user interaction

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 next(selector?: string, returnDom?: boolean): any

[Method] Gets the next sibling skipping text nodes

Parameters

  • selector?: string optional

    String Find the next sibling that matches the passed simple selector.

  • returnDom?: boolean optional

    Boolean true to return a raw dom node instead of an Ext.dom.Element.

Returns

any

Ext.dom.Element/HTMLElement/null The next sibling or null.

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 parent(selector?: string, returnDom?: boolean): any

[Method] Gets the parent node for this element optionally chaining up trying to match a selector

Parameters

  • selector?: string optional

    String Find a parent node that matches the passed simple selector.

  • returnDom?: boolean optional

    Boolean true to return a raw DOM node instead of an Ext.dom.Element.

Returns

any

Ext.dom.Element/HTMLElement/null The parent node or null.

optional public prev(selector?: string, returnDom?: boolean): any

[Method] Gets the previous sibling skipping text nodes

Parameters

  • selector?: string optional

    String Find the previous sibling that matches the passed simple selector.

  • returnDom?: boolean optional

    Boolean true to return a raw DOM node instead of an Ext.dom.Element

Returns

any

Ext.dom.Element/HTMLElement/null The previous sibling or null.

optional public purgeAllListeners()

[Method] Removes all listeners for this object

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

[Method] Selects child nodes based on the passed CSS selector the selector should not contain an id

Parameters

  • selector?: string optional

    String The CSS selector.

Returns

Array<HTMLElement>

HTMLElement[] An array of the matched nodes.

optional public radioCls(className?: any): IElement

[Method] Adds one or more CSS classes to this element and removes the same class es from all siblings

Parameters

  • className?: any optional

    String/String[] The CSS class to add, or an array of classes.

Returns

IElement

Ext.dom.Element this

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()

[Method] Removes this element s DOM reference

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 removeAllListeners()

[Method] Removes all listeners for this object

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(names?: string, prefix?: string, suffix?: string): IElement

[Method] Removes the given CSS class es from this Element

Parameters

  • names?: string optional

    String The CSS class(es) to remove from this element.

  • prefix?: string optional

    String Prefix to prepend to each class to be removed.

  • suffix?: string optional

    String Suffix to append to each class to be removed.

Returns

IElement

Ext.dom.Element this

optional public removeElement(el?: any, removeDom?: boolean): ICompositeElementLite

[Method] Removes the specified element s

Parameters

  • el?: any optional

    String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite or an array of any of those.

  • removeDom?: boolean optional

    Boolean true to also remove the element from the document

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite 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 repaint(): IElement

[Method] Forces the browser to repaint this element

Returns

IElement

Ext.dom.Element this

optional public replace(element?: any): IElement

[Method] Replaces the passed element with this element

Parameters

  • element?: any optional

    String/HTMLElement/Ext.dom.Element The element to replace. The id of the node, a DOM Node or an existing Element.

Returns

IElement

Ext.dom.Element This element.

optional public replaceCls(oldName?: string, newName?: string, prefix?: string, suffix?: string): IElement

[Method] Replaces a CSS class on the element with another

Parameters

  • oldName?: string optional

    String The CSS class to replace.

  • newName?: string optional

    String The replacement CSS class.

  • prefix?: string optional

    String Prefix to prepend to each class to be replaced.

  • suffix?: string optional

    String Suffix to append to each class to be replaced.

Returns

IElement

Ext.dom.Element this

optional public replaceElement(el?: any, replacement?: any, domReplace?: boolean): ICompositeElementLite

[Method] Replaces the specified element with the passed element

Parameters

  • el?: any optional

    String/HTMLElement/Ext.Element/Number The id of an element, the Element itself, the index of the element in this composite to replace.

  • replacement?: any optional

    String/Ext.Element The id of an element or the Element itself.

  • domReplace?: boolean optional

    Boolean true to remove and replace the element in the document too.

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite this

optional public replaceWith(el?: any): IElement

[Method] Replaces this element with the passed element

Parameters

  • el?: any optional

    String/HTMLElement/Ext.dom.Element/Object The new element (id of the node, a DOM Node or an existing Element) or a DomHelper config of an element to create.

Returns

IElement

Ext.dom.Element This element.

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 select(selector?: any, composite?: boolean): ICompositeElementLite

[Method] Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in

Parameters

  • selector?: any optional

    String/HTMLElement[] The CSS selector or an array of elements

  • composite?: boolean optional

    Boolean Return a CompositeElement as opposed to a CompositeElementLite. Defaults to false.

Returns

ICompositeElementLite

Ext.dom.CompositeElementLite/Ext.dom.CompositeElement

optional public serializeForm(form?: any): string

[Method] Serializes a DOM form into a url encoded string

Parameters

  • form?: any optional

    Object The form

Returns

string

String The url encoded form

optional public set(attributes?: any, useSet?: boolean): IElement

[Method] Sets the passed attributes as attributes of this element a style attribute can be a string object or function

Parameters

  • attributes?: any optional

    Object The object with the attributes.

  • useSet?: boolean optional

    Boolean false to override the default setAttribute to use expandos.

Returns

IElement

Ext.dom.Element this

optional public setBottom(bottom?: string): IElement

[Method] Sets the element s CSS bottom style

Parameters

  • bottom?: string optional

    String The bottom CSS property value.

Returns

IElement

Ext.dom.Element this

optional public setBox(box?: any): IElement

[Method] Sets the element s box

Parameters

  • box?: any optional

    Object The box to fill, for example: { left: ..., top: ..., width: ..., height: ... }

Returns

IElement

Ext.dom.Element this

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[] The new value.

optional public setCls(className?: any)

[Method] Sets the specified CSS class on this element s DOM node

Parameters

  • className?: any optional

    String/Array The CSS class to set on this element.

optional public setHTML(html?: string)

[Method] Sets the innerHTML of this element

Parameters

  • html?: string optional

    String The new HTML.

optional public setHeight(height?: any): IElement

[Method] Set the height of this Element

Parameters

  • height?: any optional

    Number/String The new height.

Returns

IElement

Ext.dom.Element this

optional public setHtml(html?: string)

[Method] Sets the innerHTML of this element

Parameters

  • html?: string optional

    String The new HTML.

optional public setLeft(left?: string): IElement

[Method] Sets the element s left position directly using CSS style instead of setX

Parameters

  • left?: string optional

    String The left CSS property value.

Returns

IElement

Ext.dom.Element this

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object The new value.

optional public setMaxHeight(height?: any): IElement

[Method] Set the maximum height of this Element

Parameters

  • height?: any optional

    Number/String The new maximum height.

Returns

IElement

Ext.dom.Element this

optional public setMaxWidth(width?: any): IElement

[Method] Set the maximum width of this Element

Parameters

  • width?: any optional

    Number/String The new maximum width.

Returns

IElement

Ext.dom.Element this

optional public setMinHeight(height?: any): IElement

[Method] Set the minimum height of this Element

Parameters

  • height?: any optional

    Number/String The new minimum height.

Returns

IElement

Ext.dom.Element this

optional public setMinWidth(width?: any): IElement

[Method] Set the minimum width of this Element

Parameters

  • width?: any optional

    Number/String The new minimum width.

Returns

IElement

Ext.dom.Element this

optional public setRight(right?: string): IElement

[Method] Sets the element s CSS right style

Parameters

  • right?: string optional

    String The right CSS property value.

Returns

IElement

Ext.dom.Element this

optional public setSize(width?: any, height?: any): IElement

[Method] Set the size of this Element

Parameters

  • width?: any optional

    Number/String The new width. This may be one of: A Number specifying the new width in this Element's defaultUnits (by default, pixels). A String used to set the CSS width style. Animation may not be used. A size object in the format {width: widthValue, height: heightValue}.

  • height?: any optional

    Number/String The new height. This may be one of: A Number specifying the new height in this Element's defaultUnits (by default, pixels). A String used to set the CSS height style. Animation may not be used.

Returns

IElement

Ext.dom.Element this

optional public setStyle(property?: any, value?: string): IElement

[Method] Wrapper for setting style properties also takes single object parameter of multiple styles

Parameters

  • property?: any optional

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

  • value?: string optional

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

Returns

IElement

Ext.dom.Element this

optional public setTop(top?: string): IElement

[Method] Sets the element s top position directly using CSS style instead of setY

Parameters

  • top?: string optional

    String The top CSS property value.

Returns

IElement

Ext.dom.Element this

optional public setTopLeft()

[Method] Sets the element s top and left positions directly using CSS style

optional public setVisibilityMode(mode?: any): IElement

[Method] Use this to change the visibility mode between VISIBILITY DISPLAY or OFFSETS

Parameters

  • mode?: any optional

    Object

Returns

IElement

Ext.dom.Element this

optional public setVisible(visible?: boolean): IElement

[Method] Sets the visibility of the element see details

Parameters

  • visible?: boolean optional

    Boolean Whether the element is visible.

Returns

IElement

Ext.Element this

optional public setWidth(width?: any): IElement

[Method] Set the width of this Element

Parameters

  • width?: any optional

    Number/String The new width.

Returns

IElement

Ext.dom.Element this

optional public setX(x?: number): IElement

[Method] Sets the X position of the element based on page coordinates

Parameters

  • x?: number optional

    Number The X position of the element

Returns

IElement

Ext.dom.Element this

optional public setXY(pos?: Array<number>): IElement

[Method] Sets the position of the element in page coordinates regardless of how the element is positioned

Parameters

  • pos?: Array<number> optional

    Number[] Contains X & Y [x, y] values for new position (coordinates are page-based).

Returns

IElement

Ext.dom.Element this

optional public setY(y?: number): IElement

[Method] Sets the Y position of the element based on page coordinates

Parameters

  • y?: number optional

    Number The Y position of the element.

Returns

IElement

Ext.dom.Element this

optional public show()

[Method] Shows this element

optional public suspendEvents()

[Method] Suspends the firing of all events

optional public toggleCls(className?: string): IElement

[Method] Toggles the specified CSS class on this element removes it if it already exists otherwise adds it

Parameters

  • className?: string optional

    String The CSS class to toggle.

Returns

IElement

Ext.dom.Element this

optional public translatePoints(x?: any, y?: number): any

[Method] Translates the passed page coordinates into left top CSS values for this element

Parameters

  • x?: any optional

    Number/Array The page x or an array containing [x, y].

  • y?: number optional

    Number The page y, required if x is not an array.

Returns

any

Object An object with left and top properties. e.g. {left: (value), top: (value)}.

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] Removes a previously applied mask

optional public up(simpleSelector?: string, maxDepth?: any): any

[Method] Walks up the dom looking for a parent node that matches the passed simple selector e g

Parameters

  • simpleSelector?: string optional

    String The simple selector to test

  • maxDepth?: any optional

    Number/String/HTMLElement/Ext.Element The max depth to search as a number or element (defaults to 10 || document.body).

Returns

any

Ext.dom.Element/null The matching DOM node (or null if no match was found).

optional public update(html?: string)

[Method] Sets the innerHTML of this element

Parameters

  • html?: string optional

    String The new HTML.

optional public wrap(config?: any, domNode?: boolean): any

[Method] Creates and wraps this element with another element

Parameters

  • config?: any optional

    Object DomHelper element config object for the wrapper element or null for an empty div

  • domNode?: boolean optional

    Boolean true to return the raw DOM element instead of Ext.dom.Element.

Returns

any

HTMLElement/Ext.dom.Element The newly created wrapper element.