PhpExt : Layout [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Layout_ContainerLayout

Source Location: /PhpExt/Layout/ContainerLayout.php

Class PhpExt_Layout_ContainerLayout

Class Overview

Every layout is composed of one or more Ext.Container elements internally, and ContainerLayout provides the basic foundation for all other layout classes in Ext.

It is a non-visual class that simply provides the base logic required for a Container to function as a layout. This class is intended to be extended and should generally not need to be created directly via the new keyword.

Located in /PhpExt/Layout/ContainerLayout.php [line 28]

PhpExt_Object
   |
   --PhpExt_Layout_ContainerLayout
Author(s):
API Tags:
Usedby:  PhpExt_Container::getLayout()
Usedby:  PhpExt_Container::setLayout()

Properties

Methods

[ Top ]
Descendants
Child Class Description
PhpExt_Layout_AnchorLayout This is a layout that enables anchoring of contained elements relative to the container's dimensions. If the container is resized, all anchored items are automatically rerendered according to their anchor rules.
PhpExt_Layout_BorderLayout This is a multi-pane, application-oriented UI layout style that supports multiple nested panels, automatic split bars between regions and built-in expanding and collapsing of regions.
PhpExt_Layout_ColumnLayout This is the layout style of choice for creating structural layouts in a multi-column format where the width of each column can be specified as a percentage or fixed width, but the height is allowed to vary based on the content.
PhpExt_Layout_FitLayout This is a base class for layouts that contain a single item that automatically expands to fill the layout's container.
PhpExt_Layout_TableLayout This layout allows you to easily render content into an HTML table. The total number of columns can be specified, and rowspan and colspan can be used to create complex layouts within the table.

[ Top ]
Method Summary
PhpExt_Layout_ContainerLayout   __construct()  
void   addValidLayoutDataClassName()  
void   addValidLayoutProperties()   Adds the layout specific valid properties
string   getExtraCssClass()   An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
string   getLayoutKey()   Returns the internal config string for the layout.
boolean   getRenderHidden()   True to hide each contained item on render (defaults to false).
void   getValidLayoutDataClassNames()  
An   getValidLayoutProperties()   Gets the layout specific valid properties
PhpExt_Layout_ContainerLayout   setExtraCssClass()   An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.
PhpExt_Layout_ContainerLayout   setRenderHidden()   True to hide each contained item on render (defaults to false).

[ Top ]
Properties
mixed   $_validLayoutDataClassNames = array() [line 104]
API Tags:
Access:  protected


[ Top ]
Methods
addValidLayoutDataClassName  [line 110]

  void addValidLayoutDataClassName( $className  )

Parameters:
   $className: 

API Tags:
Access:  protected


[ Top ]
addValidLayoutProperties  [line 53]

  void addValidLayoutProperties( $validProps  )

Adds the layout specific valid properties

Parameters:
array   $validProps:  An array containing the layout specific valid property names

API Tags:
Access:  protected


[ Top ]
getExtraCssClass  [line 79]

  string getExtraCssClass( )

An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.


API Tags:
Access:  public


[ Top ]
getLayoutKey  [line 120]

  string getLayoutKey( )

Returns the internal config string for the layout.


API Tags:
See:  PhpExt_Layout_ContainerLayout::LAYOUT_DEFAULT;
Access:  public


Redefined in descendants as:

[ Top ]
getRenderHidden  [line 97]

  boolean getRenderHidden( )

True to hide each contained item on render (defaults to false).


API Tags:
Access:  public


[ Top ]
getValidLayoutDataClassNames  [line 106]

  void getValidLayoutDataClassNames( )


API Tags:
Access:  public


[ Top ]
getValidLayoutProperties  [line 61]

  An getValidLayoutProperties( )

Gets the layout specific valid properties


API Tags:
Return:  array containing the layout specific valid property names
Access:  public


[ Top ]
setExtraCssClass  [line 71]

  PhpExt_Layout_ContainerLayout setExtraCssClass( string $value  )

An optional extra CSS class that will be added to the container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
setRenderHidden  [line 89]

  PhpExt_Layout_ContainerLayout setRenderHidden( boolean $value  )

True to hide each contained item on render (defaults to false).

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]
Constants
LAYOUT_ABSOLUTE = 'absolute' [line 31]

[ Top ]
LAYOUT_ACCORDION = 'accordion' [line 32]

[ Top ]
LAYOUT_ANCHOR = 'anchor' [line 33]

[ Top ]
LAYOUT_BORDER = 'border' [line 34]

[ Top ]
LAYOUT_CARD = 'card' [line 35]

[ Top ]
LAYOUT_COLUMN = 'column' [line 36]

[ Top ]
LAYOUT_DEFAULT = null [line 30]

[ Top ]
LAYOUT_FIT = 'fit' [line 37]

[ Top ]
LAYOUT_FORM = 'form' [line 38]

[ Top ]
LAYOUT_TAB = 'card' [line 40]

[ Top ]
LAYOUT_TABLE = 'table' [line 39]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:52:14 -0500 by phpDocumentor 1.4.0