Upgrade to ExtJS 4.0.1 - Released 05/18/2011
[extjs.git] / docs / output / Ext.util.Point.js
1 Ext.data.JsonP.Ext_util_Point({
2   "tagname": "class",
3   "name": "Ext.util.Point",
4   "doc": "<p>Represents a 2D point with x and y properties, useful for comparison and instantiation\nfrom an event:</p>\n\n<pre><code>var point = Ext.util.Point.fromEvent(e);\n</code></pre>\n\n",
5   "extends": "Ext.util.Region",
6   "mixins": [
7
8   ],
9   "alternateClassNames": [
10
11   ],
12   "xtype": null,
13   "author": null,
14   "docauthor": null,
15   "singleton": false,
16   "private": false,
17   "cfg": [
18
19   ],
20   "method": [
21     {
22       "tagname": "method",
23       "name": "Point",
24       "member": "Ext.util.Region",
25       "doc": "\n",
26       "params": [
27         {
28           "type": "Number",
29           "name": "top",
30           "doc": "<p>Top</p>\n",
31           "optional": false
32         },
33         {
34           "type": "Number",
35           "name": "right",
36           "doc": "<p>Right</p>\n",
37           "optional": false
38         },
39         {
40           "type": "Number",
41           "name": "bottom",
42           "doc": "<p>Bottom</p>\n",
43           "optional": false
44         },
45         {
46           "type": "Number",
47           "name": "left",
48           "doc": "<p>Left</p>\n",
49           "optional": false
50         }
51       ],
52       "return": {
53         "type": "void",
54         "doc": "\n"
55       },
56       "private": false,
57       "static": false,
58       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
59       "linenr": 39,
60       "html_filename": "Region.html",
61       "href": "Region.html#Ext-util-Region-method-constructor",
62       "shortDoc": "\n"
63     },
64     {
65       "tagname": "method",
66       "name": "adjust",
67       "member": "Ext.util.Region",
68       "doc": "<p>Modifies the current region to be adjusted by offsets.</p>\n",
69       "params": [
70         {
71           "type": "Number",
72           "name": "top",
73           "doc": "<p>top offset</p>\n",
74           "optional": false
75         },
76         {
77           "type": "Number",
78           "name": "right",
79           "doc": "<p>right offset</p>\n",
80           "optional": false
81         },
82         {
83           "type": "Number",
84           "name": "bottom",
85           "doc": "<p>bottom offset</p>\n",
86           "optional": false
87         },
88         {
89           "type": "Number",
90           "name": "left",
91           "doc": "<p>left offset</p>\n",
92           "optional": false
93         }
94       ],
95       "return": {
96         "type": "void",
97         "doc": "\n"
98       },
99       "private": false,
100       "static": false,
101       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
102       "linenr": 115,
103       "html_filename": "Region.html",
104       "href": "Region.html#Ext-util-Region-method-adjust",
105       "shortDoc": "<p>Modifies the current region to be adjusted by offsets.</p>\n"
106     },
107     {
108       "tagname": "method",
109       "name": "constrainTo",
110       "member": "Ext.util.Region",
111       "doc": "<p>Modifies the current region to be constrained to the targetRegion.</p>\n",
112       "params": [
113         {
114           "type": "Ext.util.Region",
115           "name": "targetRegion",
116           "doc": "\n",
117           "optional": false
118         }
119       ],
120       "return": {
121         "type": "void",
122         "doc": "\n"
123       },
124       "private": false,
125       "static": false,
126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
127       "linenr": 101,
128       "html_filename": "Region.html",
129       "href": "Region.html#Ext-util-Region-method-constrainTo",
130       "shortDoc": "<p>Modifies the current region to be constrained to the targetRegion.</p>\n"
131     },
132     {
133       "tagname": "method",
134       "name": "contains",
135       "member": "Ext.util.Region",
136       "doc": "<p>Checks if this region completely contains the region that is passed in.</p>\n",
137       "params": [
138         {
139           "type": "Ext.util.Region",
140           "name": "region",
141           "doc": "\n",
142           "optional": false
143         }
144       ],
145       "return": {
146         "type": "void",
147         "doc": "\n"
148       },
149       "private": false,
150       "static": false,
151       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
152       "linenr": 54,
153       "html_filename": "Region.html",
154       "href": "Region.html#Ext-util-Region-method-contains",
155       "shortDoc": "<p>Checks if this region completely contains the region that is passed in.</p>\n"
156     },
157     {
158       "tagname": "method",
159       "name": "copy",
160       "member": "Ext.util.Region",
161       "doc": "<p>Copy a new instance</p>\n",
162       "params": [
163
164       ],
165       "return": {
166         "type": "Ext.util.Region",
167         "doc": "\n"
168       },
169       "private": false,
170       "static": false,
171       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
172       "linenr": 307,
173       "html_filename": "Region.html",
174       "href": "Region.html#Ext-util-Region-method-copy",
175       "shortDoc": "<p>Copy a new instance</p>\n"
176     },
177     {
178       "tagname": "method",
179       "name": "copyFrom",
180       "member": "Ext.util.Region",
181       "doc": "<p>Copy the values of another Region to this Region</p>\n",
182       "params": [
183         {
184           "type": "Region",
185           "name": "The",
186           "doc": "<p>region to copy from.</p>\n",
187           "optional": false
188         }
189       ],
190       "return": {
191         "type": "Ext.util.Point",
192         "doc": "<p>this This point</p>\n"
193       },
194       "private": false,
195       "static": false,
196       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
197       "linenr": 315,
198       "html_filename": "Region.html",
199       "href": "Region.html#Ext-util-Region-method-copyFrom",
200       "shortDoc": "<p>Copy the values of another Region to this Region</p>\n"
201     },
202     {
203       "tagname": "method",
204       "name": "equals",
205       "member": "Ext.util.Point",
206       "doc": "<p>Compare this point and another point</p>\n",
207       "params": [
208         {
209           "type": "Ext.util.Point/Object",
210           "name": "The",
211           "doc": "<p>point to compare with, either an instance\nof <a href=\"#/api/Ext.util.Point\" rel=\"Ext.util.Point\" class=\"docClass\">Ext.util.Point</a> or an object with left and top properties</p>\n",
212           "optional": false
213         }
214       ],
215       "return": {
216         "type": "Boolean",
217         "doc": "<p>Returns whether they are equivalent</p>\n"
218       },
219       "private": false,
220       "static": false,
221       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
222       "linenr": 46,
223       "html_filename": "Point.html",
224       "href": "Point.html#Ext-util-Point-method-equals",
225       "shortDoc": "<p>Compare this point and another point</p>\n"
226     },
227     {
228       "tagname": "method",
229       "name": "from",
230       "member": "Ext.util.Region",
231       "doc": "\n",
232       "params": [
233         {
234           "type": "Object",
235           "name": "o",
236           "doc": "<p>An object with top, right, bottom, left properties</p>\n",
237           "optional": false
238         }
239       ],
240       "return": {
241         "type": "Ext.util.Region",
242         "doc": "<p>region The region constructed based on the passed object</p>\n"
243       },
244       "private": false,
245       "static": true,
246       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
247       "linenr": 27,
248       "html_filename": "Region.html",
249       "href": "Region.html#Ext-util-Region-method-from",
250       "shortDoc": "\n"
251     },
252     {
253       "tagname": "method",
254       "name": "fromEvent",
255       "member": "Ext.util.Point",
256       "doc": "<p>Returns a new instance of <a href=\"#/api/Ext.util.Point\" rel=\"Ext.util.Point\" class=\"docClass\">Ext.util.Point</a> base on the pageX / pageY values of the given event</p>\n",
257       "params": [
258         {
259           "type": "Event",
260           "name": "e",
261           "doc": "<p>The event</p>\n",
262           "optional": false
263         }
264       ],
265       "return": {
266         "type": "void",
267         "doc": "<p>Ext.util.Point</p>\n"
268       },
269       "private": false,
270       "static": true,
271       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
272       "linenr": 19,
273       "html_filename": "Point.html",
274       "href": "Point.html#Ext-util-Point-method-fromEvent",
275       "shortDoc": "<p>Returns a new instance of <a href=\"#/api/Ext.util.Point\" rel=\"Ext.util.Point\" class=\"docClass\">Ext.util.Point</a> base on the pageX / pageY values of the given event</p>\n"
276     },
277     {
278       "tagname": "method",
279       "name": "getOutOfBoundOffset",
280       "member": "Ext.util.Region",
281       "doc": "<p>Get the offset amount of a point outside the region</p>\n",
282       "params": [
283         {
284           "type": "String",
285           "name": "axis",
286           "doc": "<p>optional</p>\n",
287           "optional": false
288         },
289         {
290           "type": "Ext.util.Point",
291           "name": "p",
292           "doc": "<p>the point</p>\n",
293           "optional": false
294         }
295       ],
296       "return": {
297         "type": "Ext.util.Offset",
298         "doc": "\n"
299       },
300       "private": false,
301       "static": false,
302       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
303       "linenr": 131,
304       "html_filename": "Region.html",
305       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffset",
306       "shortDoc": "<p>Get the offset amount of a point outside the region</p>\n"
307     },
308     {
309       "tagname": "method",
310       "name": "getOutOfBoundOffsetX",
311       "member": "Ext.util.Region",
312       "doc": "<p>Get the offset amount on the x-axis</p>\n",
313       "params": [
314         {
315           "type": "Number",
316           "name": "p",
317           "doc": "<p>the offset</p>\n",
318           "optional": false
319         }
320       ],
321       "return": {
322         "type": "Number",
323         "doc": "\n"
324       },
325       "private": false,
326       "static": false,
327       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
328       "linenr": 154,
329       "html_filename": "Region.html",
330       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetX",
331       "shortDoc": "<p>Get the offset amount on the x-axis</p>\n"
332     },
333     {
334       "tagname": "method",
335       "name": "getOutOfBoundOffsetY",
336       "member": "Ext.util.Region",
337       "doc": "<p>Get the offset amount on the y-axis</p>\n",
338       "params": [
339         {
340           "type": "Number",
341           "name": "p",
342           "doc": "<p>the offset</p>\n",
343           "optional": false
344         }
345       ],
346       "return": {
347         "type": "Number",
348         "doc": "\n"
349       },
350       "private": false,
351       "static": false,
352       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
353       "linenr": 169,
354       "html_filename": "Region.html",
355       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetY",
356       "shortDoc": "<p>Get the offset amount on the y-axis</p>\n"
357     },
358     {
359       "tagname": "method",
360       "name": "getRegion",
361       "member": "Ext.util.Region",
362       "doc": "\n",
363       "params": [
364         {
365           "type": "Mixed",
366           "name": "el",
367           "doc": "<p>A string, DomElement or <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> representing an element\non the page.</p>\n",
368           "optional": false
369         }
370       ],
371       "return": {
372         "type": "Ext.util.Region",
373         "doc": "<p>region\nRetrieves an <a href=\"#/api/Ext.util.Region\" rel=\"Ext.util.Region\" class=\"docClass\">Ext.util.Region</a> for a particular element.</p>\n"
374       },
375       "private": false,
376       "static": true,
377       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
378       "linenr": 16,
379       "html_filename": "Region.html",
380       "href": "Region.html#Ext-util-Region-method-getRegion",
381       "shortDoc": "\n"
382     },
383     {
384       "tagname": "method",
385       "name": "intersect",
386       "member": "Ext.util.Region",
387       "doc": "<p>Checks if this region intersects the region passed in.</p>\n",
388       "params": [
389         {
390           "type": "Ext.util.Region",
391           "name": "region",
392           "doc": "\n",
393           "optional": false
394         }
395       ],
396       "return": {
397         "type": "Ext.util.Region/Boolean",
398         "doc": "<p>Returns the intersected region or false if there is no intersection.</p>\n"
399       },
400       "private": false,
401       "static": false,
402       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
403       "linenr": 67,
404       "html_filename": "Region.html",
405       "href": "Region.html#Ext-util-Region-method-intersect",
406       "shortDoc": "<p>Checks if this region intersects the region passed in.</p>\n"
407     },
408     {
409       "tagname": "method",
410       "name": "isOutOfBound",
411       "member": "Ext.util.Region",
412       "doc": "<p>Check whether the point / offset is out of bound</p>\n",
413       "params": [
414         {
415           "type": "String",
416           "name": "axis",
417           "doc": "<p>optional</p>\n",
418           "optional": false
419         },
420         {
421           "type": "Ext.util.Point/Number",
422           "name": "p",
423           "doc": "<p>the point / offset</p>\n",
424           "optional": false
425         }
426       ],
427       "return": {
428         "type": "Boolean",
429         "doc": "\n"
430       },
431       "private": false,
432       "static": false,
433       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
434       "linenr": 184,
435       "html_filename": "Region.html",
436       "href": "Region.html#Ext-util-Region-method-isOutOfBound",
437       "shortDoc": "<p>Check whether the point / offset is out of bound</p>\n"
438     },
439     {
440       "tagname": "method",
441       "name": "isOutOfBoundX",
442       "member": "Ext.util.Region",
443       "doc": "<p>Check whether the offset is out of bound in the x-axis</p>\n",
444       "params": [
445         {
446           "type": "Number",
447           "name": "p",
448           "doc": "<p>the offset</p>\n",
449           "optional": false
450         }
451       ],
452       "return": {
453         "type": "Boolean",
454         "doc": "\n"
455       },
456       "private": false,
457       "static": false,
458       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
459       "linenr": 203,
460       "html_filename": "Region.html",
461       "href": "Region.html#Ext-util-Region-method-isOutOfBoundX",
462       "shortDoc": "<p>Check whether the offset is out of bound in the x-axis</p>\n"
463     },
464     {
465       "tagname": "method",
466       "name": "isOutOfBoundY",
467       "member": "Ext.util.Region",
468       "doc": "<p>Check whether the offset is out of bound in the y-axis</p>\n",
469       "params": [
470         {
471           "type": "Number",
472           "name": "p",
473           "doc": "<p>the offset</p>\n",
474           "optional": false
475         }
476       ],
477       "return": {
478         "type": "Boolean",
479         "doc": "\n"
480       },
481       "private": false,
482       "static": false,
483       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
484       "linenr": 212,
485       "html_filename": "Region.html",
486       "href": "Region.html#Ext-util-Region-method-isOutOfBoundY",
487       "shortDoc": "<p>Check whether the offset is out of bound in the y-axis</p>\n"
488     },
489     {
490       "tagname": "method",
491       "name": "isWithin",
492       "member": "Ext.util.Point",
493       "doc": "<p>Whether the given point is not away from this point within the given threshold amount.\nTODO: Rename this isNear.</p>\n",
494       "params": [
495         {
496           "type": "Ext.util.Point/Object",
497           "name": "The",
498           "doc": "<p>point to check with, either an instance\nof <a href=\"#/api/Ext.util.Point\" rel=\"Ext.util.Point\" class=\"docClass\">Ext.util.Point</a> or an object with left and top properties</p>\n",
499           "optional": false
500         },
501         {
502           "type": "Object/Number",
503           "name": "threshold",
504           "doc": "<p>Can be either an object with x and y properties or a number</p>\n",
505           "optional": false
506         }
507       ],
508       "return": {
509         "type": "Boolean",
510         "doc": "\n"
511       },
512       "private": false,
513       "static": false,
514       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
515       "linenr": 56,
516       "html_filename": "Point.html",
517       "href": "Point.html#Ext-util-Point-method-isWithin",
518       "shortDoc": "<p>Whether the given point is not away from this point within the given threshold amount.\nTODO: Rename this isNear.</p>\n"
519     },
520     {
521       "tagname": "method",
522       "name": "round",
523       "member": "Ext.util.Region",
524       "doc": "<p>Round all the properties of this region</p>\n",
525       "params": [
526
527       ],
528       "return": {
529         "type": "Ext.util.Region",
530         "doc": "<p>this This Region</p>\n"
531       },
532       "private": false,
533       "static": false,
534       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
535       "linenr": 360,
536       "html_filename": "Region.html",
537       "href": "Region.html#Ext-util-Region-method-round",
538       "shortDoc": "<p>Round all the properties of this region</p>\n"
539     },
540     {
541       "tagname": "method",
542       "name": "roundedEquals",
543       "member": "Ext.util.Point",
544       "doc": "<p>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]</p>\n",
545       "params": [
546         {
547           "type": "Ext.util.Point/Object",
548           "name": "The",
549           "doc": "<p>point to compare with, either an instance\nof <a href=\"#/api/Ext.util.Point\" rel=\"Ext.util.Point\" class=\"docClass\">Ext.util.Point</a> or an object with x and y properties</p>\n",
550           "optional": false
551         }
552       ],
553       "return": {
554         "type": "Boolean",
555         "doc": "\n"
556       },
557       "private": false,
558       "static": false,
559       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
560       "linenr": 76,
561       "html_filename": "Point.html",
562       "href": "Point.html#Ext-util-Point-method-roundedEquals",
563       "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..."
564     },
565     {
566       "tagname": "method",
567       "name": "toString",
568       "member": "Ext.util.Point",
569       "doc": "<p>Returns a human-eye-friendly string that represents this point,\nuseful for debugging</p>\n",
570       "params": [
571
572       ],
573       "return": {
574         "type": "String",
575         "doc": "\n"
576       },
577       "private": false,
578       "static": false,
579       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
580       "linenr": 37,
581       "html_filename": "Point.html",
582       "href": "Point.html#Ext-util-Point-method-toString",
583       "shortDoc": "<p>Returns a human-eye-friendly string that represents this point,\nuseful for debugging</p>\n"
584     },
585     {
586       "tagname": "method",
587       "name": "translate",
588       "member": "Ext.util.Point",
589       "doc": "<p>Translate this region by the given offset amount. TODO: Either use translate or translateBy!</p>\n",
590       "params": [
591         {
592           "type": "Ext.util.Offset/Object",
593           "name": "offset",
594           "doc": "<p>Object containing the <code>x</code> and <code>y</code> properties.\nOr the x value is using the two argument form.</p>\n",
595           "optional": false
596         },
597         {
598           "type": "Number",
599           "name": "The",
600           "doc": "<p>y value unless using an Offset object.</p>\n",
601           "optional": false
602         }
603       ],
604       "return": {
605         "type": "Ext.util.Region",
606         "doc": "<p>this This Region</p>\n"
607       },
608       "private": false,
609       "static": false,
610       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
611       "linenr": 87,
612       "html_filename": "Point.html",
613       "href": "Point.html#Ext-util-Point-method-translate",
614       "shortDoc": "<p>Translate this region by the given offset amount. TODO: Either use translate or translateBy!</p>\n"
615     },
616     {
617       "tagname": "method",
618       "name": "translateBy",
619       "member": "Ext.util.Region",
620       "doc": "<p>Translate this region by the given offset amount</p>\n",
621       "params": [
622         {
623           "type": "Ext.util.Offset/Object",
624           "name": "offset",
625           "doc": "<p>Object containing the <code>x</code> and <code>y</code> properties.\nOr the x value is using the two argument form.</p>\n",
626           "optional": false
627         },
628         {
629           "type": "Number",
630           "name": "The",
631           "doc": "<p>y value unless using an Offset object.</p>\n",
632           "optional": false
633         }
634       ],
635       "return": {
636         "type": "Ext.util.Region",
637         "doc": "<p>this This Region</p>\n"
638       },
639       "private": false,
640       "static": false,
641       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
642       "linenr": 339,
643       "html_filename": "Region.html",
644       "href": "Region.html#Ext-util-Region-method-translateBy",
645       "shortDoc": "<p>Translate this region by the given offset amount</p>\n"
646     },
647     {
648       "tagname": "method",
649       "name": "union",
650       "member": "Ext.util.Region",
651       "doc": "<p>Returns the smallest region that contains the current AND targetRegion.</p>\n",
652       "params": [
653         {
654           "type": "Ext.util.Region",
655           "name": "region",
656           "doc": "\n",
657           "optional": false
658         }
659       ],
660       "return": {
661         "type": "void",
662         "doc": "\n"
663       },
664       "private": false,
665       "static": false,
666       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
667       "linenr": 87,
668       "html_filename": "Region.html",
669       "href": "Region.html#Ext-util-Region-method-union",
670       "shortDoc": "<p>Returns the smallest region that contains the current AND targetRegion.</p>\n"
671     }
672   ],
673   "property": [
674
675   ],
676   "event": [
677
678   ],
679   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Point.js",
680   "linenr": 1,
681   "html_filename": "Point.html",
682   "href": "Point.html#Ext-util-Point",
683   "cssVar": [
684
685   ],
686   "cssMixin": [
687
688   ],
689   "component": false,
690   "superclasses": [
691     "Ext.util.Region"
692   ],
693   "subclasses": [
694
695   ],
696   "mixedInto": [
697
698   ],
699   "allMixins": [
700
701   ]
702 });