Class: PhpExt_Layout_AccordionLayout

Source Location: /PhpExt/Layout/AccordionLayout.php

Class PhpExt_Layout_AccordionLayout

Class Overview

This is a layout that contains multiple panels in an expandable accordion style such that only one panel can be open at any given time. Each panel has built-in support for expanding and collapsing.

Panels added to the items collection of the container will render in an accordion style.

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

PhpExt_Object
   |
   --PhpExt_Layout_ContainerLayout
      |
      --PhpExt_Layout_FitLayout
         |
         --PhpExt_Layout_AccordionLayout

Author(s):

API Tags:

See:	PhpExt_Layout_AccordionLayoutData
Usedby:	PhpExt_Container::getLayout()
Usedby:	PhpExt_Container::setLayout()

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_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_AccordionLayout	__construct()
boolean	getActiveOnTop()	True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order. This is NOT compatible with "animate:true" (defaults to false).
boolean	getAnimate()	True to slide the contained panels open and closed during expand/collapse using animation, false to open and close directly with no animation (defaults to false). Note: to defer to the specific config setting of each contained panel for this property, set this to undefined at the layout level.
boolean	getAutoWidth()	True to set each contained item's width to 'auto', false to use the item's current width (defaults to true).
boolean	getCollapseFirst()	True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the contained panels' title bars, false to render it last (defaults to false).
boolean	getFill()	True to adjust the active item's height to fill the available space in the container, false to use the item's current height, or auto height if not explicitly set (defaults to true).
boolean	getHideCollapseTool()	True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false). When set to true, titleCollapse should be true also.
string	getLayoutKey()	Returns the internal config string for the layout.
boolean	getSequence()	Experimental. If animate is set to true, this will result in each animation running in sequence.
boolean	getTitleCollapse()	True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false, hideCollapseTool should be false also.
PhpExt_Layout_AccordionLayout	setActiveOnTop()	True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order. This is NOT compatible with "animate:true" (defaults to false).
PhpExt_Layout_AccordionLayout	setAnimate()	True to slide the contained panels open and closed during expand/collapse using animation, false to open and close directly with no animation (defaults to false). Note: to defer to the specific config setting of each contained panel for this property, set this to undefined at the layout level.
PhpExt_Layout_AccordionLayout	setAutoWidth()	True to set each contained item's width to 'auto', false to use the item's current width (defaults to true).
PhpExt_Layout_AccordionLayout	setCollapseFirst()	True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the contained panels' title bars, false to render it last (defaults to false).
PhpExt_Layout_AccordionLayout	setFill()	True to adjust the active item's height to fill the available space in the container, false to use the item's current height, or auto height if not explicitly set (defaults to true).
PhpExt_Layout_AccordionLayout	setHideCollapseTool()	True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false). When set to true, titleCollapse should be true also.
PhpExt_Layout_AccordionLayout	setSequence()	Experimental. If animate is set to true, this will result in each animation running in sequence.
PhpExt_Layout_AccordionLayout	setTitleCollapse()	True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false, hideCollapseTool should be false also.

[ Top ]

Properties

Methods

Constructor __construct [line 186]

PhpExt_Layout_AccordionLayout __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Layout_FitLayout::__construct()

[ Top ]

getActiveOnTop [line 44]

boolean getActiveOnTop(
)

True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order. This is NOT compatible with "animate:true" (defaults to false).

API Tags:

Access:

public

[ Top ]

getAnimate [line 62]

boolean getAnimate(
)

True to slide the contained panels open and closed during expand/collapse using animation, false to open and close directly with no animation (defaults to false). Note: to defer to the specific config setting of each contained panel for this property, set this to undefined at the layout level.

API Tags:

Access:

public

[ Top ]

getAutoWidth [line 80]

boolean getAutoWidth(
)

True to set each contained item's width to 'auto', false to use the item's current width (defaults to true).

API Tags:

Access:

public

[ Top ]

getCollapseFirst [line 99]

boolean getCollapseFirst(
)

True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the contained panels' title bars, false to render it last (defaults to false).

API Tags:

Access:

public

[ Top ]

getFill [line 117]

boolean getFill(
)

True to adjust the active item's height to fill the available space in the container, false to use the item's current height, or auto height if not explicitly set (defaults to true).

API Tags:

Access:

public

[ Top ]

getHideCollapseTool [line 135]

boolean getHideCollapseTool(
)

True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false). When set to true, titleCollapse should be true also.

API Tags:

Access:

public

[ Top ]

getLayoutKey [line 182]

string getLayoutKey(
)

Returns the internal config string for the layout.

API Tags:

See:	PhpExt_Layout_ContainerLayout::LAYOUT_ACCORDION;
Access:	public

Redefinition of:

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

[ Top ]

getSequence [line 153]

boolean getSequence(
)

Experimental. If animate is set to true, this will result in each animation running in sequence.

API Tags:

Access:

public

[ Top ]

getTitleCollapse [line 171]

boolean getTitleCollapse(
)

True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked (defaults to true). When set to false, hideCollapseTool should be false also.

API Tags:

Access:

public

[ Top ]

setActiveOnTop [line 36]

PhpExt_Layout_AccordionLayout setActiveOnTop(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAnimate [line 54]

PhpExt_Layout_AccordionLayout setAnimate(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setAutoWidth [line 72]

PhpExt_Layout_AccordionLayout setAutoWidth(
boolean
$value 
)

True to set each contained item's width to 'auto', false to use the item's current width (defaults to true).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setCollapseFirst [line 91]

PhpExt_Layout_AccordionLayout setCollapseFirst(
boolean
$value 
)

True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the contained panels' title bars, false to render it last (defaults to false).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setFill [line 109]

PhpExt_Layout_AccordionLayout setFill(
boolean
$value 
)

True to adjust the active item's height to fill the available space in the container, false to use the item's current height, or auto height if not explicitly set (defaults to true).

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setHideCollapseTool [line 127]

PhpExt_Layout_AccordionLayout setHideCollapseTool(
boolean
$value 
)

True to hide the contained panels' collapse/expand toggle buttons, false to display them (defaults to false). When set to true, titleCollapse should be true also.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setSequence [line 145]

PhpExt_Layout_AccordionLayout setSequence(
boolean
$value 
)

Experimental. If animate is set to true, this will result in each animation running in sequence.

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

setTitleCollapse [line 163]

PhpExt_Layout_AccordionLayout setTitleCollapse(
boolean
$value 
)

Parameters:

boolean

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:49:37 -0500 by phpDocumentor 1.4.0