Docs For Class WAddFromListRepeatableComponentCollection

Description

This component allows for the creation of repeatable components or groups of components. Only the newly added comonents are editable. Existing ones can only be removed.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WAddFromListRepeatableComponentCollection.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: Aug 1, 2005

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

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WRepeatableComponentCollection
            |
            --WAddFromListRepeatableComponentCollection

Method Summary

WAddFromListRepeatableComponentCollection WAddFromListRepeatableComponentCollection ()

void addOptionCollection (string $name, array $valueCollection)

boolean update (string $fieldName)

Variables

Inherited Variables

Inherited from WRepeatableComponentCollection

WRepeatableComponentCollection::$_addButton
WRepeatableComponentCollection::$_collections
WRepeatableComponentCollection::$_max
WRepeatableComponentCollection::$_min
WRepeatableComponentCollection::$_num
WRepeatableComponentCollection::$_prefixFunction
WRepeatableComponentCollection::$_text

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

Constructor WAddFromListRepeatableComponentCollection (line 29)

WAddFromListRepeatableComponentCollection WAddFromListRepeatableComponentCollection ()

addOptionCollection (line 44)

Add an array of value collections for use when adding

since: 11/1/05
access: public

void addOptionCollection (string $name, array $valueCollection)

string $name
array $valueCollection

update (line 57)

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:

WRepeatableComponentCollection::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 WRepeatableComponentCollection

WRepeatableComponentCollection::WRepeatableComponentCollection()
WRepeatableComponentCollection::addValueCollection()
WRepeatableComponentCollection::getAllValues()
WRepeatableComponentCollection::getMarkup()
WRepeatableComponentCollection::setAddLabel()
WRepeatableComponentCollection::setContent()
WRepeatableComponentCollection::setElementLayout()
WRepeatableComponentCollection::setEnabled()
WRepeatableComponentCollection::setMaximum()
WRepeatableComponentCollection::setMiminum()
WRepeatableComponentCollection::setRemoveLabel()
WRepeatableComponentCollection::setStartingNumber()
WRepeatableComponentCollection::setValue()
WRepeatableComponentCollection::update()
WRepeatableComponentCollection::usePrefixFunction()
WRepeatableComponentCollection::validate()
WRepeatableComponentCollection::_addElement()
WRepeatableComponentCollection::_ensureNumber()
WRepeatableComponentCollection::_getAllValues()
WRepeatableComponentCollection::_removeElements()

Inherited From WizardComponentWithChildren

WizardComponentWithChildren::addComponent()
WizardComponentWithChildren::getAllValues()
WizardComponentWithChildren::getChild()
WizardComponentWithChildren::getChildren()
WizardComponentWithChildren::removeChild()
WizardComponentWithChildren::setEnabled()
WizardComponentWithChildren::update()
WizardComponentWithChildren::validate()

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