Dojo/Form/Decorator/BorderContainer.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
\Zend_Dojo_Form_Decorator_BorderContainer
BorderContainer
Render a dijit BorderContainer
- Parent(s)
- \Zend_Dojo_Form_Decorator_DijitContainer < \Zend_Form_Decorator_Abstract
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Uses
- \global\Zend_Dojo_Form_Decorator_DijitContainer
- Version
- $Id: BorderContainer.php 24593 2012-01-05 20:35:02Z matthew $
Constants

APPEND
= 'APPEND'
Placement constants
Inherited from: \Zend_Form_Decorator_Abstract::APPEND\Zend_Dojo_Form_Decorator_DijitContainer::APPEND- Inherited_from
- \Zend_Form_Decorator_Abstract::APPEND
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::APPEND

PREPEND
= 'PREPEND'
- Inherited_from
- \Zend_Form_Decorator_Abstract::PREPEND
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::PREPEND
Properties


array $_attribs =
- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_attribs


array $_dijitParams =
Dijit option parameters
Inherited from: \Zend_Dojo_Form_Decorator_DijitContainer::$$_dijitParams- Type
- array
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_dijitParams


\Zend_Form_Element|\Zend_Form $_element =
- Type
- \Zend_Form_Element | \Zend_Form
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_element
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_element


array $_options = array()
Decorator options
Inherited from: \Zend_Form_Decorator_Abstract::$$_options\Zend_Dojo_Form_Decorator_DijitContainer::$$_optionsarray()
Details- Type
- array
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_options
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_options


string $_placement = 'APPEND'
Default placement: append
Inherited from: \Zend_Form_Decorator_Abstract::$$_placement\Zend_Dojo_Form_Decorator_DijitContainer::$$_placement'APPEND'
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_placement
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_placement


string $_separator = PHP_EOL
Separator between new content and old
Inherited from: \Zend_Form_Decorator_Abstract::$$_separator\Zend_Dojo_Form_Decorator_DijitContainer::$$_separatorPHP_EOL
Details- Type
- string
- Inherited_from
- \Zend_Form_Decorator_Abstract::$$_separator
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_separator


string $_title =
- Type
- string
- Inherited_from
- \Zend_Dojo_Form_Decorator_DijitContainer::$$_title
Methods


__construct(array | \Zend_Config $options = null) : void
Constructor
Inherited from: \Zend_Form_Decorator_Abstract::__construct()\Zend_Dojo_Form_Decorator_DijitContainer::__construct()Accept options during initialization.
Name | Type | Description |
---|---|---|
$options | array | \Zend_Config |


clearOptions() : \Zend_Form_Decorator_Abstract
Clear all options
Inherited from: \Zend_Form_Decorator_Abstract::clearOptions()\Zend_Dojo_Form_Decorator_DijitContainer::clearOptions()Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


getAttribs() : array
Get element attributes
Inherited from: \Zend_Dojo_Form_Decorator_DijitContainer::getAttribs()Type | Description |
---|---|
array |


getDijitParams() : array
Get dijit option parameters
Inherited from: \Zend_Dojo_Form_Decorator_DijitContainer::getDijitParams()Type | Description |
---|---|
array |


getElement() : \Zend_Form_Element | \Zend_Form
Retrieve current element
Inherited from: \Zend_Form_Decorator_Abstract::getElement()\Zend_Dojo_Form_Decorator_DijitContainer::getElement()Type | Description |
---|---|
\Zend_Form_Element | \Zend_Form |


getHelper() : string
Get view helper for rendering container
Inherited from: \Zend_Dojo_Form_Decorator_DijitContainer::getHelper()Type | Description |
---|---|
string |


getOption(string $key) : mixed
Get option
Inherited from: \Zend_Form_Decorator_Abstract::getOption()\Zend_Dojo_Form_Decorator_DijitContainer::getOption()Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
mixed |


getOptions() : array
Retrieve options
Inherited from: \Zend_Form_Decorator_Abstract::getOptions()\Zend_Dojo_Form_Decorator_DijitContainer::getOptions()Type | Description |
---|---|
array |


getPlacement() : string
Determine if decorator should append or prepend content
Inherited from: \Zend_Form_Decorator_Abstract::getPlacement()\Zend_Dojo_Form_Decorator_DijitContainer::getPlacement()Type | Description |
---|---|
string |


getSeparator() : string
Retrieve separator to use between old and new content
Inherited from: \Zend_Form_Decorator_Abstract::getSeparator()\Zend_Dojo_Form_Decorator_DijitContainer::getSeparator()Type | Description |
---|---|
string |


removeOption(mixed $key) : void
Remove single option
Inherited from: \Zend_Form_Decorator_Abstract::removeOption()\Zend_Dojo_Form_Decorator_DijitContainer::removeOption()Name | Type | Description |
---|---|---|
$key | mixed |


render(string $content) : string
Render a dijit layout container
Inherited from: \Zend_Dojo_Form_Decorator_DijitContainer::render()Replaces $content entirely from currently set element.
Name | Type | Description |
---|---|---|
$content | string |
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | when unimplemented |


setConfig(\Zend_Config $config) : \Zend_Form_Decorator_Abstract
Set options from config object
Inherited from: \Zend_Form_Decorator_Abstract::setConfig()\Zend_Dojo_Form_Decorator_DijitContainer::setConfig()Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setElement(\Zend_Form_Element | \Zend_Form $element) : \Zend_Form_Decorator_Abstract
Set current form element
Inherited from: \Zend_Form_Decorator_Abstract::setElement()\Zend_Dojo_Form_Decorator_DijitContainer::setElement()While the name is "setElement", a form decorator could decorate either an element or a form object.
Name | Type | Description |
---|---|---|
$element | \Zend_Form_Element | \Zend_Form |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |
Exception | Description |
---|---|
\Zend_Form_Decorator_Exception | on invalid element type |


setOption(string $key, mixed $value) : \Zend_Form_Decorator_Abstract
Set option
Inherited from: \Zend_Form_Decorator_Abstract::setOption()\Zend_Dojo_Form_Decorator_DijitContainer::setOption()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |


setOptions(array $options) : \Zend_Form_Decorator_Abstract
Set options
Inherited from: \Zend_Form_Decorator_Abstract::setOptions()\Zend_Dojo_Form_Decorator_DijitContainer::setOptions()Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Form_Decorator_Abstract |