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

Class: PhpExt_Layout_CardLayout

Source Location: /PhpExt/Layout/CardLayout.php

Class PhpExt_Layout_CardLayout

Class Overview

This layout contains multiple panels, each fit to the container, where only a single panel can be visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc.

The CardLayout's focal method is setActiveItem. Since only one panel is displayed at a time, the only way to move from one panel to the next is by calling setActiveItem, passing the id or index of the next panel to display. The layout itself does not provide a mechanism for handling this navigation, so that functionality must be provided by the developer.

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

PhpExt_Object
   |
   --PhpExt_Layout_ContainerLayout
      |
      --PhpExt_Layout_FitLayout
         |
         --PhpExt_Layout_CardLayout
Author(s):
API Tags:
See:  PhpExt_Layout_CardLayoutData

Methods

[ Top ]
Descendants
Child Class Description
PhpExt_Layout_TabLayout This layout contains multiple panels, each fit to the container, where only a single panel can be visible at any given time. This layout style is most commonly used for wizards, tab implementations, etc.

[ 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_FitLayout

PhpExt_Layout_FitLayout::__construct()
PhpExt_Layout_FitLayout::getLayoutKey()
Returns the internal config string for the layout.

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_CardLayout   __construct()  
boolean   getDeferredRender()  
string   getLayoutKey()   Returns the internal config string for the layout.
PhpExt_Layout_CardLayout   setDeferredRender()   True to render each contained item at the time it becomes active, false to render all contained items as soon as the layout is rendered (defaults to false). If there is a significant amount of content or a lot of heavy controls being rendered into panels that are not displayed by default, setting this to true might improve performance.

[ Top ]
Methods
Constructor __construct  [line 58]

  PhpExt_Layout_CardLayout __construct( )


API Tags:
Access:  public


Redefinition of:
PhpExt_Layout_FitLayout::__construct()

Redefined in descendants as:

[ Top ]
getDeferredRender  [line 44]

  boolean getDeferredRender( )


API Tags:
Access:  public


[ Top ]
getLayoutKey  [line 54]

  string getLayoutKey( )

Returns the internal config string for the layout.


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


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

Redefined in descendants as:

[ Top ]
setDeferredRender  [line 36]

  PhpExt_Layout_CardLayout setDeferredRender( boolean $value  )

True to render each contained item at the time it becomes active, false to render all contained items as soon as the layout is rendered (defaults to false). If there is a significant amount of content or a lot of heavy controls being rendered into panels that are not displayed by default, setting this to true might improve performance.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:50:51 -0500 by phpDocumentor 1.4.0