Docs For Class WMultiSelectList

Description

This class allows for the creation of select lists where you can select multiple elements.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WMultiSelectList.class.php,v 1.6 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/WMultiSelectList.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WMultiSelectList

Variable Summary

mixed $_items

mixed $_size

mixed $_style

mixed $_value

Method Summary

WMultiSelectList WMultiSelectList ()

void addOption (string $value, string $displayText)

mixed getAllValues ()

string getMarkup (string $fieldName)

void setSize (integer $size)

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

Variables

mixed $_items = array() (line 33)

mixed $_size = 2 (line 31)

mixed $_style = null (line 30)

mixed $_value = array() (line 29)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WMultiSelectList (line 40)

Constructor

access: public

WMultiSelectList WMultiSelectList ()

addOption (line 82)

Adds a radio option to this list.

access: public

void addOption (string $value, string $displayText)

string $value: The short value that represents the displayed text.
string $displayText: The text to show to the end user.

getAllValues (line 106)

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.

getMarkup (line 118)

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.

setSize (line 60)

Sets the number of viewable elements in this list.

access: public

void setSize (integer $size)

integer $size

setStyle (line 50)

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

access: public

void setStyle (string $style)

string $style

setValue (line 70)

Sets the passed value to be selected in the list.

access: public

void setValue (string $value)

string $value

update (line 95)

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.

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()