Docs For Class WGUIComponent

Description

This class is an abstract class for associating StyleComponents with a wizard component.

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

Located in /polyphony/main/library/GUIWizardComponents/WGUIComponent.abstract.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WGUIComponent

Direct descendents

Class	Description
WGUICheckbox	This class make a checkbox associated with a style property
WGUISelectList	This class make a selectlist associated with a style property

Variable Summary

mixed $_collection

mixed $_component

mixed $_defValue

mixed $_getThemeCallBack

mixed $_property

mixed $_wizardComponent

Method Summary

void exportValue ()

mixed getAllValues ()

string getMarkup (string $fieldName)

void getStyleCollection ()

void getStyleComponent ()

void importValue ()

void init (mixed $callBack, mixed $collectionSelector, mixed $styleProperty, mixed $componentClass)

boolean isPossibleValue (string $value)

boolean update (string $fieldName)

void useDefaultValue ()

boolean validate ()

Variables

mixed $_collection (line 33)

mixed $_component (line 35)

mixed $_defValue (line 40)

The default value passed in with the StyleProperty

mixed $_getThemeCallBack (line 32)

mixed $_property (line 34)

mixed $_wizardComponent (line 30)

Inherited Variables

Inherited from WizardComponent

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

Methods

exportValue (line 161)

copy the value of the Wizard component to the StyleComponent

void exportValue ()

Redefined in descendants as:

WGUICheckbox::exportValue() : copy the value of the Wizard component to the StyleComponent
WGUISelectList::exportValue() : copy the value of the Wizard component to the StyleComponent

getAllValues (line 197)

Returns the values of wizard-components. It may return the value of the wizard component, but this may be overridden.

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

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

void getStyleCollection ()

getStyleComponent (line 94)

void getStyleComponent ()

importValue (line 168)

copy the value from the StyleComponent to the wizard component

void importValue ()

Redefined in descendants as:

WGUICheckbox::importValue() : copy the value from the StyleComponent to the wizard component

init (line 46)

Initialize all the variables. Should be called last in the constructor.

Requires that the collection and theme are created

void init (mixed $callBack, mixed $collectionSelector, mixed $styleProperty, mixed $componentClass)

isPossibleValue (line 184)

Is $value a legitamate value for this wizard component?

return: if the value is legitimate

boolean isPossibleValue (string $value)

string $value: the value to test

Redefined in descendants as:

WGUICheckbox::isPossibleValue() : Is $value a legitamate value for this wizard component?
WGUISelectList::isPossibleValue() : Is $value a legitamate value for this wizard component?

update (line 142)

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.

useDefaultValue (line 88)

void useDefaultValue ()

validate (line 128)

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