Docs For Class WStyleCollection

Description

This class allows for the creation of a Style Collection GUI Wizard component.

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

Located in /polyphony/main/library/GUIWizardComponents/Generic/WStyleCollection.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WStyleCollection

Variable Summary

mixed $_collection

mixed $_getThemeCallBack

mixed $_wizardComponent

Method Summary

WStyleCollection WStyleCollection (mixed $callBack, mixed $collection)

string getMarkup (string $fieldName)

void getStyleCollection ()

boolean update (string $fieldName)

boolean validate ()

Variables

mixed $_collection (line 33)

mixed $_getThemeCallBack (line 32)

mixed $_wizardComponent (line 30)

Inherited Variables

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

Constructor WStyleCollection (line 38)

WStyleCollection WStyleCollection (mixed $callBack, mixed $collection)

getMarkup (line 224)

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.

getStyleCollection (line 79)

void getStyleCollection ()

update (line 178)

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:

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

validate (line 205)

Returns true if this component (and all child components if applicable) have valid values.

By default, this will just return TRUE.

access: public

boolean validate ()

Redefinition of:

WizardComponentWithChildren::validate(): Returns true if this component (and all child components if applicable) have valid values.

Inherited Methods

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