X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..refs/heads/master:/docs/api/Ext.util.Point.html diff --git a/docs/api/Ext.util.Point.html b/docs/api/Ext.util.Point.html deleted file mode 100644 index f6b7e150..00000000 --- a/docs/api/Ext.util.Point.html +++ /dev/null @@ -1,192 +0,0 @@ -Ext.util.Point | Ext JS 4.0 Documentation -
For up to date documentation and features, visit -http://docs.sencha.com/ext-js/4-0

Sencha Documentation

- - - - - -

Hierarchy

Ext.util.Region
Ext.util.Point

Represents a 2D point with x and y properties, useful for comparison and instantiation -from an event:

- -
var point = Ext.util.Point.fromEvent(e);
-
- -
Defined By

Properties

 

Translate this region by the given offset amount. TODO: Either use translate or translateBy!

-

Translate this region by the given offset amount. TODO: Either use translate or translateBy!

-
Defined By

Methods

 
Point( -Number top, Number right, Number bottom, Number left) - : void

 

-

Parameters

  • top : Number

    Top

    -
  • right : Number

    Right

    -
  • bottom : Number

    Bottom

    -
  • left : Number

    Left

    -

Returns

  • void    -
 
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    -
 
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    -
 
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    -
 

Copy a new instance

-

Copy a new instance

-

Returns

  • Ext.util.Region    -
 
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

    -
 
equals( -Ext.util.Point/Object The) - : Boolean

Compare this point and another point

-

Compare this point and another point

-

Parameters

  • The : Ext.util.Point/Object

    point to compare with, either an instance -of Ext.util.Point or an object with left and top properties

    -

Returns

  • Boolean   

    Returns whether they are equivalent

    -
 
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

    -
 

Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event

-

Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event

-

Parameters

  • e : Event

    The event

    -

Returns

  • void   

    Ext.util.Point

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

Get the offset amount on the x-axis

-

Get the offset amount on the x-axis

-

Parameters

  • p : Number

    the offset

    -

Returns

  • Number    -
 

Get the offset amount on the y-axis

-

Get the offset amount on the y-axis

-

Parameters

  • p : Number

    the offset

    -

Returns

  • Number    -
 
getRegion( -Mixed el) - : Ext.util.Region

 

-

Parameters

  • el : Mixed

    A string, DomElement or Ext.core.Element representing an element -on the page.

    -

Returns

  • Ext.util.Region   

    region -Retrieves an Ext.util.Region for a particular element.

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

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

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    -
 

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    -
 
isWithin( -Ext.util.Point/Object The, Object/Number threshold) - : Boolean

Whether the given point is not away from this point within the given threshold amount. -TODO: Rename this isNear.

-

Whether the given point is not away from this point within the given threshold amount. -TODO: Rename this isNear.

-

Parameters

  • The : Ext.util.Point/Object

    point to check with, either an instance -of Ext.util.Point or an object with left and top properties

    -
  • threshold : Object/Number

    Can be either an object with x and y properties or a number

    -

Returns

  • Boolean    -
 

Round all the properties of this region

-

Round all the properties of this region

-

Returns

  • Ext.util.Region   

    this This Region

    -
 
roundedEquals( -Ext.util.Point/Object The) - : Boolean
Compare this point with another point when the x and y values of both points are rounded. E.g: -[100.3,199.8] will equ...

Compare this point with another point when the x and y values of both points are rounded. E.g: -[100.3,199.8] will equals to [100, 200]

-

Parameters

  • The : Ext.util.Point/Object

    point to compare with, either an instance -of Ext.util.Point or an object with x and y properties

    -

Returns

  • Boolean    -
 

Returns a human-eye-friendly string that represents this point, -useful for debugging

-

Returns a human-eye-friendly string that represents this point, -useful for debugging

-

Returns

  • String    -
 
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

    -
 
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    -
\ No newline at end of file