Docs For Class WSaveWithChoiceButtonList

Description

The WSaveWithChoiceButtonList provides a set of multiple elements similar to the WRadioList, but triggers a save action when one of the buttons is pressed.

The value of that button is then entered as the value of the list, providing easy determination of which button was pressed by the client code.

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

Located in /polyphony/main/library/Wizard/Components/WSaveWithChoiceButtonList.class.php (line 28)

SObject
   |
   --WizardComponent
      |
      --WSaveWithChoiceButtonList

Variable Summary

mixed $_eachPost

mixed $_eachPre

mixed $_event

mixed $_extendedHtml

mixed $_items

mixed $_onchange

mixed $_post

mixed $_pre

mixed $_style

mixed $_value

Method Summary

WRadioList WSaveWithChoiceButtonList ()

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 = 'WSaveWithChoiceButtonList'])

Variables

mixed $_eachPost (line 32)

mixed $_eachPre (line 31)

mixed $_event = "edu.middlebury.polyphony.wizard.save" (line 42)

mixed $_extendedHtml = array() (line 40)

mixed $_items = array() (line 39)

mixed $_onchange (line 36)

mixed $_post (line 34)

mixed $_pre (line 33)

mixed $_style = null (line 37)

mixed $_value (line 35)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WSaveWithChoiceButtonList (line 70)

Constructor

access: public

WRadioList WSaveWithChoiceButtonList ()

addOnChange (line 101)

Add commands to the javascript onchange attribute.

access: public

void addOnChange (string $commands)

string $commands

addOption (line 113)

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

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

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

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

access: public

void setStyle (string $style)

string $style

setValue (line 91)

Sets the value of this radio button group.

access: public

void setValue (string $value)

string $value

update (line 128)

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

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 = 'WSaveWithChoiceButtonList'])

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