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

   1 Ext.data.JsonP.Ext_layout_component_field_Text({
   2   "tagname": "class",
   3   "name": "Ext.layout.component.field.Text",
   4   "doc": "<p>Layout class for <a href=\"#/api/Ext.form.field.Text\" rel=\"Ext.form.field.Text\" class=\"docClass\">Ext.form.field.Text</a> fields. Handles sizing the input 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.Text",
  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>.</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/Text.js",
  47       "linenr": 41,
  48       "html_filename": "Text2.html",
  49       "href": "Text2.html#Ext-layout-component-field-Text-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": "beforeLayout",
  55       "member": "Ext.layout.component.field.Text",
  56       "doc": "<p>Allow layout to proceed if the <a href=\"#/api/Ext.form.field.Text-cfg-grow\" rel=\"Ext.form.field.Text-cfg-grow\" class=\"docClass\">Ext.form.field.Text.grow</a> config is enabled and the value has\nchanged since the last layout.</p>\n",
  57       "params": [
  58         {
  59           "type": "Object",
  60           "name": "width",
  61           "doc": "\n",
  62           "optional": false
  63         },
  64         {
  65           "type": "Object",
  66           "name": "height",
  67           "doc": "\n",
  68           "optional": false
  69         }
  70       ],
  71       "return": {
  72         "type": "void",
  73         "doc": "\n"
  74       },
  75       "private": false,
  76       "static": false,
  77       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Text.js",
  78       "linenr": 15,
  79       "html_filename": "Text2.html",
  80       "href": "Text2.html#Ext-layout-component-field-Text-method-beforeLayout",
  81       "shortDoc": "Allow layout to proceed if the Ext.form.field.Text.grow config is enabled and the value has\nchanged since the last la..."
  82     },
  83     {
  84       "tagname": "method",
  85       "name": "destroyTip",
  86       "member": "Ext.layout.component.field.Field",
  87       "doc": "<p>Destroy the error tip instance.</p>\n",
  88       "params": [
  89
  90       ],
  91       "return": {
  92         "type": "void",
  93         "doc": "\n"
  94       },
  95       "private": false,
  96       "static": false,
  97       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
  98       "linenr": 380,
  99       "html_filename": "Field2.html",
 100       "href": "Field2.html#Ext-layout-component-field-Field-method-destroyTip",
 101       "shortDoc": "<p>Destroy the error tip instance.</p>\n"
 102     },
 103     {
 104       "tagname": "method",
 105       "name": "getErrorStrategy",
 106       "member": "Ext.layout.component.field.Field",
 107       "doc": "<p>Return the set of strategy functions from the <a href=\"#/api/Ext.layout.component.field.Text-property-errorStrategies\" rel=\"Ext.layout.component.field.Text-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",
 108       "params": [
 109
 110       ],
 111       "return": {
 112         "type": "void",
 113         "doc": "\n"
 114       },
 115       "private": false,
 116       "static": false,
 117       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 118       "linenr": 144,
 119       "html_filename": "Field2.html",
 120       "href": "Field2.html#Ext-layout-component-field-Field-method-getErrorStrategy",
 121       "shortDoc": "Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarge..."
 122     },
 123     {
 124       "tagname": "method",
 125       "name": "getLabelStrategy",
 126       "member": "Ext.layout.component.field.Field",
 127       "doc": "<p>Return the set of strategy functions from the <a href=\"#/api/Ext.layout.component.field.Text-property-labelStrategies\" rel=\"Ext.layout.component.field.Text-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",
 128       "params": [
 129
 130       ],
 131       "return": {
 132         "type": "void",
 133         "doc": "\n"
 134       },
 135       "private": false,
 136       "static": false,
 137       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 138       "linenr": 133,
 139       "html_filename": "Field2.html",
 140       "href": "Field2.html#Ext-layout-component-field-Field-method-getLabelStrategy",
 141       "shortDoc": "Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAli..."
 142     },
 143     {
 144       "tagname": "method",
 145       "name": "getRenderTarget",
 146       "member": "Ext.layout.component.Component",
 147       "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",
 148       "params": [
 149
 150       ],
 151       "return": {
 152         "type": "Ext.core.Element",
 153         "doc": "\n"
 154       },
 155       "private": false,
 156       "static": false,
 157       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 158       "linenr": 129,
 159       "html_filename": "Component5.html",
 160       "href": "Component5.html#Ext-layout-component-Component-method-getRenderTarget",
 161       "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.\n\n\n..."
 162     },
 163     {
 164       "tagname": "method",
 165       "name": "getTarget",
 166       "member": "Ext.layout.component.Component",
 167       "doc": "<p>Returns the owner component's resize element.</p>\n",
 168       "params": [
 169
 170       ],
 171       "return": {
 172         "type": "Ext.core.Element",
 173         "doc": "\n"
 174       },
 175       "private": false,
 176       "static": false,
 177       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 178       "linenr": 121,
 179       "html_filename": "Component5.html",
 180       "href": "Component5.html#Ext-layout-component-Component-method-getTarget",
 181       "shortDoc": "<p>Returns the owner component's resize element.</p>\n"
 182     },
 183     {
 184       "tagname": "method",
 185       "name": "initTip",
 186       "member": "Ext.layout.component.field.Field",
 187       "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",
 188       "params": [
 189
 190       ],
 191       "return": {
 192         "type": "void",
 193         "doc": "\n"
 194       },
 195       "private": false,
 196       "static": false,
 197       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 198       "linenr": 365,
 199       "html_filename": "Field2.html",
 200       "href": "Field2.html#Ext-layout-component-field-Field-method-initTip",
 201       "shortDoc": "Use a custom QuickTip instance separate from the main QuickTips singleton, so that we\ncan give it a custom frame styl..."
 202     },
 203     {
 204       "tagname": "method",
 205       "name": "needsLayout",
 206       "member": "Ext.layout.component.Component",
 207       "doc": "<p>Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.</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       "return": {
 223         "type": "void",
 224         "doc": "\n"
 225       },
 226       "private": false,
 227       "static": false,
 228       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 229       "linenr": 90,
 230       "html_filename": "Component5.html",
 231       "href": "Component5.html#Ext-layout-component-Component-method-needsLayout",
 232       "shortDoc": "<p>Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.</p>\n"
 233     },
 234     {
 235       "tagname": "method",
 236       "name": "setElementSize",
 237       "member": "Ext.layout.component.Component",
 238       "doc": "<p>Set the size of any element supporting undefined, null, and values.</p>\n",
 239       "params": [
 240         {
 241           "type": "Mixed",
 242           "name": "width",
 243           "doc": "<p>The new width to set.</p>\n",
 244           "optional": false
 245         },
 246         {
 247           "type": "Mixed",
 248           "name": "height",
 249           "doc": "<p>The new height to set.</p>\n",
 250           "optional": false
 251         },
 252         {
 253           "type": "Object",
 254           "name": "height",
 255           "doc": "\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": 104,
 267       "html_filename": "Component5.html",
 268       "href": "Component5.html#Ext-layout-component-Component-method-setElementSize",
 269       "shortDoc": "<p>Set the size of any element supporting undefined, null, and values.</p>\n"
 270     },
 271     {
 272       "tagname": "method",
 273       "name": "setTargetSize",
 274       "member": "Ext.layout.component.Component",
 275       "doc": "<p>Set the size of the target element.</p>\n",
 276       "params": [
 277         {
 278           "type": "Mixed",
 279           "name": "width",
 280           "doc": "<p>The new width to set.</p>\n",
 281           "optional": false
 282         },
 283         {
 284           "type": "Mixed",
 285           "name": "height",
 286           "doc": "<p>The new height to set.</p>\n",
 287           "optional": false
 288         }
 289       ],
 290       "return": {
 291         "type": "void",
 292         "doc": "\n"
 293       },
 294       "private": false,
 295       "static": false,
 296       "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js",
 297       "linenr": 138,
 298       "html_filename": "Component5.html",
 299       "href": "Component5.html#Ext-layout-component-Component-method-setTargetSize",
 300       "shortDoc": "<p>Set the size of the target element.</p>\n"
 301     },
 302     {
 303       "tagname": "method",
 304       "name": "sizeBody",
 305       "member": "Ext.layout.component.field.Field",
 306       "doc": "<p>Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.</p>\n",
 307       "params": [
 308         {
 309           "type": "Object",
 310           "name": "info",
 311           "doc": "\n",
 312           "optional": false
 313         }
 314       ],
 315       "return": {
 316         "type": "void",
 317         "doc": "\n"
 318       },
 319       "private": false,
 320       "static": false,
 321       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 322       "linenr": 105,
 323       "html_filename": "Field2.html",
 324       "href": "Field2.html#Ext-layout-component-field-Field-method-sizeBody",
 325       "shortDoc": "<p>Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.</p>\n"
 326     },
 327     {
 328       "tagname": "method",
 329       "name": "sizeBodyContents",
 330       "member": "Ext.layout.component.field.Text",
 331       "doc": "<p>Size the field body contents given the total dimensions of the bodyEl, taking into account the optional\n<a href=\"#/api/Ext.form.field.Text-cfg-grow\" rel=\"Ext.form.field.Text-cfg-grow\" class=\"docClass\">Ext.form.field.Text.grow</a> configurations.</p>\n",
 332       "params": [
 333         {
 334           "type": "Number",
 335           "name": "width",
 336           "doc": "<p>The bodyEl width</p>\n",
 337           "optional": false
 338         },
 339         {
 340           "type": "Number",
 341           "name": "height",
 342           "doc": "<p>The bodyEl height</p>\n",
 343           "optional": false
 344         }
 345       ],
 346       "return": {
 347         "type": "void",
 348         "doc": "\n"
 349       },
 350       "private": false,
 351       "static": false,
 352       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Text.js",
 353       "linenr": 29,
 354       "html_filename": "Text2.html",
 355       "href": "Text2.html#Ext-layout-component-field-Text-method-sizeBodyContents",
 356       "shortDoc": "Size the field body contents given the total dimensions of the bodyEl, taking into account the optional\nExt.form.fiel..."
 357     }
 358   ],
 359   "property": [
 360     {
 361       "tagname": "property",
 362       "name": "elementId",
 363       "member": "Ext.layout.component.field.Field",
 364       "type": "Object",
 365       "doc": "<p>Error message displayed as content of an element with a given id elsewhere in the app</p>\n",
 366       "private": false,
 367       "static": false,
 368       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 369       "linenr": 348,
 370       "html_filename": "Field2.html",
 371       "href": "Field2.html#Ext-layout-component-field-Field-property-elementId"
 372     },
 373     {
 374       "tagname": "property",
 375       "name": "errorStrategies",
 376       "member": "Ext.layout.component.field.Field",
 377       "type": "Object",
 378       "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",
 379       "private": false,
 380       "static": false,
 381       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 382       "linenr": 240,
 383       "html_filename": "Field2.html",
 384       "href": "Field2.html#Ext-layout-component-field-Field-property-errorStrategies",
 385       "shortDoc": "Collection of named strategies for laying out and adjusting insets to accommodate error messages.\nAn appropriate one ..."
 386     },
 387     {
 388       "tagname": "property",
 389       "name": "labelStrategies",
 390       "member": "Ext.layout.component.field.Field",
 391       "type": "Object",
 392       "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",
 393       "private": false,
 394       "static": false,
 395       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 396       "linenr": 160,
 397       "html_filename": "Field2.html",
 398       "href": "Field2.html#Ext-layout-component-field-Field-property-labelStrategies",
 399       "shortDoc": "Collection of named strategies for laying out and adjusting labels to accommodate error messages.\nAn appropriate one ..."
 400     },
 401     {
 402       "tagname": "property",
 403       "name": "left",
 404       "member": "Ext.layout.component.field.Field",
 405       "type": "Object",
 406       "doc": "<p>Label displayed to the left of the bodyEl</p>\n",
 407       "private": false,
 408       "static": false,
 409       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 410       "linenr": 226,
 411       "html_filename": "Field2.html",
 412       "href": "Field2.html#Ext-layout-component-field-Field-property-left"
 413     },
 414     {
 415       "tagname": "property",
 416       "name": "qtip",
 417       "member": "Ext.layout.component.field.Field",
 418       "type": "Object",
 419       "doc": "<p>Error displayed as QuickTip on hover of the field container</p>\n",
 420       "private": false,
 421       "static": false,
 422       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 423       "linenr": 327,
 424       "html_filename": "Field2.html",
 425       "href": "Field2.html#Ext-layout-component-field-Field-property-qtip"
 426     },
 427     {
 428       "tagname": "property",
 429       "name": "right",
 430       "member": "Ext.layout.component.field.Field",
 431       "type": "Object",
 432       "doc": "<p>Same as left, only difference is text-align in CSS</p>\n",
 433       "private": false,
 434       "static": false,
 435       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 436       "linenr": 231,
 437       "html_filename": "Field2.html",
 438       "href": "Field2.html#Ext-layout-component-field-Field-property-right"
 439     },
 440     {
 441       "tagname": "property",
 442       "name": "side",
 443       "member": "Ext.layout.component.field.Field",
 444       "type": "Object",
 445       "doc": "<p>Error displayed as icon (with QuickTip on hover) to right of the bodyEl</p>\n",
 446       "private": false,
 447       "static": false,
 448       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 449       "linenr": 273,
 450       "html_filename": "Field2.html",
 451       "href": "Field2.html#Ext-layout-component-field-Field-property-side"
 452     },
 453     {
 454       "tagname": "property",
 455       "name": "sizeBodyContents",
 456       "member": "Ext.layout.component.field.Field",
 457       "type": "Object",
 458       "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",
 459       "private": false,
 460       "static": false,
 461       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 462       "linenr": 124,
 463       "html_filename": "Field2.html",
 464       "href": "Field2.html#Ext-layout-component-field-Field-property-sizeBodyContents",
 465       "shortDoc": "Size the contents of the field body, given the full dimensions of the bodyEl. Does nothing by\ndefault, subclasses can..."
 466     },
 467     {
 468       "tagname": "property",
 469       "name": "title",
 470       "member": "Ext.layout.component.field.Field",
 471       "type": "Object",
 472       "doc": "<p>Error displayed as title tip on hover of the field container</p>\n",
 473       "private": false,
 474       "static": false,
 475       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 476       "linenr": 338,
 477       "html_filename": "Field2.html",
 478       "href": "Field2.html#Ext-layout-component-field-Field-property-title"
 479     },
 480     {
 481       "tagname": "property",
 482       "name": "top",
 483       "member": "Ext.layout.component.field.Field",
 484       "type": "Object",
 485       "doc": "<p>Label displayed above the bodyEl</p>\n",
 486       "private": false,
 487       "static": false,
 488       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 489       "linenr": 213,
 490       "html_filename": "Field2.html",
 491       "href": "Field2.html#Ext-layout-component-field-Field-property-top"
 492     },
 493     {
 494       "tagname": "property",
 495       "name": "under",
 496       "member": "Ext.layout.component.field.Field",
 497       "type": "Object",
 498       "doc": "<p>Error message displayed underneath the bodyEl</p>\n",
 499       "private": false,
 500       "static": false,
 501       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js",
 502       "linenr": 301,
 503       "html_filename": "Field2.html",
 504       "href": "Field2.html#Ext-layout-component-field-Field-property-under"
 505     }
 506   ],
 507   "event": [
 508
 509   ],
 510   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Text.js",
 511   "linenr": 1,
 512   "html_filename": "Text2.html",
 513   "href": "Text2.html#Ext-layout-component-field-Text",
 514   "cssVar": [
 515
 516   ],
 517   "cssMixin": [
 518
 519   ],
 520   "component": false,
 521   "superclasses": [
 522     "Ext.layout.Layout",
 523     "Ext.layout.component.Component",
 524     "Ext.layout.component.field.Field"
 525   ],
 526   "subclasses": [
 527
 528   ],
 529   "mixedInto": [
 530
 531   ],
 532   "allMixins": [
 533
 534   ]
 535 });