Sencha Documentation

Ext.util.Region

Overview
Report a bug
Represents a rectangular region and provides a number of utility methods to compare regions.
Defined By

Methods

 
Ext.util.Region
view source
Ext.util.Region.from( Object o) : Ext.util.Region

Parameters

  • o : Object
    An object with top, right, bottom, left properties

Returns

  • Ext.util.Region   region The region constructed based on the passed object
 
Ext.util.Region
view source
Ext.util.Region.getRegion( Mixed el) : Void

Parameters

  • el : Mixed
    A string, DomElement or Ext.core.Element representing an element on the page.

Returns

  • Void
 
Ext.util.Region
view source
adjust( Number top, Number right, Number bottom, Number left) : Void
Modifies the current region to be adjusted by offsets.
Modifies the current region to be adjusted by offsets.

Parameters

  • top : Number
    top offset
  • right : Number
    right offset
  • bottom : Number
    bottom offset
  • left : Number
    left offset

Returns

  • Void
 
Ext.util.Region
view source
constrainTo( Ext.util.Region targetRegion) : Void
Modifies the current region to be constrained to the targetRegion.
Modifies the current region to be constrained to the targetRegion.

Parameters

  • targetRegion : Ext.util.Region

Returns

  • Void
 
Ext.util.Region
view source
constructor( Number top, Number right, Number bottom, Number left) : Void

Parameters

  • top : Number
    Top
  • right : Number
    Right
  • bottom : Number
    Bottom
  • left : Number
    Left

Returns

  • Void
 
Ext.util.Region
view source
contains( Ext.util.Region region) : Void
Checks if this region completely contains the region that is passed in.
Checks if this region completely contains the region that is passed in.

Parameters

  • region : Ext.util.Region

Returns

  • Void
 
Ext.util.Region
view source
copy : Ext.util.Region
Copy a new instance
Copy a new instance

Returns

  • Ext.util.Region
 
Ext.util.Region
view source
copyFrom( Region The) : Ext.util.Point
Copy the values of another Region to this Region
Copy the values of another Region to this Region

Parameters

  • The : Region
    region to copy from.

Returns

  • Ext.util.Point   this This point
 
Ext.util.Region
view source
equals( Ext.util.Region region) : Boolean
Check whether this region is equivalent to the given region
Check whether this region is equivalent to the given region

Parameters

  • region : Ext.util.Region
    The region to compare with

Returns

  • Boolean
 
Ext.util.Region
view source
getOutOfBoundOffset( String axis, Ext.util.Point p) : Ext.util.Offset
Get the offset amount of a point outside the region
Get the offset amount of a point outside the region

Parameters

  • axis : String
    optional
  • p : Ext.util.Point
    the point

Returns

  • Ext.util.Offset
 
Ext.util.Region
view source
getOutOfBoundOffsetX( Number p) : Number
Get the offset amount on the x-axis
Get the offset amount on the x-axis

Parameters

  • p : Number
    the offset

Returns

  • Number
 
Ext.util.Region
view source
getOutOfBoundOffsetY( Number p) : Number
Get the offset amount on the y-axis
Get the offset amount on the y-axis

Parameters

  • p : Number
    the offset

Returns

  • Number
 
Ext.util.Region
view source
intersect( Ext.util.Region region) : Ext.util.Region/Boolean
Checks if this region intersects the region passed in.
Checks if this region intersects the region passed in.

Parameters

  • region : Ext.util.Region

Returns

  • Ext.util.Region/Boolean   Returns the intersected region or false if there is no intersection.
 
Ext.util.Region
view source
isOutOfBound( String axis, Ext.util.Point/Number p) : Boolean
Check whether the point / offset is out of bound
Check whether the point / offset is out of bound

Parameters

  • axis : String
    optional
  • p : Ext.util.Point/Number
    the point / offset

Returns

  • Boolean
 
Ext.util.Region
view source
isOutOfBoundX( Number p) : Boolean
Check whether the offset is out of bound in the x-axis
Check whether the offset is out of bound in the x-axis

Parameters

  • p : Number
    the offset

Returns

  • Boolean
 
Ext.util.Region
view source
isOutOfBoundY( Number p) : Boolean
Check whether the offset is out of bound in the y-axis
Check whether the offset is out of bound in the y-axis

Parameters

  • p : Number
    the offset

Returns

  • Boolean
 
Ext.util.Region
view source
round : Ext.util.Region
Round all the properties of this region
Round all the properties of this region

Returns

  • Ext.util.Region   this This Region
 
Ext.util.Region
view source
toString : String
Dump this to an eye-friendly string, great for debugging
Dump this to an eye-friendly string, great for debugging

Returns

  • String
 
Ext.util.Region
view source
translateBy( Ext.util.Offset/Object offset, Number The) : Ext.util.Region
Translate this region by the given offset amount
Translate this region by the given offset amount

Parameters

  • offset : Ext.util.Offset/Object
    Object containing the x and y properties. Or the x value is using the two argument form.
  • The : Number
    y value unless using an Offset object.

Returns

  • Ext.util.Region   this This Region
 
Ext.util.Region
view source
union( Ext.util.Region region) : Void
Returns the smallest region that contains the current AND targetRegion.
Returns the smallest region that contains the current AND targetRegion.

Parameters

  • region : Ext.util.Region

Returns

  • Void
© 2011 Sencha Inc.