Docs For Class WNewOnlyEditableRepeatableComponentCollection

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: WNewOnlyEditableRepeatableComponentCollection.class.php,v 1.5 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/WNewOnlyEditableRepeatableComponentCollection.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WRepeatableComponentCollection
            |
            --WNewOnlyEditableRepeatableComponentCollection

Method Summary

ref addValueCollection (ref $collection, [boolean $removable = true])

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

addValueCollection (line 37)

Adds a collection of WizardComponents indexed by field name to the list of collections.

This is useful when pre-populating the list with old/previous values.

return: array An array of the components created with the values passed.
access: public

ref addValueCollection (ref $collection, [boolean $removable = true])

boolean $removable: Can this collection be removed by the user?
ref $collection: array $collection Indexed by field name.

Redefinition of:

WRepeatableComponentCollection::addValueCollection(): Adds a collection of WizardComponents indexed by field name to the list of collections.

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