Docs For Class WStyleComponent

Description

This class allows for the creation of a Style Component selector.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WStyleComponent.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/WStyleComponent.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --ErrorCheckingWizardComponent
         |
         --WStyleComponent

Variable Summary

mixed $_collection

mixed $_component

mixed $_getThemeCallBack

mixed $_property

mixed $_showError

mixed $_wizardComponent

Method Summary

WStyleComponent WStyleComponent (mixed $callBack, mixed $component, mixed $property, mixed $collection)

mixed getAllValues ()

string getMarkup (string $fieldName)

void getStyleComponent ()

boolean update (string $fieldName)

boolean validate ()

Variables

mixed $_collection (line 33)

mixed $_component (line 35)

mixed $_getThemeCallBack (line 32)

mixed $_property (line 34)

mixed $_showError (line 37)

mixed $_wizardComponent (line 30)

Inherited Variables

Inherited from ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::$_errorMessage
ErrorCheckingWizardComponent::$_errorRule
ErrorCheckingWizardComponent::$_errorStyle

Inherited from WizardComponent

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

Methods

Constructor WStyleComponent (line 40)

WStyleComponent WStyleComponent (mixed $callBack, mixed $component, mixed $property, mixed $collection)

getAllValues (line 260)

Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.

In this case, a "1" or a "0" is returned, depending on the checked state of the checkbox.

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

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.

getStyleComponent (line 145)

void getStyleComponent ()

update (line 226)

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.

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:

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

Inherited Methods

Inherited From ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::getErrorRule()
ErrorCheckingWizardComponent::getErrorStyle()
ErrorCheckingWizardComponent::getErrorText()
ErrorCheckingWizardComponent::setErrorRule()
ErrorCheckingWizardComponent::setErrorStyle()
ErrorCheckingWizardComponent::setErrorText()

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