Docs For Class WRadioList

Description

This class allows for the creation of lists of input type='radio' items of a specific group.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WRadioList.class.php,v 1.12 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: Jul 21, 2005

Located in /polyphony/main/library/Wizard/Components/WRadioList.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WRadioList

Direct descendents

Class	Description
PrimitiveIO_boolean
WHorizontalRadioList	This adds a hoizontal (separated by spaces) list of input type='radio' elements.
WVerticalRadioList	This adds a vertical (separated by elements) list of input type='radio' elements.

Variable Summary

mixed $_eachPost

mixed $_eachPre

mixed $_extendedHtml

mixed $_items

mixed $_onchange

mixed $_post

mixed $_pre

mixed $_style

mixed $_value

Method Summary

WRadioList WRadioList ()

void addOnChange (string $commands)

void addOption (string $value, [optional $displayText = null], [optional $extendedHtml = null])

mixed getAllValues ()

string getMarkup (string $fieldName)

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

ref withLayout (string $pre, string $eachPre, string $eachPost, string $post, [mixed $class = 'WRadioList'])

Variables

mixed $_eachPost (line 30)

mixed $_eachPre (line 29)

mixed $_extendedHtml = array() (line 38)

mixed $_items = array() (line 37)

mixed $_onchange (line 34)

mixed $_post (line 32)

mixed $_pre (line 31)

mixed $_style = null (line 35)

mixed $_value (line 33)

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
WizardComponent::$_enabledSticky
WizardComponent::$_parent

Methods

Constructor WRadioList (line 66)

Constructor

access: public

WRadioList WRadioList ()

addOnChange (line 97)

Add commands to the javascript onchange attribute.

access: public

void addOnChange (string $commands)

string $commands

addOption (line 109)

Adds a radio option to this list.

access: public

void addOption (string $value, [optional $displayText = null], [optional $extendedHtml = null])

string $value: The short value that represents the displayed text.
optional $displayText: string $displayText The text to show to the end user. Defaults to $value.
optional $extendedHtml: string $extendedHtml Text to add to the item after the display text.

getAllValues (line 135)

Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

access: public

mixed getAllValues ()

Redefinition of:

WizardComponent::getAllValues(): Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

Redefined in descendants as:

PrimitiveIO_boolean::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

getMarkup (line 147)

Returns a block of XHTML-valid code that contains markup for this specific component.

access: public

string getMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::getMarkup(): Returns a block of XHTML-valid code that contains markup for this specific component.

setStyle (line 77)

sets the CSS style for the labels of the radio buttons.

access: public

void setStyle (string $style)

string $style

setValue (line 87)

Sets the value of this radio button group.

access: public

void setValue (string $value)

string $value

Redefined in descendants as:

PrimitiveIO_boolean::setValue() : Sets the value of this Component to the SObject passed.

update (line 124)

Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

return: - TRUE if everything is OK
access: public

boolean update (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::update(): Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

withLayout (line 52)

Virtual constructor - creates this object with the specified layout.

return: object
static:
access: public

ref withLayout (string $pre, string $eachPre, string $eachPost, string $post, [mixed $class = 'WRadioList'])

string $pre: A string to prepend onto the markup block (ex, "
string $eachPre: A string to put at the beginning of each of the elements (ex, "<li>")
string $eachPost: A string to put at the end of each of the elements (ex, "</li>")
string $post: A string to tack onto the end of the block (ex, "</ul>")

Inherited Methods

Inherited From WizardComponent

WizardComponent::getAllValues()
WizardComponent::getMarkup()
WizardComponent::getWizard()
WizardComponent::isEnabled()
WizardComponent::setEnabled()
WizardComponent::setParent()
WizardComponent::update()
WizardComponent::validate()

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()