Layout
  ComponentLayout
    DockLayout

Class Ext.layout.DockLayout

Package:	Ext.layout
Defined In:	DockLayout.js
Class:	DockLayout
Extends:	ComponentLayout

This ComponentLayout handles docking for Panels. It takes care of panels that are part of a ContainerLayout that sets this Panel's size and Panels that are part of an AutoContainerLayout in which this panel get his height based of the CSS or or its content.

Public Properties

Property		Defined By
	itemCls : String This class is automatically added to each docked item within this layout. We also use this as a prefix for the position class e.g. x-docked-bottom	DockLayout

Public Methods

Method		Defined By
	adjustAutoBox( `Object box`, `Number index` ) : Object Parameters: `box` : Object The box containing information about the width and height of this docked item `index` : Number The index position of this docked item Returns: `Object` The adjusted box	DockLayout
	adjustSizedBox( `Object box`, `Number index` ) : Object Parameters: `box` : Object The box containing information about the width and height of this docked item `index` : Number The index position of this docked item Returns: `Object` The adjusted box	DockLayout
	calculateDockBoxes( `Array items` ) : void Parameters: `items` : Array Array containing all the docked items we have to layout Returns: void	DockLayout
	configureItem( `Ext.Component item` ) : void Parameters: `item` : Ext.Component The item we are configuring Returns: void	DockLayout
	dockItems( `Array items`, `Boolean autoBoxes` ) : void Parameters: `items` : Array Array containing all the docked items `autoBoxes` : Boolean Set this to true if the Panel is part of an AutoContainerLayout Returns: void	DockLayout
	getLayoutItems() : Array Parameters: None. Returns: `Array` An array containing all the docked items of the Panel	DockLayout
	getTarget() : Ext.Element Returns the owner component's resize element. Returns the owner component's resize element. Parameters: None. Returns: `Ext.Element`	ComponentLayout
	initBox( `Ext.Component item` ) : Object Parameters: `item` : Ext.Component The docked item we want to initialize the box for Returns: `Object` The initial box containing width and height and other useful information	DockLayout
	needsLayout( `Mixed width`, `Mixed height` ) : void Check if the new size is different from the current size and only trigger a layout if it is necessary. Check if the new size is different from the current size and only trigger a layout if it is necessary. Parameters: `width` : Mixed The new width to set. `height` : Mixed The new height to set. Returns: void	ComponentLayout
	onLayout( `Ext.Component owner`, `Ext.Element target`, `Array args` ) : void Parameters: `owner` : Ext.Component The Panel that owns this DockLayout `target` : Ext.Element The target in which we are going to render the docked items `args` : Array The arguments passed to the ComponentLayout.layout method Returns: void	DockLayout
	setBodyBox( `Object box` ) : void Parameters: `box` : Object An object containing new x, y, width and height values for the Panel's body Returns: void	DockLayout
	setElementSize( `Mixed width`, `Mixed height` ) : void Set the size of any element supporting undefined, null, and values. Set the size of any element supporting undefined, null, and values. Parameters: `width` : Mixed The new width to set. `height` : Mixed The new height to set. Returns: void	ComponentLayout
	setTargetSize( `Mixed width`, `Mixed height` ) : void Set the size of the target element. Set the size of the target element. Parameters: `width` : Mixed The new width to set. `height` : Mixed The new height to set. Returns: void	ComponentLayout

Public Events

This class has no public events.