X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..HEAD:/docs/output/Ext.layout.container.Column.js?ds=sidebyside diff --git a/docs/output/Ext.layout.container.Column.js b/docs/output/Ext.layout.container.Column.js index 018c0327..34ae9731 100644 --- a/docs/output/Ext.layout.container.Column.js +++ b/docs/output/Ext.layout.container.Column.js @@ -1,150 +1 @@ -Ext.data.JsonP.Ext_layout_container_Column({ - "tagname": "class", - "name": "Ext.layout.container.Column", - "doc": "
This is the layout style of choice for creating structural layouts in a multi-column format where the width of\neach column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.\nThis class is intended to be extended or created via the layout:'column' Ext.container.Container.layout config,\nand should generally not need to be created directly via the new keyword.
\n\n\nColumnLayout does not have any direct config options (other than inherited ones), but it does support a\nspecific config property of columnWidth that can be included in the config of any panel added to it. The\nlayout will use the columnWidth (if present) or width of each panel during layout to determine how to size each panel.\nIf width or columnWidth is not specified for a given panel, its width will default to the panel's width (or auto).
\n\n\nThe width property is always evaluated as pixels, and must be a number greater than or equal to 1.\nThe columnWidth property is always evaluated as a percentage, and must be a decimal value greater than 0 and\nless than 1 (e.g., .25).
\n\n\nThe basic rules for specifying column widths are pretty simple. The logic makes two passes through the\nset of contained panels. During the first layout pass, all panels that either have a fixed width or none\nspecified (auto) are skipped, but their widths are subtracted from the overall container width. During the second\npass, all panels with columnWidths are assigned pixel widths in proportion to their percentages based on\nthe total remaining container width. In other words, percentage width panels are designed to fill the space\nleft over by all the fixed-width and/or auto-width panels. Because of this, while you can specify any number of columns\nwith different percentages, the columnWidths must always add up to 1 (or 100%) when added together, otherwise your\nlayout may not render as expected. \n
\nExample usage:\n\n\n // All columns are percentages -- they must add up to 1\n Ext.create('Ext.panel.Panel', {\n title: 'Column Layout - Percentage Only',\n width: 350,\n height: 250,\n layout:'column',\n items: [{\n title: 'Column 1',\n columnWidth: .25\n },{\n title: 'Column 2',\n columnWidth: .55\n },{\n title: 'Column 3',\n columnWidth: .20\n }],\n renderTo: Ext.getBody()\n }); \n\n// \n// Mix of width and columnWidth -- all columnWidth values must add up\n// to 1. The first column will take up exactly 120px, and the last two\n// columns will fill the remaining container width.\n\n Ext.create('Ext.Panel', {\n title: 'Column Layout - Mixed',\n width: 350,\n height: 250,\n layout:'column',\n items: [{\n title: 'Column 1',\n width: 120\n },{\n title: 'Column 2',\n columnWidth: .7\n },{\n title: 'Column 3',\n columnWidth: .3\n }],\n renderTo: Ext.getBody()\n }); \n
\n\n",
- "extends": "Ext.layout.container.Auto",
- "mixins": [
-
- ],
- "alternateClassNames": [
- "Ext.layout.ColumnLayout"
- ],
- "xtype": null,
- "author": null,
- "docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "bindToOwnerCtComponent",
- "member": "Ext.layout.container.AbstractContainer",
- "type": "Boolean",
- "doc": "Flag to notify the ownerCt Component on afterLayout of a change
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 24, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtComponent" - }, - { - "tagname": "cfg", - "name": "bindToOwnerCtContainer", - "member": "Ext.layout.container.AbstractContainer", - "type": "Boolean", - "doc": "Flag to notify the ownerCt Container on afterLayout of a change
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 30, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-bindToOwnerCtContainer" - }, - { - "tagname": "cfg", - "name": "itemCls", - "member": "Ext.layout.container.AbstractContainer", - "type": "String", - "doc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to the container or any of its children using standard CSS rules. See\nExt.Component.ctCls also.
\n\n\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 36, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-cfg-itemCls", - "shortDoc": "An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to t..." - } - ], - "method": [ - { - "tagname": "method", - "name": "getLayoutItems", - "member": "Ext.layout.container.AbstractContainer", - "doc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\nbase class), or the layout phase (onLayout).
\n\n", - "params": [ - - ], - "return": { - "type": "Array", - "doc": "of child components
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/layout/container/AbstractContainer.js", - "linenr": 87, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getLayoutItems", - "shortDoc": "Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\n..." - }, - { - "tagname": "method", - "name": "getRenderTarget", - "member": "Ext.layout.container.AbstractContainer", - "doc": "Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.targetEl.
\n\n\nMay be overridden in 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/container/AbstractContainer.js", - "linenr": 106, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getRenderTarget", - "shortDoc": "Returns the element into which rendering must take place. Defaults to the owner Container's Ext.AbstractComponent.tar..." - }, - { - "tagname": "method", - "name": "getTarget", - "member": "Ext.layout.container.AbstractContainer", - "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/container/AbstractContainer.js", - "linenr": 99, - "html_filename": "AbstractContainer2.html", - "href": "AbstractContainer2.html#Ext-layout-container-AbstractContainer-method-getTarget", - "shortDoc": "Returns the owner component's resize element.
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Column.js", - "linenr": 1, - "html_filename": "Column2.html", - "href": "Column2.html#Ext-layout-container-Column", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.layout.Layout", - "Ext.layout.container.AbstractContainer", - "Ext.layout.container.Container", - "Ext.layout.container.Auto" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_layout_container_Column({"tagname":"class","html":"Alternate names
Ext.layout.ColumnLayoutHierarchy
Files
This is the layout style of choice for creating structural layouts in a multi-column format where the width of each\ncolumn can be specified as a percentage or fixed width, but the height is allowed to vary based on the content. This\nclass is intended to be extended or created via the layout:'column' Ext.container.Container.layout config,\nand should generally not need to be created directly via the new keyword.
\n\nColumnLayout does not have any direct config options (other than inherited ones), but it does support a specific\nconfig property of columnWidth
that can be included in the config of any panel added to it. The layout will use\nthe columnWidth (if present) or width of each panel during layout to determine how to size each panel. If width or\ncolumnWidth is not specified for a given panel, its width will default to the panel's width (or auto).
The width property is always evaluated as pixels, and must be a number greater than or equal to 1. The columnWidth\nproperty is always evaluated as a percentage, and must be a decimal value greater than 0 and less than 1 (e.g., .25).
\n\nThe basic rules for specifying column widths are pretty simple. The logic makes two passes through the set of\ncontained panels. During the first layout pass, all panels that either have a fixed width or none specified (auto)\nare skipped, but their widths are subtracted from the overall container width.
\n\nDuring the second pass, all panels with columnWidths are assigned pixel widths in proportion to their percentages\nbased on the total remaining container width. In other words, percentage width panels are designed to fill\nthe space left over by all the fixed-width and/or auto-width panels. Because of this, while you can specify any\nnumber of columns with different percentages, the columnWidths must always add up to 1 (or 100%) when added\ntogether, otherwise your layout may not render as expected.
\n\n// All columns are percentages -- they must add up to 1\nExt.create('Ext.panel.Panel', {\n title: 'Column Layout - Percentage Only',\n width: 350,\n height: 250,\n layout:'column',\n items: [{\n title: 'Column 1',\n columnWidth: .25\n },{\n title: 'Column 2',\n columnWidth: .55\n },{\n title: 'Column 3',\n columnWidth: .20\n }],\n renderTo: Ext.getBody()\n});\n\n// Mix of width and columnWidth -- all columnWidth values must add up\n// to 1. The first column will take up exactly 120px, and the last two\n// columns will fill the remaining container width.\n\nExt.create('Ext.Panel', {\n title: 'Column Layout - Mixed',\n width: 350,\n height: 250,\n layout:'column',\n items: [{\n title: 'Column 1',\n width: 120\n },{\n title: 'Column 2',\n columnWidth: .7\n },{\n title: 'Column 3',\n columnWidth: .3\n }],\n renderTo: Ext.getBody()\n});\n
\nFlag to notify the ownerCt Component on afterLayout of a change
\nDefaults to: false
Flag to notify the ownerCt Container on afterLayout of a change
\nDefaults to: false
An optional extra CSS class that will be added to the container. This can be useful for adding\ncustomized styles to the container or any of its children using standard CSS rules. See\nExt.Component.componentCls also.
\n\n\n\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
\nContainers should not lay out child components when collapsed.
\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.
Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's\nbase class), or the layout phase (onLayout).
\n\nof child components
\nReturns the element into which rendering must take place. Defaults to the owner Container's target element.
\n\n\nMay be overridden in 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
\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