docs/output/Ext.layout.component.field.TextArea.js

   1 Ext.data.JsonP.Ext_layout_component_field_TextArea({
   2   "tagname": "class",
   3   "name": "Ext.layout.component.field.TextArea",
   4   "doc": "<p>Layout class for <a href=\"#/api/Ext.form.field.TextArea\" rel=\"Ext.form.field.TextArea\" class=\"docClass\">Ext.form.field.TextArea</a> fields. Handles sizing the textarea field.</p>\n",
   5   "extends": "Ext.layout.component.field.Field",
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": true,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "adjustForGrow",
  24       "member": "Ext.layout.component.field.TextArea",
  25       "doc": "<p>Given the target bodyEl dimensions, adjust them if necessary to return the correct final\nsize based on the text field's <a href=\"#/api/Ext.form.field.Text-cfg-grow\" rel=\"Ext.form.field.Text-cfg-grow\" class=\"docClass\">grow config</a>. Overrides the\ntextfield layout's implementation to handle height rather than width.</p>\n",
  26       "params": [
  27         {
  28           "type": "Number",
  29           "name": "width",
  30           "doc": "<p>The bodyEl width</p>\n",
  31           "optional": false
  32         },
  33         {
  34           "type": "Number",
  35           "name": "height",
  36           "doc": "<p>The bodyEl height</p>\n",
  37           "optional": false
  38         }
  39       ],
  40       "return": {
  41         "type": "Array",
  42         "doc": "<p>[inputElWidth, inputElHeight]</p>\n"
  43       },
  44       "private": false,
  45       "static": false,
  46       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/TextArea.js",
  47       "linenr": 14,
  48       "html_filename": "TextArea2.html",
  49       "href": "TextArea2.html#Ext-layout-component-field-TextArea-method-adjustForGrow",
  50       "shortDoc": "Given the target bodyEl dimensions, adjust them if necessary to return the correct final\nsize based on the text field..."
  51     },
  52     {
  53       "tagname": "method",
  54       "name": "destroyTip",
  55       "member": "Ext.layout.component.field.Field",
  56       "doc": "<p>Destroy the error tip instance.</p>\n",
  57       "params": [
  58
  59       ],
  60       "return": {
  61         "type": "void",
  62         "doc": "\n"
  63       },
  64       "private": false,
  65       "static": false,
  66       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
  67       "linenr": 380,
  68       "html_filename": "Field2.html",
  69       "href": "Field2.html#Ext-layout-component-field-Field-method-destroyTip",
  70       "shortDoc": "<p>Destroy the error tip instance.</p>\n"
  71     },
  72     {
  73       "tagname": "method",
  74       "name": "getErrorStrategy",
  75       "member": "Ext.layout.component.field.Field",
  76       "doc": "<p>Return the set of strategy functions from the <a href=\"#/api/Ext.layout.component.field.TextArea-property-errorStrategies\" rel=\"Ext.layout.component.field.TextArea-property-errorStrategies\" class=\"docClass\">errorStrategies collection</a>\nthat is appropriate for the field's <a href=\"#/api/Ext.form.field.Field--msgTarget\" rel=\"Ext.form.field.Field--msgTarget\" class=\"docClass\">msgTarget</a> config.</p>\n",
  77       "params": [
  78
  79       ],
  80       "return": {
  81         "type": "void",
  82         "doc": "\n"
  83       },
  84       "private": false,
  85       "static": false,
  86       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
  87       "linenr": 144,
  88       "html_filename": "Field2.html",
  89       "href": "Field2.html#Ext-layout-component-field-Field-method-getErrorStrategy",
  90       "shortDoc": "Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarge..."
  91     },
  92     {
  93       "tagname": "method",
  94       "name": "getLabelStrategy",
  95       "member": "Ext.layout.component.field.Field",
  96       "doc": "<p>Return the set of strategy functions from the <a href=\"#/api/Ext.layout.component.field.TextArea-property-labelStrategies\" rel=\"Ext.layout.component.field.TextArea-property-labelStrategies\" class=\"docClass\">labelStrategies collection</a>\nthat is appropriate for the field's <a href=\"#/api/Ext.form.field.Field--labelAlign\" rel=\"Ext.form.field.Field--labelAlign\" class=\"docClass\">labelAlign</a> config.</p>\n",
  97       "params": [
  98
  99       ],
 100       "return": {
 101         "type": "void",
 102         "doc": "\n"
 103       },
 104       "private": false,
 105       "static": false,
 106       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 107       "linenr": 133,
 108       "html_filename": "Field2.html",
 109       "href": "Field2.html#Ext-layout-component-field-Field-method-getLabelStrategy",
 110       "shortDoc": "Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAli..."
 111     },
 112     {
 113       "tagname": "method",
 114       "name": "getRenderTarget",
 115       "member": "Ext.layout.component.Component",
 116       "doc": "<p>Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.</p>\n\n\n<p>May be overridden in Component layout managers which implement an inner element.</p>\n",
 117       "params": [
 118
 119       ],
 120       "return": {
 121         "type": "Ext.core.Element",
 122         "doc": "\n"
 123       },
 124       "private": false,
 125       "static": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 127       "linenr": 129,
 128       "html_filename": "Component5.html",
 129       "href": "Component5.html#Ext-layout-component-Component-method-getRenderTarget",
 130       "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.\n\n\n..."
 131     },
 132     {
 133       "tagname": "method",
 134       "name": "getTarget",
 135       "member": "Ext.layout.component.Component",
 136       "doc": "<p>Returns the owner component's resize element.</p>\n",
 137       "params": [
 138
 139       ],
 140       "return": {
 141         "type": "Ext.core.Element",
 142         "doc": "\n"
 143       },
 144       "private": false,
 145       "static": false,
 146       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 147       "linenr": 121,
 148       "html_filename": "Component5.html",
 149       "href": "Component5.html#Ext-layout-component-Component-method-getTarget",
 150       "shortDoc": "<p>Returns the owner component's resize element.</p>\n"
 151     },
 152     {
 153       "tagname": "method",
 154       "name": "initTip",
 155       "member": "Ext.layout.component.field.Field",
 156       "doc": "<p>Use a custom QuickTip instance separate from the main QuickTips singleton, so that we\ncan give it a custom frame style. Responds to errorqtip rather than the qtip property.</p>\n",
 157       "params": [
 158
 159       ],
 160       "return": {
 161         "type": "void",
 162         "doc": "\n"
 163       },
 164       "private": false,
 165       "static": false,
 166       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 167       "linenr": 365,
 168       "html_filename": "Field2.html",
 169       "href": "Field2.html#Ext-layout-component-field-Field-method-initTip",
 170       "shortDoc": "Use a custom QuickTip instance separate from the main QuickTips singleton, so that we\ncan give it a custom frame styl..."
 171     },
 172     {
 173       "tagname": "method",
 174       "name": "needsLayout",
 175       "member": "Ext.layout.component.Component",
 176       "doc": "<p>Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.</p>\n",
 177       "params": [
 178         {
 179           "type": "Mixed",
 180           "name": "width",
 181           "doc": "<p>The new width to set.</p>\n",
 182           "optional": false
 183         },
 184         {
 185           "type": "Mixed",
 186           "name": "height",
 187           "doc": "<p>The new height to set.</p>\n",
 188           "optional": false
 189         }
 190       ],
 191       "return": {
 192         "type": "void",
 193         "doc": "\n"
 194       },
 195       "private": false,
 196       "static": false,
 197       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 198       "linenr": 90,
 199       "html_filename": "Component5.html",
 200       "href": "Component5.html#Ext-layout-component-Component-method-needsLayout",
 201       "shortDoc": "<p>Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.</p>\n"
 202     },
 203     {
 204       "tagname": "method",
 205       "name": "setElementSize",
 206       "member": "Ext.layout.component.Component",
 207       "doc": "<p>Set the size of any element supporting undefined, null, and values.</p>\n",
 208       "params": [
 209         {
 210           "type": "Mixed",
 211           "name": "width",
 212           "doc": "<p>The new width to set.</p>\n",
 213           "optional": false
 214         },
 215         {
 216           "type": "Mixed",
 217           "name": "height",
 218           "doc": "<p>The new height to set.</p>\n",
 219           "optional": false
 220         },
 221         {
 222           "type": "Object",
 223           "name": "height",
 224           "doc": "\n",
 225           "optional": false
 226         }
 227       ],
 228       "return": {
 229         "type": "void",
 230         "doc": "\n"
 231       },
 232       "private": false,
 233       "static": false,
 234       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 235       "linenr": 104,
 236       "html_filename": "Component5.html",
 237       "href": "Component5.html#Ext-layout-component-Component-method-setElementSize",
 238       "shortDoc": "<p>Set the size of any element supporting undefined, null, and values.</p>\n"
 239     },
 240     {
 241       "tagname": "method",
 242       "name": "setTargetSize",
 243       "member": "Ext.layout.component.Component",
 244       "doc": "<p>Set the size of the target element.</p>\n",
 245       "params": [
 246         {
 247           "type": "Mixed",
 248           "name": "width",
 249           "doc": "<p>The new width to set.</p>\n",
 250           "optional": false
 251         },
 252         {
 253           "type": "Mixed",
 254           "name": "height",
 255           "doc": "<p>The new height to set.</p>\n",
 256           "optional": false
 257         }
 258       ],
 259       "return": {
 260         "type": "void",
 261         "doc": "\n"
 262       },
 263       "private": false,
 264       "static": false,
 265       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 266       "linenr": 138,
 267       "html_filename": "Component5.html",
 268       "href": "Component5.html#Ext-layout-component-Component-method-setTargetSize",
 269       "shortDoc": "<p>Set the size of the target element.</p>\n"
 270     },
 271     {
 272       "tagname": "method",
 273       "name": "sizeBody",
 274       "member": "Ext.layout.component.field.Field",
 275       "doc": "<p>Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.</p>\n",
 276       "params": [
 277         {
 278           "type": "Object",
 279           "name": "info",
 280           "doc": "\n",
 281           "optional": false
 282         }
 283       ],
 284       "return": {
 285         "type": "void",
 286         "doc": "\n"
 287       },
 288       "private": false,
 289       "static": false,
 290       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 291       "linenr": 105,
 292       "html_filename": "Field2.html",
 293       "href": "Field2.html#Ext-layout-component-field-Field-method-sizeBody",
 294       "shortDoc": "<p>Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.</p>\n"
 295     }
 296   ],
 297   "property": [
 298     {
 299       "tagname": "property",
 300       "name": "elementId",
 301       "member": "Ext.layout.component.field.Field",
 302       "type": "Object",
 303       "doc": "<p>Error message displayed as content of an element with a given id elsewhere in the app</p>\n",
 304       "private": false,
 305       "static": false,
 306       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 307       "linenr": 348,
 308       "html_filename": "Field2.html",
 309       "href": "Field2.html#Ext-layout-component-field-Field-property-elementId"
 310     },
 311     {
 312       "tagname": "property",
 313       "name": "errorStrategies",
 314       "member": "Ext.layout.component.field.Field",
 315       "type": "Object",
 316       "doc": "<p>Collection of named strategies for laying out and adjusting insets to accommodate error messages.\nAn appropriate one will be chosen based on the owner field's <a href=\"#/api/Ext.form.field.Field--msgTarget\" rel=\"Ext.form.field.Field--msgTarget\" class=\"docClass\">Ext.form.field.Field.msgTarget</a> config.</p>\n",
 317       "private": false,
 318       "static": false,
 319       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 320       "linenr": 240,
 321       "html_filename": "Field2.html",
 322       "href": "Field2.html#Ext-layout-component-field-Field-property-errorStrategies",
 323       "shortDoc": "Collection of named strategies for laying out and adjusting insets to accommodate error messages.\nAn appropriate one ..."
 324     },
 325     {
 326       "tagname": "property",
 327       "name": "labelStrategies",
 328       "member": "Ext.layout.component.field.Field",
 329       "type": "Object",
 330       "doc": "<p>Collection of named strategies for laying out and adjusting labels to accommodate error messages.\nAn appropriate one will be chosen based on the owner field's <a href=\"#/api/Ext.form.field.Field--labelAlign\" rel=\"Ext.form.field.Field--labelAlign\" class=\"docClass\">Ext.form.field.Field.labelAlign</a> config.</p>\n",
 331       "private": false,
 332       "static": false,
 333       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 334       "linenr": 160,
 335       "html_filename": "Field2.html",
 336       "href": "Field2.html#Ext-layout-component-field-Field-property-labelStrategies",
 337       "shortDoc": "Collection of named strategies for laying out and adjusting labels to accommodate error messages.\nAn appropriate one ..."
 338     },
 339     {
 340       "tagname": "property",
 341       "name": "left",
 342       "member": "Ext.layout.component.field.Field",
 343       "type": "Object",
 344       "doc": "<p>Label displayed to the left of the bodyEl</p>\n",
 345       "private": false,
 346       "static": false,
 347       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 348       "linenr": 226,
 349       "html_filename": "Field2.html",
 350       "href": "Field2.html#Ext-layout-component-field-Field-property-left"
 351     },
 352     {
 353       "tagname": "property",
 354       "name": "qtip",
 355       "member": "Ext.layout.component.field.Field",
 356       "type": "Object",
 357       "doc": "<p>Error displayed as QuickTip on hover of the field container</p>\n",
 358       "private": false,
 359       "static": false,
 360       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 361       "linenr": 327,
 362       "html_filename": "Field2.html",
 363       "href": "Field2.html#Ext-layout-component-field-Field-property-qtip"
 364     },
 365     {
 366       "tagname": "property",
 367       "name": "right",
 368       "member": "Ext.layout.component.field.Field",
 369       "type": "Object",
 370       "doc": "<p>Same as left, only difference is text-align in CSS</p>\n",
 371       "private": false,
 372       "static": false,
 373       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 374       "linenr": 231,
 375       "html_filename": "Field2.html",
 376       "href": "Field2.html#Ext-layout-component-field-Field-property-right"
 377     },
 378     {
 379       "tagname": "property",
 380       "name": "side",
 381       "member": "Ext.layout.component.field.Field",
 382       "type": "Object",
 383       "doc": "<p>Error displayed as icon (with QuickTip on hover) to right of the bodyEl</p>\n",
 384       "private": false,
 385       "static": false,
 386       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 387       "linenr": 273,
 388       "html_filename": "Field2.html",
 389       "href": "Field2.html#Ext-layout-component-field-Field-property-side"
 390     },
 391     {
 392       "tagname": "property",
 393       "name": "sizeBodyContents",
 394       "member": "Ext.layout.component.field.Field",
 395       "type": "Object",
 396       "doc": "<p>Size the contents of the field body, given the full dimensions of the bodyEl. Does nothing by\ndefault, subclasses can override to handle their specific contents.</p>\n",
 397       "private": false,
 398       "static": false,
 399       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 400       "linenr": 124,
 401       "html_filename": "Field2.html",
 402       "href": "Field2.html#Ext-layout-component-field-Field-property-sizeBodyContents",
 403       "shortDoc": "Size the contents of the field body, given the full dimensions of the bodyEl. Does nothing by\ndefault, subclasses can..."
 404     },
 405     {
 406       "tagname": "property",
 407       "name": "title",
 408       "member": "Ext.layout.component.field.Field",
 409       "type": "Object",
 410       "doc": "<p>Error displayed as title tip on hover of the field container</p>\n",
 411       "private": false,
 412       "static": false,
 413       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 414       "linenr": 338,
 415       "html_filename": "Field2.html",
 416       "href": "Field2.html#Ext-layout-component-field-Field-property-title"
 417     },
 418     {
 419       "tagname": "property",
 420       "name": "top",
 421       "member": "Ext.layout.component.field.Field",
 422       "type": "Object",
 423       "doc": "<p>Label displayed above the bodyEl</p>\n",
 424       "private": false,
 425       "static": false,
 426       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 427       "linenr": 213,
 428       "html_filename": "Field2.html",
 429       "href": "Field2.html#Ext-layout-component-field-Field-property-top"
 430     },
 431     {
 432       "tagname": "property",
 433       "name": "under",
 434       "member": "Ext.layout.component.field.Field",
 435       "type": "Object",
 436       "doc": "<p>Error message displayed underneath the bodyEl</p>\n",
 437       "private": false,
 438       "static": false,
 439       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 440       "linenr": 301,
 441       "html_filename": "Field2.html",
 442       "href": "Field2.html#Ext-layout-component-field-Field-property-under"
 443     }
 444   ],
 445   "event": [
 446
 447   ],
 448   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/TextArea.js",
 449   "linenr": 1,
 450   "html_filename": "TextArea2.html",
 451   "href": "TextArea2.html#Ext-layout-component-field-TextArea",
 452   "cssVar": [
 453
 454   ],
 455   "cssMixin": [
 456
 457   ],
 458   "component": false,
 459   "superclasses": [
 460     "Ext.layout.Layout",
 461     "Ext.layout.component.Component",
 462     "Ext.layout.component.field.Field"
 463   ],
 464   "subclasses": [
 465
 466   ],
 467   "mixedInto": [
 468
 469   ],
 470   "allMixins": [
 471
 472   ]
 473 });