Interface ICube

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public before?: any

[Config Option] (Object)

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public direction?: string

[Config Option] (String)

optional public easing?: string

[Config Option] (String)

optional public extend?: string

[Config Option] (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 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 addEvents(eventNames?: any)

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

Parameters

  • eventNames?: any optional

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

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

[Method] Appends an event handler to this object

Parameters

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

  • options?: any optional

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

  • order?: string optional

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

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

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

Parameters

  • object?: any optional

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

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

  • options?: any optional

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

optional public 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 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 clearListeners()

[Method] Removes all listeners for this object

optional public destroy()

[Method]

optional public enableBubble(events?: any)

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

Parameters

  • events?: any optional

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

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

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

Parameters

  • eventName?: string optional

    String The name of the event to fire.

  • args?: Array<any> optional

    Array Arguments to pass to handers.

  • fn?: any optional

    Function Action.

  • scope?: any optional

    Object Scope of fn.

Returns

any

Object

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

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

Parameters

  • eventName: string

    String The name of the event to fire.

  • args?: Array<any> optional

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

Returns

boolean

Boolean Returns false if any of the handlers return false.

optional public getAfter(): any

[Method] Returns the value of after

Returns

any

Object

optional public getBefore(): any

[Method] Returns the value of before

Returns

any

Object

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getDelay(): number

[Method] Returns the value of delay

Returns

number

Number

optional public getDirection(): string

[Method] Returns the value of direction

Returns

string

String

optional public getDuration(): number

[Method] Returns the value of duration

Returns

number

Number

optional public getEasing(): string

[Method] Returns the value of easing

Returns

string

String

optional public getElement(): any

[Method] Returns the value of element

Returns

any

Object

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

[Method] Returns the value of iteration

Returns

number

Number

optional public getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getName(): string

[Method] Returns the value of name

Returns

string

String

optional public getOnBeforeEnd(): any

[Method] Returns the value of onBeforeEnd

Returns

any

Object

optional public getOnBeforeStart(): any

[Method] Returns the value of onBeforeStart

Returns

any

Object

optional public getOnEnd(): any

[Method] Returns the value of onEnd

Returns

any

Object

optional public getOut(): boolean

[Method] Returns the value of out

Returns

boolean

Boolean

optional public getPreserveEndState(): boolean

[Method] Returns the value of preserveEndState

Returns

boolean

Boolean

optional public getReplacePrevious(): boolean

[Method] Returns the value of replacePrevious

Returns

boolean

Boolean

optional public getReverse(): any

[Method] Returns the value of reverse

Returns

any

Object

optional public getScope(): any

[Method] Returns the value of scope

Returns

any

Object

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 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 mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

  • object?: any optional

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

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

  • options?: any optional

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

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

[Method] Alias for removeManagedListener

Parameters

  • object?: any optional

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

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

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

[Method] Alias for addListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

  • options?: any optional

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

  • order?: string optional

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

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

[Method] Alias for addAfterListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

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

[Method] Alias for addBeforeListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public 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 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 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 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 resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

optional public setAfter(after?: any)

[Method] Sets the value of after

Parameters

  • after?: any optional

    Object

optional public setBefore(before?: any)

[Method] Sets the value of before

Parameters

  • before?: any optional

    Object

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[]

optional public setDelay(delay?: number)

[Method] Sets the value of delay

Parameters

  • delay?: number optional

    Number

optional public setDirection(direction?: string)

[Method] Sets the value of direction

Parameters

  • direction?: string optional

    String

optional public setDuration(duration?: number)

[Method] Sets the value of duration

Parameters

  • duration?: number optional

    Number

optional public setEasing(easing?: string)

[Method] Sets the value of easing

Parameters

  • easing?: string optional

    String

optional public setElement(element?: any)

[Method] Sets the value of element

Parameters

  • element?: any optional

    Object

optional public setIteration(iteration?: number)

[Method] Sets the value of iteration

Parameters

  • iteration?: number optional

    Number

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object

optional public setName(name?: string)

[Method] Sets the value of name

Parameters

  • name?: string optional

    String

optional public setOnBeforeEnd(onBeforeEnd?: any)

[Method] Sets the value of onBeforeEnd

Parameters

  • onBeforeEnd?: any optional

    Object

optional public setOnBeforeStart(onBeforeStart?: any)

[Method] Sets the value of onBeforeStart

Parameters

  • onBeforeStart?: any optional

    Object

optional public setOnEnd(onEnd?: any)

[Method] Sets the value of onEnd

Parameters

  • onEnd?: any optional

    Object

optional public setOut(out?: boolean)

[Method] Sets the value of out

Parameters

  • out?: boolean optional

    Boolean

optional public setPreserveEndState(preserveEndState?: boolean)

[Method] Sets the value of preserveEndState

Parameters

  • preserveEndState?: boolean optional

    Boolean

optional public setReplacePrevious(replacePrevious?: boolean)

[Method] Sets the value of replacePrevious

Parameters

  • replacePrevious?: boolean optional

    Boolean

optional public setReverse(reverse?: any)

[Method] Sets the value of reverse

Parameters

  • reverse?: any optional

    Object

optional public setScope(scope?: any)

[Method] Sets the value of scope

Parameters

  • scope?: any optional

    Object

optional public suspendEvents()

[Method] Suspends the firing of all events

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

[Method] Alias for removeListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

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

  • scope?: any optional

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

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

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

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

[Method] Alias for removeAfterListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

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

[Method] Alias for removeBeforeListener

Parameters

  • eventName?: any optional

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

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.