X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.util.Region.js diff --git a/docs/output/Ext.util.Region.js b/docs/output/Ext.util.Region.js new file mode 100644 index 00000000..73b8550c --- /dev/null +++ b/docs/output/Ext.util.Region.js @@ -0,0 +1,590 @@ +Ext.data.JsonP.Ext_util_Region({ + "tagname": "class", + "name": "Ext.util.Region", + "doc": "
Represents a rectangular region and provides a number of utility methods\nto compare regions.
\n", + "extends": "Object", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "Region", + "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 + }, + { + "type": "Number", + "name": "left", + "doc": "Left
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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 + }, + { + "type": "Number", + "name": "right", + "doc": "right offset
\n", + "optional": false + }, + { + "type": "Number", + "name": "bottom", + "doc": "bottom offset
\n", + "optional": false + }, + { + "type": "Number", + "name": "left", + "doc": "left offset
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "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": [ + { + "type": "Ext.util.Region", + "name": "targetRegion", + "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": 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": [ + { + "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" + }, + "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.Region", + "doc": "Check whether this region is equivalent to the given region
\n", + "params": [ + { + "type": "Ext.util.Region", + "name": "region", + "doc": "The region to compare with
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", + "linenr": 374, + "html_filename": "Region.html", + "href": "Region.html#Ext-util-Region-method-equals", + "shortDoc": "Check whether this region is equivalent to the given region
\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" + }, + "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": "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 + }, + { + "type": "Ext.util.Point", + "name": "p", + "doc": "the point
\n", + "optional": false + } + ], + "return": { + "type": "Ext.util.Offset", + "doc": "\n" + }, + "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": [ + { + "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": 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": [ + { + "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" + }, + "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": [ + { + "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" + }, + "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 + }, + { + "type": "Ext.util.Point/Number", + "name": "p", + "doc": "the point / offset
\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "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" + }, + "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" + }, + "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": "round", + "member": "Ext.util.Region", + "doc": "Round all the properties of this region
\n", + "params": [ + + ], + "return": { + "type": "Ext.util.Region", + "doc": "this This Region
\n" + }, + "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": "toString", + "member": "Ext.util.Region", + "doc": "Dump this to an eye-friendly string, great for debugging
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", + "linenr": 330, + "html_filename": "Region.html", + "href": "Region.html#Ext-util-Region-method-toString", + "shortDoc": "Dump this to an eye-friendly string, great for debugging
\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.
y value unless using an Offset object.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.util.Region", + "doc": "this This Region
\n" + }, + "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": [ + { + "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": 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": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js", + "linenr": 1, + "html_filename": "Region.html", + "href": "Region.html#Ext-util-Region", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + "Ext.util.Point" + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file