Class ZFormOption

Description

Located in /Form/elements/ZFormOption.php (line 34)

ZFormElement
   |
   --ZFormWebElement
      |
      --ZFormOption
Variable Summary
 mixed $_text
Method Summary
 void __construct ([string $id = null], [ZFormWebElement $parentNode = null], [string $value = null], [string $text = null])
 string getText ()
 void renderBody ([boolean $renderScriptBlock = false])
 void setText (string $text)
Variables
Methods
Constructor __construct (line 50)

Class constructor. Sets up the ZForm element, types it as a 'OPTION' element.

This is the base class for all the INPUT types supported by ZForm.

  • access: public
void __construct ([string $id = null], [ZFormWebElement $parentNode = null], [string $value = null], [string $text = null])
  • string $value: The value of the HTML option field
  • string $text: Text to be displayed as the option
  • string $id: id The optional identifier for the newly created ZFormOption
  • ZFormWebElement $parentNode: The optional parent of the newly create ZFormOption The default value is null which means the ZFormOption is a root element.

Redefinition of:
ZFormWebElement::__construct()
getText (line 95)

Returns the text which will be displayed in the selection box.

  • access: public
string getText ()
renderBody (line 69)

Render the body of the ZFormOptions which is the $text property of the ZFormOption object

  • access: public
void renderBody ([boolean $renderScriptBlock = false])
  • boolean $renderScriptBlock: true of the element should emit any JavaScript associated with component

Redefinition of:
ZFormWebElement::renderBody()
Renders the body of the element's which by default consists of
setText (line 84)

Sets the text property of the option. The text is what is displayed in the select list

  • access: public
void setText (string $text)
  • string $text

Inherited Methods

Inherited From ZFormWebElement

 ZFormWebElement::__construct()
 ZFormWebElement::addScriptBlock()
 ZFormWebElement::close()
 ZFormWebElement::emitAttributes()
 ZFormWebElement::emitScriptBlocks()
 ZFormWebElement::getMemento()
 ZFormWebElement::getValue()
 ZFormWebElement::loadRequestData()
 ZFormWebElement::open()
 ZFormWebElement::render()
 ZFormWebElement::renderBody()
 ZFormWebElement::setMemento()
 ZFormWebElement::setValue()
 ZFormWebElement::setWrapExisting()
 ZFormWebElement::_applyClientBehaviors()
 ZFormWebElement::_emitClientBehaviors()
 ZFormWebElement::_emitClientValidators()
 ZFormWebElement::__get()
 ZFormWebElement::__set()

Inherited From ZFormElement

 ZFormElement::__construct()
 ZFormElement::addBehavior()
 ZFormElement::addEventListener()
 ZFormElement::addValidator()
 ZFormElement::appendChild()
 ZFormElement::fireEvent()
 ZFormElement::getAttribute()
 ZFormElement::getAttributes()
 ZFormElement::getBehaviors()
 ZFormElement::getChildNodes()
 ZFormElement::getElementById()
 ZFormElement::getErrorMessage()
 ZFormElement::getEventListeners()
 ZFormElement::getID()
 ZFormElement::getIDPath()
 ZFormElement::getIsProcessing()
 ZFormElement::getMemento()
 ZFormElement::getParentNode()
 ZFormElement::getRoot()
 ZFormElement::getValidationErrors()
 ZFormElement::getValidators()
 ZFormElement::getValue()
 ZFormElement::handleEvent()
 ZFormElement::hasChildNodes()
 ZFormElement::invokeApplication()
 ZFormElement::loadRequestData()
 ZFormElement::persist()
 ZFormElement::process()
 ZFormElement::removeChild()
 ZFormElement::removedBehavior()
 ZFormElement::removedValidator()
 ZFormElement::removeEventListener()
 ZFormElement::restoreState()
 ZFormElement::setAllowEvents()
 ZFormElement::setAttribute()
 ZFormElement::setID()
 ZFormElement::setMemento()
 ZFormElement::setParentNode()
 ZFormElement::setProcess()
 ZFormElement::setValue()
 ZFormElement::validate()
 ZFormElement::_appendToList()
 ZFormElement::_computeIDPath()
 ZFormElement::_gatherMementos()
 ZFormElement::_isLegalName()
 ZFormElement::_performValidation()
 ZFormElement::_processEvents()
 ZFormElement::_removeFromList()
 ZFormElement::_restoreMementos()
Class Constants

Inherited Constants

Inherited from ZFormElement

ZFormElement::PATH_SEPARATOR

Documentation generated on Thu, 18 Jan 2007 10:01:42 -0800 by phpDocumentor 1.3.1