X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.layout.component.field.Field.js diff --git a/docs/output/Ext.layout.component.field.Field.js b/docs/output/Ext.layout.component.field.Field.js index dad054f3..d0bfad77 100644 --- a/docs/output/Ext.layout.component.field.Field.js +++ b/docs/output/Ext.layout.component.field.Field.js @@ -1,446 +1 @@ -Ext.data.JsonP.Ext_layout_component_field_Field({ - "tagname": "class", - "name": "Ext.layout.component.field.Field", - "doc": "
Layout class for components with field labeling, handling the sizing and alignment of\nthe form control, label, and error message treatment.
\n", - "extends": "Ext.layout.component.Component", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": false, - "private": true, - "cfg": [ - - ], - "method": [ - { - "tagname": "method", - "name": "destroyTip", - "member": "Ext.layout.component.field.Field", - "doc": "Destroy the error tip instance.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 380, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-method-destroyTip", - "shortDoc": "Destroy the error tip instance.
\n" - }, - { - "tagname": "method", - "name": "getErrorStrategy", - "member": "Ext.layout.component.field.Field", - "doc": "Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarget config.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 144, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-method-getErrorStrategy", - "shortDoc": "Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarge..." - }, - { - "tagname": "method", - "name": "getLabelStrategy", - "member": "Ext.layout.component.field.Field", - "doc": "Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAlign config.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 133, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-method-getLabelStrategy", - "shortDoc": "Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAli..." - }, - { - "tagname": "method", - "name": "getRenderTarget", - "member": "Ext.layout.component.Component", - "doc": "Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.
\n\n\nMay be overridden in Component layout managers which implement an inner element.
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 129, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-getRenderTarget", - "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.\n\n\n..." - }, - { - "tagname": "method", - "name": "getTarget", - "member": "Ext.layout.component.Component", - "doc": "Returns the owner component's resize element.
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 121, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-getTarget", - "shortDoc": "Returns the owner component's resize element.
\n" - }, - { - "tagname": "method", - "name": "initTip", - "member": "Ext.layout.component.field.Field", - "doc": "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.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 365, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-method-initTip", - "shortDoc": "Use a custom QuickTip instance separate from the main QuickTips singleton, so that we\ncan give it a custom frame styl..." - }, - { - "tagname": "method", - "name": "needsLayout", - "member": "Ext.layout.component.Component", - "doc": "Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 90, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-needsLayout", - "shortDoc": "Check if the new size is different from the current size and only\ntrigger a layout if it is necessary.
\n" - }, - { - "tagname": "method", - "name": "setElementSize", - "member": "Ext.layout.component.Component", - "doc": "Set the size of any element supporting undefined, null, and values.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - }, - { - "type": "Object", - "name": "height", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 104, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-setElementSize", - "shortDoc": "Set the size of any element supporting undefined, null, and values.
\n" - }, - { - "tagname": "method", - "name": "setTargetSize", - "member": "Ext.layout.component.Component", - "doc": "Set the size of the target element.
\n", - "params": [ - { - "type": "Mixed", - "name": "width", - "doc": "The new width to set.
\n", - "optional": false - }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/component/Component.js", - "linenr": 138, - "html_filename": "Component5.html", - "href": "Component5.html#Ext-layout-component-Component-method-setTargetSize", - "shortDoc": "Set the size of the target element.
\n" - }, - { - "tagname": "method", - "name": "sizeBody", - "member": "Ext.layout.component.field.Field", - "doc": "Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.
\n", - "params": [ - { - "type": "Object", - "name": "info", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 105, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-method-sizeBody", - "shortDoc": "Perform sizing and alignment of the bodyEl (and children) to match the calculated insets.
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "elementId", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Error message displayed as content of an element with a given id elsewhere in the app
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 348, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-elementId" - }, - { - "tagname": "property", - "name": "errorStrategies", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "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 Ext.form.field.Field.msgTarget config.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 240, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-errorStrategies", - "shortDoc": "Collection of named strategies for laying out and adjusting insets to accommodate error messages.\nAn appropriate one ..." - }, - { - "tagname": "property", - "name": "labelStrategies", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "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 Ext.form.field.Field.labelAlign config.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 160, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-labelStrategies", - "shortDoc": "Collection of named strategies for laying out and adjusting labels to accommodate error messages.\nAn appropriate one ..." - }, - { - "tagname": "property", - "name": "left", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Label displayed to the left of the bodyEl
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 226, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-left" - }, - { - "tagname": "property", - "name": "qtip", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Error displayed as QuickTip on hover of the field container
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 327, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-qtip" - }, - { - "tagname": "property", - "name": "right", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Same as left, only difference is text-align in CSS
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 231, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-right" - }, - { - "tagname": "property", - "name": "side", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Error displayed as icon (with QuickTip on hover) to right of the bodyEl
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 273, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-side" - }, - { - "tagname": "property", - "name": "sizeBodyContents", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "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.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 124, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-sizeBodyContents", - "shortDoc": "Size the contents of the field body, given the full dimensions of the bodyEl. Does nothing by\ndefault, subclasses can..." - }, - { - "tagname": "property", - "name": "title", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Error displayed as title tip on hover of the field container
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 338, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-title" - }, - { - "tagname": "property", - "name": "top", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Label displayed above the bodyEl
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 213, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-top" - }, - { - "tagname": "property", - "name": "under", - "member": "Ext.layout.component.field.Field", - "type": "Object", - "doc": "Error message displayed underneath the bodyEl
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 301, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field-property-under" - } - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/component/field/Field.js", - "linenr": 1, - "html_filename": "Field2.html", - "href": "Field2.html#Ext-layout-component-field-Field", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.layout.Layout", - "Ext.layout.component.Component" - ], - "subclasses": [ - "Ext.layout.component.field.File", - "Ext.layout.component.field.HtmlEditor", - "Ext.layout.component.field.Slider", - "Ext.layout.component.field.Text", - "Ext.layout.component.field.TextArea", - "Ext.layout.component.field.Trigger" - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_layout_component_field_Field({"tagname":"class","html":"Hierarchy
Ext.BaseExt.layout.LayoutExt.layout.component.ComponentExt.layout.component.field.FieldUses
Files
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
Layout class for components with field labeling, handling the sizing and alignment of\nthe form control, label, and error message treatment.
\nError message displayed as content of an element with a given id elsewhere in the app
\nError message displayed as content of an element with a given id elsewhere in the app
\nCollection 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 Ext.form.Labelable.msgTarget config.
\nCollection 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 Ext.form.Labelable.labelAlign config.
\nError displayed as QuickTip on hover of the field container
\nError displayed as QuickTip on hover of the field container
\nSame as left, only difference is text-align in CSS
\nSame as left, only difference is text-align in CSS
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nError displayed as icon (with QuickTip on hover) to right of the bodyEl
\nError displayed as icon (with QuickTip on hover) to right of the bodyEl
\nSize 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.
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nDestroys this layout. This is a template method that is empty by default, but should be implemented\nby subclasses that require explicit destruction to purge event handlers or remove DOM nodes.
\nThis is a template method. A hook into the functionality of this class.Feel free to override it in child classes.
Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarget config.
\nReturn the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAlign config.
\nReturns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.
\n\n\nMay be overridden in Component layout managers which implement an inner element.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nUse 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.
\nPerform sizing and alignment of the bodyEl (and children) to match the calculated insets.
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n