docs/output/Ext.util.Region.js

   1 Ext.data.JsonP.Ext_util_Region({
   2   "tagname": "class",
   3   "name": "Ext.util.Region",
   4   "doc": "<p>Represents a rectangular region and provides a number of utility methods\nto compare regions.</p>\n",
   5   "extends": "Object",
   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": "Region",
  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.Region",
 206       "doc": "<p>Check whether this region is equivalent to the given region</p>\n",
 207       "params": [
 208         {
 209           "type": "Ext.util.Region",
 210           "name": "region",
 211           "doc": "<p>The region to compare with</p>\n",
 212           "optional": false
 213         }
 214       ],
 215       "return": {
 216         "type": "Boolean",
 217         "doc": "\n"
 218       },
 219       "private": false,
 220       "static": false,
 221       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 222       "linenr": 374,
 223       "html_filename": "Region.html",
 224       "href": "Region.html#Ext-util-Region-method-equals",
 225       "shortDoc": "<p>Check whether this region is equivalent to the given region</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": "getOutOfBoundOffset",
 255       "member": "Ext.util.Region",
 256       "doc": "<p>Get the offset amount of a point outside the region</p>\n",
 257       "params": [
 258         {
 259           "type": "String",
 260           "name": "axis",
 261           "doc": "<p>optional</p>\n",
 262           "optional": false
 263         },
 264         {
 265           "type": "Ext.util.Point",
 266           "name": "p",
 267           "doc": "<p>the point</p>\n",
 268           "optional": false
 269         }
 270       ],
 271       "return": {
 272         "type": "Ext.util.Offset",
 273         "doc": "\n"
 274       },
 275       "private": false,
 276       "static": false,
 277       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 278       "linenr": 131,
 279       "html_filename": "Region.html",
 280       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffset",
 281       "shortDoc": "<p>Get the offset amount of a point outside the region</p>\n"
 282     },
 283     {
 284       "tagname": "method",
 285       "name": "getOutOfBoundOffsetX",
 286       "member": "Ext.util.Region",
 287       "doc": "<p>Get the offset amount on the x-axis</p>\n",
 288       "params": [
 289         {
 290           "type": "Number",
 291           "name": "p",
 292           "doc": "<p>the offset</p>\n",
 293           "optional": false
 294         }
 295       ],
 296       "return": {
 297         "type": "Number",
 298         "doc": "\n"
 299       },
 300       "private": false,
 301       "static": false,
 302       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 303       "linenr": 154,
 304       "html_filename": "Region.html",
 305       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetX",
 306       "shortDoc": "<p>Get the offset amount on the x-axis</p>\n"
 307     },
 308     {
 309       "tagname": "method",
 310       "name": "getOutOfBoundOffsetY",
 311       "member": "Ext.util.Region",
 312       "doc": "<p>Get the offset amount on the y-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": 169,
 329       "html_filename": "Region.html",
 330       "href": "Region.html#Ext-util-Region-method-getOutOfBoundOffsetY",
 331       "shortDoc": "<p>Get the offset amount on the y-axis</p>\n"
 332     },
 333     {
 334       "tagname": "method",
 335       "name": "getRegion",
 336       "member": "Ext.util.Region",
 337       "doc": "\n",
 338       "params": [
 339         {
 340           "type": "Mixed",
 341           "name": "el",
 342           "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",
 343           "optional": false
 344         }
 345       ],
 346       "return": {
 347         "type": "Ext.util.Region",
 348         "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"
 349       },
 350       "private": false,
 351       "static": true,
 352       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 353       "linenr": 16,
 354       "html_filename": "Region.html",
 355       "href": "Region.html#Ext-util-Region-method-getRegion",
 356       "shortDoc": "\n"
 357     },
 358     {
 359       "tagname": "method",
 360       "name": "intersect",
 361       "member": "Ext.util.Region",
 362       "doc": "<p>Checks if this region intersects the region passed in.</p>\n",
 363       "params": [
 364         {
 365           "type": "Ext.util.Region",
 366           "name": "region",
 367           "doc": "\n",
 368           "optional": false
 369         }
 370       ],
 371       "return": {
 372         "type": "Ext.util.Region/Boolean",
 373         "doc": "<p>Returns the intersected region or false if there is no intersection.</p>\n"
 374       },
 375       "private": false,
 376       "static": false,
 377       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 378       "linenr": 67,
 379       "html_filename": "Region.html",
 380       "href": "Region.html#Ext-util-Region-method-intersect",
 381       "shortDoc": "<p>Checks if this region intersects the region passed in.</p>\n"
 382     },
 383     {
 384       "tagname": "method",
 385       "name": "isOutOfBound",
 386       "member": "Ext.util.Region",
 387       "doc": "<p>Check whether the point / offset is out of bound</p>\n",
 388       "params": [
 389         {
 390           "type": "String",
 391           "name": "axis",
 392           "doc": "<p>optional</p>\n",
 393           "optional": false
 394         },
 395         {
 396           "type": "Ext.util.Point/Number",
 397           "name": "p",
 398           "doc": "<p>the point / offset</p>\n",
 399           "optional": false
 400         }
 401       ],
 402       "return": {
 403         "type": "Boolean",
 404         "doc": "\n"
 405       },
 406       "private": false,
 407       "static": false,
 408       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 409       "linenr": 184,
 410       "html_filename": "Region.html",
 411       "href": "Region.html#Ext-util-Region-method-isOutOfBound",
 412       "shortDoc": "<p>Check whether the point / offset is out of bound</p>\n"
 413     },
 414     {
 415       "tagname": "method",
 416       "name": "isOutOfBoundX",
 417       "member": "Ext.util.Region",
 418       "doc": "<p>Check whether the offset is out of bound in the x-axis</p>\n",
 419       "params": [
 420         {
 421           "type": "Number",
 422           "name": "p",
 423           "doc": "<p>the 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": 203,
 435       "html_filename": "Region.html",
 436       "href": "Region.html#Ext-util-Region-method-isOutOfBoundX",
 437       "shortDoc": "<p>Check whether the offset is out of bound in the x-axis</p>\n"
 438     },
 439     {
 440       "tagname": "method",
 441       "name": "isOutOfBoundY",
 442       "member": "Ext.util.Region",
 443       "doc": "<p>Check whether the offset is out of bound in the y-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": 212,
 460       "html_filename": "Region.html",
 461       "href": "Region.html#Ext-util-Region-method-isOutOfBoundY",
 462       "shortDoc": "<p>Check whether the offset is out of bound in the y-axis</p>\n"
 463     },
 464     {
 465       "tagname": "method",
 466       "name": "round",
 467       "member": "Ext.util.Region",
 468       "doc": "<p>Round all the properties of this region</p>\n",
 469       "params": [
 470
 471       ],
 472       "return": {
 473         "type": "Ext.util.Region",
 474         "doc": "<p>this This Region</p>\n"
 475       },
 476       "private": false,
 477       "static": false,
 478       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 479       "linenr": 360,
 480       "html_filename": "Region.html",
 481       "href": "Region.html#Ext-util-Region-method-round",
 482       "shortDoc": "<p>Round all the properties of this region</p>\n"
 483     },
 484     {
 485       "tagname": "method",
 486       "name": "toString",
 487       "member": "Ext.util.Region",
 488       "doc": "<p>Dump this to an eye-friendly string, great for debugging</p>\n",
 489       "params": [
 490
 491       ],
 492       "return": {
 493         "type": "String",
 494         "doc": "\n"
 495       },
 496       "private": false,
 497       "static": false,
 498       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 499       "linenr": 330,
 500       "html_filename": "Region.html",
 501       "href": "Region.html#Ext-util-Region-method-toString",
 502       "shortDoc": "<p>Dump this to an eye-friendly string, great for debugging</p>\n"
 503     },
 504     {
 505       "tagname": "method",
 506       "name": "translateBy",
 507       "member": "Ext.util.Region",
 508       "doc": "<p>Translate this region by the given offset amount</p>\n",
 509       "params": [
 510         {
 511           "type": "Ext.util.Offset/Object",
 512           "name": "offset",
 513           "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",
 514           "optional": false
 515         },
 516         {
 517           "type": "Number",
 518           "name": "The",
 519           "doc": "<p>y value unless using an Offset object.</p>\n",
 520           "optional": false
 521         }
 522       ],
 523       "return": {
 524         "type": "Ext.util.Region",
 525         "doc": "<p>this This Region</p>\n"
 526       },
 527       "private": false,
 528       "static": false,
 529       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 530       "linenr": 339,
 531       "html_filename": "Region.html",
 532       "href": "Region.html#Ext-util-Region-method-translateBy",
 533       "shortDoc": "<p>Translate this region by the given offset amount</p>\n"
 534     },
 535     {
 536       "tagname": "method",
 537       "name": "union",
 538       "member": "Ext.util.Region",
 539       "doc": "<p>Returns the smallest region that contains the current AND targetRegion.</p>\n",
 540       "params": [
 541         {
 542           "type": "Ext.util.Region",
 543           "name": "region",
 544           "doc": "\n",
 545           "optional": false
 546         }
 547       ],
 548       "return": {
 549         "type": "void",
 550         "doc": "\n"
 551       },
 552       "private": false,
 553       "static": false,
 554       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 555       "linenr": 87,
 556       "html_filename": "Region.html",
 557       "href": "Region.html#Ext-util-Region-method-union",
 558       "shortDoc": "<p>Returns the smallest region that contains the current AND targetRegion.</p>\n"
 559     }
 560   ],
 561   "property": [
 562
 563   ],
 564   "event": [
 565
 566   ],
 567   "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Region.js",
 568   "linenr": 1,
 569   "html_filename": "Region.html",
 570   "href": "Region.html#Ext-util-Region",
 571   "cssVar": [
 572
 573   ],
 574   "cssMixin": [
 575
 576   ],
 577   "component": false,
 578   "superclasses": [
 579
 580   ],
 581   "subclasses": [
 582     "Ext.util.Point"
 583   ],
 584   "mixedInto": [
 585
 586   ],
 587   "allMixins": [
 588
 589   ]
 590 });