Sencha Documentation

Ext.layout.component.AbstractDock

Overview

Super classes

Ext.layout.AbstractLayoutExt.layout.Component

Sub classes

Ext.layout.component.Dock
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.

Properties

 
if : Object
Do not layout calculatedSized components for fixedLayouts unless the ownerCt == layoutOwner
 
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

Methods

 
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
 
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
 
calculateDockBoxes( Array items ) : Void

Parameters

  • items : Array
    Array containing all the docked items we have to layout

Returns

  • Void
 
configureItem( Ext.Component item ) : Void

Parameters

  • item : Ext.Component
    The item we are configuring

Returns

  • Void
 
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
 
getRenderTarget : Ext.core.Element

Returns the element into which rendering must take place. Defaults to the owner Component's encapsulating element.

May be overridden in Component layout managers which implement an inner element.
 
getTarget : Ext.core.Element
Returns the owner component's resize element.
 
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
 
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.

Parameters

  • width : Mixed
    The new width to set.
  • height : Mixed
    The new height to set.

Returns

  • Void
 
onLayout( Ext.Component owner, Ext.core.Element target, Array args ) : Void

Parameters

  • owner : Ext.Component
    The Panel that owns this DockLayout
  • target : Ext.core.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
 
setBodyBox( Object box ) : Void

Parameters

  • box : Object
    An object containing new x, y, width and height values for the Panel's body

Returns

  • Void
 
setElementSize( Mixed width, Mixed height ) : Void
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
 
setTargetSize( Mixed width, Mixed height ) : Void
Set the size of the target element.

Parameters

  • width : Mixed
    The new width to set.
  • height : Mixed
    The new height to set.

Returns

  • Void
© 2010 Sencha Inc.