X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..refs/heads/master:/docs/output/Ext.grid.ColumnLayout.js diff --git a/docs/output/Ext.grid.ColumnLayout.js b/docs/output/Ext.grid.ColumnLayout.js index 0d1d592e..ccdcd3d8 100644 --- a/docs/output/Ext.grid.ColumnLayout.js +++ b/docs/output/Ext.grid.ColumnLayout.js @@ -1,266 +1 @@ -Ext.data.JsonP.Ext_grid_ColumnLayout({ - "tagname": "class", - "name": "Ext.grid.ColumnLayout", - "doc": "
This class is used only by the grid's HeaderContainer docked child.
\n\n\n\n\nThis class adds the ability to shrink the vertical size of the inner container element back if a grouped\ncolumn header has all its child columns dragged out, and the whole HeaderContainer needs to shrink back down.
\n\n\n\n\nIt also enforces the grid's HeaderContainer's forceFit config by, after every calaculateChildBoxes call, converting\nall pixel widths into flex values, so that propertions are maintained upon width change of the grid.
\n\n\n\n\nAlso, after every layout, after all headers have attained their 'stretchmax' height, it goes through and calls\nsetPadding
on the columns so that they lay out correctly. TODO: implement a ColumnHeader component\nlayout which takes responsibility for this, and will run upon resize.
Controls how the child items of the container are aligned. Acceptable configuration values for this\nproperty are:
\n\nIf truthy, child Component are animated into position whenever the Container\nis layed out. If this option is numeric, it is used as the animation duration in milliseconds.
\n\n\nMay be set as a property at any time.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js", - "linenr": 25, - "html_filename": "Box.html", - "href": "Box.html#Ext-layout-container-Box-cfg-animate", - "shortDoc": "If truthy, child Component are animated into position whenever the Container\nis layed out. If this option is numeric,..." - }, - { - "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": "clearInnerCtOnLayout", - "member": "Ext.layout.container.Box", - "type": "Boolean", - "doc": "\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js", - "linenr": 128, - "html_filename": "Box.html", - "href": "Box.html#Ext-layout-container-Box-cfg-clearInnerCtOnLayout" - }, - { - "tagname": "cfg", - "name": "defaultMargins", - "member": "Ext.layout.container.Box", - "type": "Object", - "doc": "If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default margins from this property will be\napplied to each item.
\n\n\nThis property may be specified as an object containing margins\n\n\n
to apply in the format:
\n\n{\n top: (top margin),\n right: (right margin),\n bottom: (bottom margin),\n left: (left margin)\n}
\n\n\nThis property may also be specified as a string containing\nspace-separated, numeric margin values. The order of the sides associated\nwith each value matches the way CSS processes margin values:
\n\n\nDefaults to:
\n\n\n{top:0, right:0, bottom:0, left:0}\n
\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js",
- "linenr": 32,
- "html_filename": "Box.html",
- "href": "Box.html#Ext-layout-container-Box-cfg-defaultMargins",
- "shortDoc": "If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default m..."
- },
- {
- "tagname": "cfg",
- "name": "flex",
- "member": "Ext.layout.container.Box",
- "type": "Number",
- "doc": "This configuration option is to be applied to child items of the container managed\nby this layout. Each child item with a flex property will be flexed horizontally\naccording to each item's relative flex value compared to the sum of all items with\na flex value specified. Any child items that have either a flex = 0 or\nflex = undefined will not be 'flexed' (the initial size will not be changed).
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js", - "linenr": 102, - "html_filename": "Box.html", - "href": "Box.html#Ext-layout-container-Box-cfg-flex", - "shortDoc": "This configuration option is to be applied to child items of the container managed\nby this layout. Each child item wi..." - }, - { - "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..." - }, - { - "tagname": "cfg", - "name": "pack", - "member": "Ext.layout.container.Box", - "type": "String", - "doc": "Controls how the child items of the container are packed together. Acceptable configuration values\nfor this property are:
\n\nSets the padding to be applied to all child items managed by this layout.
\n\n\nThis property must be specified as a string containing\nspace-separated, numeric padding values. The order of the sides associated\nwith each value matches the way CSS processes padding values:
\n\n\nDefaults to: \"0\"
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" - }, - { - "tagname": "method", - "name": "updateChildBoxes", - "member": "Ext.layout.container.Box", - "doc": "Resizes and repositions each child component
\n", - "params": [ - { - "type": "Array", - "name": "boxes", - "doc": "The box measurements
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/layout/container/Box.js", - "linenr": 580, - "html_filename": "Box.html", - "href": "Box.html#Ext-layout-container-Box-method-updateChildBoxes", - "shortDoc": "Resizes and repositions each child component
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/grid/ColumnLayout.js", - "linenr": 1, - "html_filename": "ColumnLayout.html", - "href": "ColumnLayout.html#Ext-grid-ColumnLayout", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.layout.Layout", - "Ext.layout.container.AbstractContainer", - "Ext.layout.container.Container", - "Ext.layout.container.Box", - "Ext.layout.container.HBox" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_grid_ColumnLayout({"tagname":"class","html":"Hierarchy
Files
NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.
This class is used only by the grid's HeaderContainer docked child.
\n\n\n\n\nIt adds the ability to shrink the vertical size of the inner container element back if a grouped\ncolumn header has all its child columns dragged out, and the whole HeaderContainer needs to shrink back down.
\n\n\n\n\nAlso, after every layout, after all headers have attained their 'stretchmax' height, it goes through and calls\nsetPadding
on the columns so that they lay out correctly.
Controls how the child items of the container are aligned. Acceptable configuration values for this property are:
\n\nDefaults to: "top"
If truthy, child Component are animated into position whenever the Container\nis layed out. If this option is numeric, it is used as the animation duration in milliseconds.
\n\n\nMay be set as a property at any time.
\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
If the individual contained items do not have a margins\nproperty specified or margin specified via CSS, the default margins from this property will be\napplied to each item.
\n\n\nThis property may be specified as an object containing margins\n\n\n
to apply in the format:
\n\n{\n top: (top margin),\n right: (right margin),\n bottom: (bottom margin),\n left: (left margin)\n}
\n\n\nThis property may also be specified as a string containing\nspace-separated, numeric margin values. The order of the sides associated\nwith each value matches the way CSS processes margin values:
\n\n\nDefaults to: {top: 0, right: 0, bottom: 0, left: 0}
This configuration option is to be applied to child items of the container managed\nby this layout. Each child item with a flex property will be flexed horizontally\naccording to each item's relative flex value compared to the sum of all items with\na flex value specified. Any child items that have either a flex = 0 or\nflex = undefined will not be 'flexed' (the initial size will not be changed).
\nAn 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\nControls how the child items of the container are packed together. Acceptable configuration values\nfor this property are:
\n\nSets the padding to be applied to all child items managed by this layout.
\n\n\nThis property must be specified as a string containing\nspace-separated, numeric padding values. The order of the sides associated\nwith each value matches the way CSS processes padding values:
\n\n\nDefaults to: "0"
True (the default) to allow fixed size components to shrink (limited to their\nminimum size) to avoid overflow. False to preserve fixed sizes even if they cause\noverflow.
\nDefaults to: true
Get 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