Docs For Class WDynamicStep

Description

The Wizard class provides a system for registering Wizard properties and associating those properties with the appropriate form elements.

author: Gabe Schine
version: $Id: WDynamicStep.class.php,v 1.3 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/Wizard/Components/WDynamicStep.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WizardStep
            |
            --WDynamicStep

Variable Summary

mixed $_callBack

Method Summary

string getMarkup (string $fieldName)

ref setComponent (string $name, ref $component)

void setDynamicFunction (mixed $function, string $displayName)

Variables

mixed $_callBack = "" (line 27)

Inherited Variables

Inherited from WizardStep

WizardStep::$_contentText
WizardStep::$_displayName

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

getMarkup (line 51)

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:

WizardStep::getMarkup(): Returns a block of XHTML-valid code that contains markup for this specific component.

setComponent (line 69)

Sets a WizardComponent to this component, and returns the newly added component.

This is actually the same as addComponent, but the name makes a little more sense.

return: object
access: public

ref setComponent (string $name, ref $component)

string $name: The short-string name of the component - this is used for creating form input field names and storing data.
ref $component: object $component A WizardComponent to add.

setDynamicFunction (line 37)

Sets the callback function of this dynamic wizard step

void setDynamicFunction (mixed $function, string $displayName)

string $displayName

Inherited Methods

Inherited From WizardStep

WizardStep::getContent()
WizardStep::getDisplayName()
WizardStep::getMarkup()
WizardStep::setContent()
WizardStep::setDisplayName()

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