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

Class: PhpExt_Layout_TableLayout

Source Location: /PhpExt/Layout/TableLayout.php

Class PhpExt_Layout_TableLayout

Class Overview

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.

In the case of TableLayout, the only valid layout config property is columns. However, the items added to a TableLayout can supply table-specific config properties of rowspan and colspan with the PhpExt_Layout_TableLayoutData, when adding the component to the container with table layout.

The basic concept of building up a TableLayout is conceptually very similar to building up a standard HTML table. You simply add each panel (or "cell") that you want to include along with any span attributes specified as the special config properties of rowspan and colspan which work exactly like their HTML counterparts. Rather than explicitly creating and nesting rows and columns as you would in HTML, you simply specify the total column count in the TableLayout and start adding panels in their natural order from left to right, top to bottom. The layout will automatically figure out, based on the column count, rowspans and colspans, how to position each panel within the table. Just like with HTML tables, your rowspans and colspans must add up correctly in your overall layout or you'll end up with missing and/or extra cells!

Located in /PhpExt/Layout/TableLayout.php [line 32]

PhpExt_Object
   |
   --PhpExt_Layout_ContainerLayout
      |
      --PhpExt_Layout_TableLayout
Author(s):
API Tags:
See:  PhpExt_Layout_TableLayoutData

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From PhpExt_Layout_ContainerLayout

PhpExt_Layout_ContainerLayout::$_validLayoutDataClassNames

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName
PhpExt_Object::$_extConfigProperties
PhpExt_Object::$_validExtConfigProperties
PhpExt_Object::$_varName

Inherited From PhpExt_Layout_ContainerLayout

PhpExt_Layout_ContainerLayout::__construct()
PhpExt_Layout_ContainerLayout::addValidLayoutDataClassName()
PhpExt_Layout_ContainerLayout::addValidLayoutProperties()
Adds the layout specific valid properties
PhpExt_Layout_ContainerLayout::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.
PhpExt_Layout_ContainerLayout::getLayoutKey()
Returns the internal config string for the layout.
PhpExt_Layout_ContainerLayout::getRenderHidden()
True to hide each contained item on render (defaults to false).
PhpExt_Layout_ContainerLayout::getValidLayoutDataClassNames()
PhpExt_Layout_ContainerLayout::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).

Inherited From PhpExt_Object

PhpExt_Object::__construct()
PhpExt_Object::addValidConfigProperties()
PhpExt_Object::createMethodSignature()
PhpExt_Object::getConfigParams()
PhpExt_Object::getExtConfigProperty()
PhpExt_Object::getJavascript()
PhpExt_Object::getMethodInvokeStm()
PhpExt_Object::isExtObject()
PhpExt_Object::paramToString()
PhpExt_Object::setExtClassInfo()
PhpExt_Object::setExtConfigProperty()
PhpExt_Object::__get()
PhpExt_Object::__set()

Inherited From PhpExt_Layout_ContainerLayout

PhpExt_Layout_ContainerLayout::LAYOUT_ABSOLUTE
PhpExt_Layout_ContainerLayout::LAYOUT_ACCORDION
PhpExt_Layout_ContainerLayout::LAYOUT_ANCHOR
PhpExt_Layout_ContainerLayout::LAYOUT_BORDER
PhpExt_Layout_ContainerLayout::LAYOUT_CARD
PhpExt_Layout_ContainerLayout::LAYOUT_COLUMN
PhpExt_Layout_ContainerLayout::LAYOUT_DEFAULT
PhpExt_Layout_ContainerLayout::LAYOUT_FIT
PhpExt_Layout_ContainerLayout::LAYOUT_FORM
PhpExt_Layout_ContainerLayout::LAYOUT_TAB
PhpExt_Layout_ContainerLayout::LAYOUT_TABLE

[ Top ]
Method Summary
PhpExt_Layout_TableLayout   __construct()  
integer   getColumns()   The total number of columns to create in the table for this layout. If not specified, all panels added to this layout will be rendered into a single row using a column per panel.
string   getLayoutKey()   Returns the internal config string for the layout.
PhpExt_Layout_TableLayout   setColumns()   The total number of columns to create in the table for this layout. If not specified, all panels added to this layout will be rendered into a single row using a column per panel.

[ Top ]
Methods
Constructor __construct  [line 63]

  PhpExt_Layout_TableLayout __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Layout_ContainerLayout::__construct()

[ Top ]
getColumns  [line 48]

  integer getColumns( )

The total number of columns to create in the table for this layout. If not specified, all panels added to this layout will be rendered into a single row using a column per panel.


API Tags:
Access:  public


[ Top ]
getLayoutKey  [line 59]

  string getLayoutKey( )

Returns the internal config string for the layout.


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


Redefinition of:
PhpExt_Layout_ContainerLayout::getLayoutKey()
Returns the internal config string for the layout.

[ Top ]
setColumns  [line 40]

  PhpExt_Layout_TableLayout setColumns( integer $value  )

The total number of columns to create in the table for this layout. If not specified, all panels added to this layout will be rendered into a single row using a column per panel.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:00:47 -0500 by phpDocumentor 1.4.0