Docs For Class WSelectList

Description

This class allows for the creation of select lists.

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

SObject
   |
   --WizardComponent
      |
      --WSelectList

Direct descendents

Class	Description
PrimitiveIO_Authoritative	This class implements standard methods needed by the Authoritative versions of the primitive IO classes, for behaving as select lists.

Variable Summary

mixed $_disabled

mixed $_items

mixed $_onchange

mixed $_style

mixed $_styles

mixed $_value

Method Summary

WSelectList WSelectList ()

void addConfirm (string $confirmText)

void addDisabledOption (string $value, string $displayText, [string $styles = null])

void addOnChange (string $commands)

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

mixed getAllValues ()

string getMarkup (string $fieldName)

boolean isOption (string $value)

boolean isStartingDisplay ()

void setStartingDisplayText (string $text)

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

Variables

mixed $_disabled = array() (line 35)

mixed $_items = array() (line 33)

mixed $_onchange = '' (line 31)

mixed $_style = null (line 30)

mixed $_styles = array() (line 34)

mixed $_value (line 29)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WSelectList (line 42)

Constructor

access: public

WSelectList WSelectList ()

addConfirm (line 190)

Add a confirmation question that will be present in a javascript 'confirm' dialog onchange press.

since: 6/7/06
access: public

void addConfirm (string $confirmText)

string $confirmText

addDisabledOption (line 121)

Add a disabled option to this list.

since: 4/3/07
access: public

void addDisabledOption (string $value, string $displayText, [string $styles = null])

string $value: The short value that represents the displayed text.
string $displayText: The text to show to the end user.
string $styles: Any styles to pass into the menu option.

addOnChange (line 177)

Add commands to the javascript onchange attribute.

access: public

void addOnChange (string $commands)

string $commands

addOption (line 106)

Adds an option to this list.

access: public

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

string $value: The short value that represents the displayed text.
string $displayText: The text to show to the end user.
string $styles: Any styles to pass into the menu option.

getAllValues (line 163)

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_Authoritative_datetime::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
PrimitiveIO_Authoritative_string::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 204)

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.

isOption (line 134)

Answer true if the value passed is a valid option

since: 4/28/06
access: public

boolean isOption (string $value)

string $value

Redefined in descendants as:

PrimitiveIO_Authoritative::isOption() : Answer true if the value passed is a valid option

isStartingDisplay (line 77)

Return True if the select list is on the starting display, rather than a real value

since: 8/3/06
access: public

boolean isStartingDisplay ()

setStartingDisplayText (line 62)

Sets the text of the field to display until the user enters the field.

access: public

void setStartingDisplayText (string $text)

string $text

setStyle (line 52)

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

access: public

void setStyle (string $style)

string $style

setValue (line 90)

Sets the value of this radio button group.

access: public

void setValue (string $value)

string $value

Redefined in descendants as:

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

update (line 151)

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