X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.util.Point.js diff --git a/docs/output/Ext.util.Point.js b/docs/output/Ext.util.Point.js index cfc7d56f..a6316f3f 100644 --- a/docs/output/Ext.util.Point.js +++ b/docs/output/Ext.util.Point.js @@ -1,702 +1,782 @@ Ext.data.JsonP.Ext_util_Point({ - "tagname": "class", - "name": "Ext.util.Point", - "doc": "
Represents a 2D point with x and y properties, useful for comparison and instantiation\nfrom an event:
\n\nvar point = Ext.util.Point.fromEvent(e);\n
\n\n",
- "extends": "Ext.util.Region",
- "mixins": [
-
- ],
- "alternateClassNames": [
+ "allMixins": [
],
- "xtype": null,
- "author": null,
+ "deprecated": null,
"docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
+ "members": {
+ "cfg": [
- ],
- "method": [
- {
- "tagname": "method",
- "name": "Point",
- "member": "Ext.util.Region",
- "doc": "\n",
- "params": [
- {
- "type": "Number",
- "name": "top",
- "doc": "Top
\n", - "optional": false - }, - { - "type": "Number", - "name": "right", - "doc": "Right
\n", - "optional": false - }, - { - "type": "Number", - "name": "bottom", - "doc": "Bottom
\n", - "optional": false + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Region.html#Ext-util-Region-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates a region from the bounding sides. ...", + "static": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "Top The topmost pixel of the Region.
\n", + "name": "top" + }, + { + "type": "Number", + "optional": false, + "doc": "Right The rightmost pixel of the Region.
\n", + "name": "right" + }, + { + "type": "Number", + "optional": false, + "doc": "Bottom The bottom pixel of the Region.
\n", + "name": "bottom" + }, + { + "type": "Number", + "optional": false, + "doc": "Left The leftmost pixel of the Region.
\n", + "name": "left" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "doc": "Creates a region from the bounding sides.
\n", + "owner": "Ext.util.Region", + "name": "Point", + "html_filename": "Region.html", + "return": { + "type": "Object", + "doc": "\n" }, - { - "type": "Number", - "name": "left", - "doc": "Left
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "linenr": 40 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 39, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "adjust", - "member": "Ext.util.Region", - "doc": "Modifies the current region to be adjusted by offsets.
\n", - "params": [ - { - "type": "Number", - "name": "top", - "doc": "top offset
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-adjust", + "shortDoc": "Modifies the current region to be adjusted by offsets. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "top offset
\n", + "name": "top" + }, + { + "type": "Number", + "optional": false, + "doc": "right offset
\n", + "name": "right" + }, + { + "type": "Number", + "optional": false, + "doc": "bottom offset
\n", + "name": "bottom" + }, + { + "type": "Number", + "optional": false, + "doc": "left offset
\n", + "name": "left" + } + ], + "name": "adjust", + "owner": "Ext.util.Region", + "doc": "Modifies the current region to be adjusted by offsets.
\n", + "linenr": 116, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "right", - "doc": "right offset
\n", - "optional": false + "html_filename": "Region.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-constrainTo", + "shortDoc": "Modifies the current region to be constrained to the targetRegion. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Ext.util.Region", + "optional": false, + "doc": "\n", + "name": "targetRegion" + } + ], + "name": "constrainTo", + "owner": "Ext.util.Region", + "doc": "Modifies the current region to be constrained to the targetRegion.
\n", + "linenr": 102, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "bottom", - "doc": "bottom offset
\n", - "optional": false + "html_filename": "Region.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-contains", + "shortDoc": "Checks if this region completely contains the region that is passed in. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Ext.util.Region", + "optional": false, + "doc": "\n", + "name": "region" + } + ], + "name": "contains", + "owner": "Ext.util.Region", + "doc": "Checks if this region completely contains the region that is passed in.
\n", + "linenr": 55, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "left", - "doc": "left offset
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 115, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-adjust", - "shortDoc": "Modifies the current region to be adjusted by offsets.
\n" - }, - { - "tagname": "method", - "name": "constrainTo", - "member": "Ext.util.Region", - "doc": "Modifies the current region to be constrained to the targetRegion.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-copy", + "shortDoc": "Create a copy of this Region. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + + ], + "name": "copy", + "owner": "Ext.util.Region", + "doc": "Create a copy of this Region.
\n", + "linenr": 308, + "return": { "type": "Ext.util.Region", - "name": "targetRegion", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 101, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-constrainTo", - "shortDoc": "Modifies the current region to be constrained to the targetRegion.
\n" - }, - { - "tagname": "method", - "name": "contains", - "member": "Ext.util.Region", - "doc": "Checks if this region completely contains the region that is passed in.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-copyFrom", + "shortDoc": "Copy the values of another Region to this Region ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Region", + "optional": false, + "doc": "region to copy from.
\n", + "name": "The" + } + ], + "name": "copyFrom", + "owner": "Ext.util.Region", + "doc": "Copy the values of another Region to this Region
\n", + "linenr": 316, + "return": { "type": "Ext.util.Region", - "name": "region", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 54, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-contains", - "shortDoc": "Checks if this region completely contains the region that is passed in.
\n" - }, - { - "tagname": "method", - "name": "copy", - "member": "Ext.util.Region", - "doc": "Copy a new instance
\n", - "params": [ - - ], - "return": { - "type": "Ext.util.Region", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 307, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-copy", - "shortDoc": "Copy a new instance
\n" - }, - { - "tagname": "method", - "name": "copyFrom", - "member": "Ext.util.Region", - "doc": "Copy the values of another Region to this Region
\n", - "params": [ - { - "type": "Region", - "name": "The", - "doc": "region to copy from.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Point", - "doc": "this This point
\n" + "doc": "This Region
\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 315, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-copyFrom", - "shortDoc": "Copy the values of another Region to this Region
\n" - }, - { - "tagname": "method", - "name": "equals", - "member": "Ext.util.Point", - "doc": "Compare this point and another point
\n", - "params": [ - { - "type": "Ext.util.Point/Object", - "name": "The", - "doc": "point to compare with, either an instance\nof Ext.util.Point or an object with left and top properties
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "Returns whether they are equivalent
\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Point.html#Ext-util-Point-method-equals", + "shortDoc": "Compare this point and another point ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "params": [ + { + "type": "Ext.util.Point/Object", + "optional": false, + "doc": "point to compare with, either an instance\nof Ext.util.Point or an object with left and top properties
\n", + "name": "The" + } + ], + "name": "equals", + "owner": "Ext.util.Point", + "doc": "Compare this point and another point
\n", + "linenr": 46, + "return": { + "type": "Boolean", + "doc": "Returns whether they are equivalent
\n" + }, + "html_filename": "Point.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 46, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-equals", - "shortDoc": "Compare this point and another point
\n" - }, - { - "tagname": "method", - "name": "from", - "member": "Ext.util.Region", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "o", - "doc": "An object with top, right, bottom, left properties
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Region", - "doc": "region The region constructed based on the passed object
\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-from", + "shortDoc": "Creates a Region from a \"box\" Object which contains four numeric properties top, right, bottom and left. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "An object with top
, right
, bottom
and left
properties.
Creates a Region from a \"box\" Object which contains four numeric properties top
, right
, bottom
and left
.
region The Region constructed based on the passed object
\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 27, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-from", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "fromEvent", - "member": "Ext.util.Point", - "doc": "Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
\n", - "params": [ - { - "type": "Event", - "name": "e", - "doc": "The event
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "Ext.util.Point
\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Point.html#Ext-util-Point-method-fromEvent", + "shortDoc": "Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "params": [ + { + "type": "Event", + "optional": false, + "doc": "The event
\n", + "name": "e" + } + ], + "name": "fromEvent", + "owner": "Ext.util.Point", + "doc": "Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
\n", + "linenr": 19, + "return": { + "type": "void", + "doc": "Ext.util.Point
\n" + }, + "html_filename": "Point.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 19, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-fromEvent", - "shortDoc": "Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
\n" - }, - { - "tagname": "method", - "name": "getOutOfBoundOffset", - "member": "Ext.util.Region", - "doc": "Get the offset amount of a point outside the region
\n", - "params": [ - { - "type": "String", - "name": "axis", - "doc": "optional
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffset", + "shortDoc": "Get the offset amount of a point outside the region ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "optional
\n", + "name": "axis" + }, + { + "type": "Ext.util.Point", + "optional": false, + "doc": "the point
\n", + "name": "p" + } + ], + "name": "getOutOfBoundOffset", + "owner": "Ext.util.Region", + "doc": "Get the offset amount of a point outside the region
\n", + "linenr": 132, + "return": { + "type": "Ext.util.Offset", + "doc": "\n" }, - { - "type": "Ext.util.Point", - "name": "p", - "doc": "the point
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Offset", - "doc": "\n" + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 131, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffset", - "shortDoc": "Get the offset amount of a point outside the region
\n" - }, - { - "tagname": "method", - "name": "getOutOfBoundOffsetX", - "member": "Ext.util.Region", - "doc": "Get the offset amount on the x-axis
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetX", + "shortDoc": "Get the offset amount on the x-axis ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "the offset
\n", + "name": "p" + } + ], + "name": "getOutOfBoundOffsetX", + "owner": "Ext.util.Region", + "doc": "Get the offset amount on the x-axis
\n", + "linenr": 155, + "return": { "type": "Number", - "name": "p", - "doc": "the offset
\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "\n" + "doc": "\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 154, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetX", - "shortDoc": "Get the offset amount on the x-axis
\n" - }, - { - "tagname": "method", - "name": "getOutOfBoundOffsetY", - "member": "Ext.util.Region", - "doc": "Get the offset amount on the y-axis
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetY", + "shortDoc": "Get the offset amount on the y-axis ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "the offset
\n", + "name": "p" + } + ], + "name": "getOutOfBoundOffsetY", + "owner": "Ext.util.Region", + "doc": "Get the offset amount on the y-axis
\n", + "linenr": 170, + "return": { "type": "Number", - "name": "p", - "doc": "the offset
\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 169, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetY", - "shortDoc": "Get the offset amount on the y-axis
\n" - }, - { - "tagname": "method", - "name": "getRegion", - "member": "Ext.util.Region", - "doc": "\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "A string, DomElement or Ext.core.Element representing an element\non the page.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Region", - "doc": "region\nRetrieves an Ext.util.Region for a particular element.
\n" + "doc": "\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 16, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-getRegion", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "intersect", - "member": "Ext.util.Region", - "doc": "Checks if this region intersects the region passed in.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-getRegion", + "shortDoc": "Retrieves an Ext.util.Region for a particular element. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "An element ID, htmlElement or Ext.core.Element representing an element in the document.
\n", + "name": "el" + } + ], + "name": "getRegion", + "owner": "Ext.util.Region", + "doc": "Retrieves an Ext.util.Region for a particular element.
\n", + "linenr": 17, + "return": { "type": "Ext.util.Region", - "name": "region", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Region/Boolean", - "doc": "Returns the intersected region or false if there is no intersection.
\n" + "doc": "region
\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 67, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-intersect", - "shortDoc": "Checks if this region intersects the region passed in.
\n" - }, - { - "tagname": "method", - "name": "isOutOfBound", - "member": "Ext.util.Region", - "doc": "Check whether the point / offset is out of bound
\n", - "params": [ - { - "type": "String", - "name": "axis", - "doc": "optional
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-intersect", + "shortDoc": "Checks if this region intersects the region passed in. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Ext.util.Region", + "optional": false, + "doc": "\n", + "name": "region" + } + ], + "name": "intersect", + "owner": "Ext.util.Region", + "doc": "Checks if this region intersects the region passed in.
\n", + "linenr": 68, + "return": { + "type": "Ext.util.Region/Boolean", + "doc": "Returns the intersected region or false if there is no intersection.
\n" }, - { - "type": "Ext.util.Point/Number", - "name": "p", - "doc": "the point / offset
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 184, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-isOutOfBound", - "shortDoc": "Check whether the point / offset is out of bound
\n" - }, - { - "tagname": "method", - "name": "isOutOfBoundX", - "member": "Ext.util.Region", - "doc": "Check whether the offset is out of bound in the x-axis
\n", - "params": [ - { - "type": "Number", - "name": "p", - "doc": "the offset
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-isOutOfBound", + "shortDoc": "Check whether the point / offset is out of bound ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "optional
\n", + "name": "axis" + }, + { + "type": "Ext.util.Point/Number", + "optional": false, + "doc": "the point / offset
\n", + "name": "p" + } + ], + "name": "isOutOfBound", + "owner": "Ext.util.Region", + "doc": "Check whether the point / offset is out of bound
\n", + "linenr": 185, + "return": { + "type": "Boolean", + "doc": "\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 203, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-isOutOfBoundX", - "shortDoc": "Check whether the offset is out of bound in the x-axis
\n" - }, - { - "tagname": "method", - "name": "isOutOfBoundY", - "member": "Ext.util.Region", - "doc": "Check whether the offset is out of bound in the y-axis
\n", - "params": [ - { - "type": "Number", - "name": "p", - "doc": "the offset
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-isOutOfBoundX", + "shortDoc": "Check whether the offset is out of bound in the x-axis ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "the offset
\n", + "name": "p" + } + ], + "name": "isOutOfBoundX", + "owner": "Ext.util.Region", + "doc": "Check whether the offset is out of bound in the x-axis
\n", + "linenr": 204, + "return": { + "type": "Boolean", + "doc": "\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 212, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-isOutOfBoundY", - "shortDoc": "Check whether the offset is out of bound in the y-axis
\n" - }, - { - "tagname": "method", - "name": "isWithin", - "member": "Ext.util.Point", - "doc": "Whether the given point is not away from this point within the given threshold amount.\nTODO: Rename this isNear.
\n", - "params": [ - { - "type": "Ext.util.Point/Object", - "name": "The", - "doc": "point to check with, either an instance\nof Ext.util.Point or an object with left and top properties
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-isOutOfBoundY", + "shortDoc": "Check whether the offset is out of bound in the y-axis ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "the offset
\n", + "name": "p" + } + ], + "name": "isOutOfBoundY", + "owner": "Ext.util.Region", + "doc": "Check whether the offset is out of bound in the y-axis
\n", + "linenr": 213, + "return": { + "type": "Boolean", + "doc": "\n" }, - { - "type": "Object/Number", - "name": "threshold", - "doc": "Can be either an object with x and y properties or a number
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 56, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-isWithin", - "shortDoc": "Whether the given point is not away from this point within the given threshold amount.\nTODO: Rename this isNear.
\n" - }, - { - "tagname": "method", - "name": "round", - "member": "Ext.util.Region", - "doc": "Round all the properties of this region
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Point.html#Ext-util-Point-method-isWithin", + "shortDoc": "Whether the given point is not away from this point within the given threshold amount. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "params": [ + { + "type": "Ext.util.Point/Object", + "optional": false, + "doc": "point to check with, either an instance\nof Ext.util.Point or an object with left and top properties
\n", + "name": "The" + }, + { + "type": "Object/Number", + "optional": false, + "doc": "Can be either an object with x and y properties or a number
\n", + "name": "threshold" + } + ], + "name": "isWithin", + "owner": "Ext.util.Point", + "doc": "Whether the given point is not away from this point within the given threshold amount.\nTODO: Rename this isNear.
\n", + "linenr": 56, + "return": { + "type": "Boolean", + "doc": "\n" + }, + "html_filename": "Point.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-round", + "shortDoc": "Round all the properties of this region ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.util.Region", - "doc": "this This Region
\n" + ], + "name": "round", + "owner": "Ext.util.Region", + "doc": "Round all the properties of this region
\n", + "linenr": 360, + "return": { + "type": "Ext.util.Region", + "doc": "this This Region
\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 360, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-round", - "shortDoc": "Round all the properties of this region
\n" - }, - { - "tagname": "method", - "name": "roundedEquals", - "member": "Ext.util.Point", - "doc": "Compare this point with another point when the x and y values of both points are rounded. E.g:\n[100.3,199.8] will equals to [100, 200]
\n", - "params": [ - { - "type": "Ext.util.Point/Object", - "name": "The", - "doc": "point to compare with, either an instance\nof Ext.util.Point or an object with x and y properties
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Point.html#Ext-util-Point-method-roundedEquals", + "shortDoc": "Compare this point with another point when the x and y values of both points are rounded. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "params": [ + { + "type": "Ext.util.Point/Object", + "optional": false, + "doc": "point to compare with, either an instance\nof Ext.util.Point or an object with x and y properties
\n", + "name": "The" + } + ], + "name": "roundedEquals", + "owner": "Ext.util.Point", + "doc": "Compare this point with another point when the x and y values of both points are rounded. E.g:\n[100.3,199.8] will equals to [100, 200]
\n", + "linenr": 76, + "return": { + "type": "Boolean", + "doc": "\n" + }, + "html_filename": "Point.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 76, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-roundedEquals", - "shortDoc": "Compare this point with another point when the x and y values of both points are rounded. E.g:\n[100.3,199.8] will equ..." - }, - { - "tagname": "method", - "name": "toString", - "member": "Ext.util.Point", - "doc": "Returns a human-eye-friendly string that represents this point,\nuseful for debugging
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Point.html#Ext-util-Point-method-toString", + "shortDoc": "Returns a human-eye-friendly string that represents this point,\nuseful for debugging ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "params": [ - ], - "return": { - "type": "String", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 37, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-toString", - "shortDoc": "Returns a human-eye-friendly string that represents this point,\nuseful for debugging
\n" - }, - { - "tagname": "method", - "name": "translate", - "member": "Ext.util.Point", - "doc": "Translate this region by the given offset amount. TODO: Either use translate or translateBy!
\n", - "params": [ - { - "type": "Ext.util.Offset/Object", - "name": "offset", - "doc": "Object containing the x
and y
properties.\nOr the x value is using the two argument form.
Returns a human-eye-friendly string that represents this point,\nuseful for debugging
\n", + "linenr": 37, + "return": { + "type": "String", + "doc": "\n" }, - { - "type": "Number", - "name": "The", - "doc": "y value unless using an Offset object.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Region", - "doc": "this This Region
\n" + "html_filename": "Point.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 87, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point-method-translate", - "shortDoc": "Translate this region by the given offset amount. TODO: Either use translate or translateBy!
\n" - }, - { - "tagname": "method", - "name": "translateBy", - "member": "Ext.util.Region", - "doc": "Translate this region by the given offset amount
\n", - "params": [ - { - "type": "Ext.util.Offset/Object", - "name": "offset", - "doc": "Object containing the x
and y
properties.\nOr the x value is using the two argument form.
Object containing the x
and y
properties.\nOr the x value is using the two argument form.
y value unless using an Offset object.
\n", + "name": "The" + } + ], + "name": "translate", + "owner": "Ext.util.Point", + "doc": "Translate this region by the given offset amount. TODO: Either use translate or translateBy!
\n", + "linenr": 87, + "return": { + "type": "Ext.util.Region", + "doc": "this This Region
\n" }, - { - "type": "Number", - "name": "The", - "doc": "y value unless using an Offset object.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.util.Region", - "doc": "this This Region
\n" + "html_filename": "Point.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 339, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-translateBy", - "shortDoc": "Translate this region by the given offset amount
\n" - }, - { - "tagname": "method", - "name": "union", - "member": "Ext.util.Region", - "doc": "Returns the smallest region that contains the current AND targetRegion.
\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-translateBy", + "shortDoc": "Translate this region by the given offset amount ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Ext.util.Offset/Object", + "optional": false, + "doc": "Object containing the x
and y
properties.\nOr the x value is using the two argument form.
y value unless using an Offset object.
\n", + "name": "The" + } + ], + "name": "translateBy", + "owner": "Ext.util.Region", + "doc": "Translate this region by the given offset amount
\n", + "linenr": 339, + "return": { "type": "Ext.util.Region", - "name": "region", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "this This Region
\n" + }, + "html_filename": "Region.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", - "linenr": 87, - "html_filename": "Region.html", - "href": "Region.html#Ext-util-Region-method-union", - "shortDoc": "Returns the smallest region that contains the current AND targetRegion.
\n" - } - ], - "property": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Region.html#Ext-util-Region-method-union", + "shortDoc": "Returns the smallest region that contains the current AND targetRegion. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Region.js", + "private": false, + "params": [ + { + "type": "Ext.util.Region", + "optional": false, + "doc": "\n", + "name": "region" + } + ], + "name": "union", + "owner": "Ext.util.Region", + "doc": "Returns the smallest region that contains the current AND targetRegion.
\n", + "linenr": 88, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Region.html" + } + ], + "property": [ - ], - "event": [ + ], + "cssVar": [ - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js", - "linenr": 1, - "html_filename": "Point.html", - "href": "Point.html#Ext-util-Point", - "cssVar": [ + ], + "cssMixin": [ - ], - "cssMixin": [ + ], + "event": [ - ], - "component": false, + ] + }, + "singleton": false, + "alias": null, "superclasses": [ "Ext.util.Region" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Point.html#Ext-util-Point", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Point.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.util.Point", + "doc": "Represents a 2D point with x and y properties, useful for comparison and instantiation\nfrom an event:
\n\nvar point = Ext.util.Point.fromEvent(e);\n
\n\n",
"mixedInto": [
],
- "allMixins": [
+ "linenr": 1,
+ "xtypes": [
- ]
+ ],
+ "html_filename": "Point.html",
+ "extends": "Ext.util.Region"
});
\ No newline at end of file