Interface IRegion

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public extend?: string

[Config Option] (String)

optional public inheritableStatics?: 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 adjust(top?: number, right?: number, bottom?: number, left?: number): IRegion

[Method] Modifies the current region to be adjusted by offsets

Parameters

  • top?: number optional

    Number Top offset

  • right?: number optional

    Number Right offset

  • bottom?: number optional

    Number Bottom offset

  • left?: number optional

    Number Left offset

Returns

IRegion

Ext.util.Region 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 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 constrainTo(targetRegion?: IRegion): IRegion

[Method] Modifies the current region to be constrained to the targetRegion

Parameters

  • targetRegion?: IRegion optional

    Ext.util.Region

Returns

IRegion

Ext.util.Region this

optional public contains(region?: IRegion): boolean

[Method] Checks if this region completely contains the region that is passed in

Parameters

  • region?: IRegion optional

    Ext.util.Region

Returns

boolean

Boolean

optional public copy(): IRegion

[Method] Copy a new instance

Returns

IRegion

Ext.util.Region

optional public destroy()

[Method]

optional public equals(region?: IRegion): boolean

[Method] Check whether this region is equivalent to the given region

Parameters

  • region?: IRegion optional

    Ext.util.Region The region to compare with.

Returns

boolean

Boolean

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 getOutOfBoundOffset(axis?: any, p?: IPoint): IRegion

[Method] Get the offset amount of a point outside the region

Parameters

  • axis?: any optional

    String/Object optional.

  • p?: IPoint optional

    Ext.util.Point The point.

Returns

IRegion

Ext.util.Region

optional public getOutOfBoundOffsetX(p?: number): number

[Method] Get the offset amount on the x axis

Parameters

  • p?: number optional

    Number The offset.

Returns

number

Number

optional public getOutOfBoundOffsetY(p?: number): number

[Method] Get the offset amount on the y axis

Parameters

  • p?: number optional

    Number The offset.

Returns

number

Number

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 intersect(region?: IRegion): any

[Method] Checks if this region intersects the region passed in

Parameters

  • region?: IRegion optional

    Ext.util.Region

Returns

any

Ext.util.Region/Boolean Returns the intersected region or false if there is no intersection.

optional public isOutOfBound(axis?: string, p?: any): boolean

[Method] Check whether the point offset is out of bounds

Parameters

  • axis?: string optional

    String optional

  • p?: any optional

    Ext.util.Point/Number The point / offset.

Returns

boolean

Boolean

optional public isOutOfBoundX(p?: number): boolean

[Method] Check whether the offset is out of bound in the x axis

Parameters

  • p?: number optional

    Number The offset.

Returns

boolean

Boolean

optional public isOutOfBoundY(p?: number): boolean

[Method] Check whether the offset is out of bound in the y axis

Parameters

  • p?: number optional

    Number The offset.

Returns

boolean

Boolean

optional public round(): IRegion

[Method] Round all the properties of this region

Returns

IRegion

Ext.util.Region This Region.

optional public toString(): string

[Method] Dump this to an eye friendly string great for debugging

Returns

string

String For example Region[0,1,3,2].

optional public translateBy(offset?: any): IRegion

[Method] Translate this region by the given offset amount

Parameters

  • offset?: any optional

    Object

Returns

IRegion

Ext.util.Region This Region.

optional public union(region?: IRegion): IRegion

[Method] Returns the smallest region that contains the current AND targetRegion

Parameters

  • region?: IRegion optional

    Ext.util.Region

Returns

IRegion

Ext.util.Region