Docs For Class WChooseOptionButton

Description

This appears to be an implementation of EventButton that centers around a dropdown menu.

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

Located in /polyphony/main/library/Wizard/Components/WChooseOptionButton.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WEventButton
         |
         --WChooseOptionButton

Variable Summary

mixed $_option

mixed $_options

Method Summary

void addOptionValue (string $name, mixed $value)

mixed getAllValues ()

string getMarkup (string $fieldName)

boolean update (string $fieldName)

ref withEventAndLabel (string $event, string $label)

ref withLabel (string $label)

Variables

mixed $_option (line 30)

mixed $_options = array() (line 29)

Inherited Variables

Inherited from WEventButton

WEventButton::$_event
WEventButton::$_label
WEventButton::$_onclick
WEventButton::$_pressed

Inherited from WizardComponent

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

Methods

addOptionValue (line 68)

Add an array of value collections for use when adding

since: 11/1/05
access: public

void addOptionValue (string $name, mixed $value)

string $name
mixed $value

getAllValues (line 99)

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:

WEventButton::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 120)

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:

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

update (line 81)

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:

WEventButton::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.

withEventAndLabel (line 40)

virtual constructor

return: object
static:
access: public

ref withEventAndLabel (string $event, string $label)

string $event
string $label

Redefinition of:

WEventButton::withEventAndLabel(): virtual constructor

withLabel (line 53)

virtual constructor - creates the button with a "nop" event

return: object
access: public

ref withLabel (string $label)

string $label

Redefinition of:

WEventButton::withLabel(): virtual constructor - creates the button with a "nop" event

Inherited Methods

Inherited From WEventButton

WEventButton::addConfirm()
WEventButton::addOnClick()
WEventButton::getAllValues()
WEventButton::getMarkup()
WEventButton::setEventAndLabel()
WEventButton::setLabel()
WEventButton::update()
WEventButton::withEventAndLabel()
WEventButton::withLabel()

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