Docs For Class StepWizard

Description

Abstract parent for wizards that contain multiple steps

author: Gabe Schine
version: $Id: StepWizard.abstract.php,v 1.5 2007/09/19 14:04:50 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/31/06

Located in /polyphony/main/library/Wizard/StepWizard.abstract.php (line 29)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --Wizard
            |
            --SimpleWizard
               |
               --StepWizard

Direct descendents

Class	Description
LogicStepWizard	Abstract parent for wizards that contain multiple steps

Variable Summary

mixed $_cancelButton

mixed $_stepContainer

Method Summary

ref addStep (string $name, ref $step)

mixed getAllValues ()

string getCurrentStepName ()

array getSteps ()

void setStep (string $name)

Variables

mixed $_cancelButton (line 32)

mixed $_stepContainer (line 31)

Inherited Variables

Inherited from SimpleWizard

SimpleWizard::$_text

Inherited from Wizard

Wizard::$_eventListeners
Wizard::$_eventsLater
Wizard::$_formName
Wizard::$_id

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

addStep (line 52)

Adds a new WizardStep to this wizard.

return: object
access: public

ref addStep (string $name, ref $step)

string $name: A short id/name for this step.
ref $step: object $step

getAllValues (line 84)

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

access: public

mixed getAllValues ()

Redefinition of:

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

getCurrentStepName (line 74)

Answer the name of the current step

since: 6/5/07
access: public

string getCurrentStepName ()

getSteps (line 41)

Answers the step container

return: the steps for this wizard
since: 5/5/06
access: public

array getSteps ()

setStep (line 62)

Sets the step to the named step.

access: public

void setStep (string $name)

string $name

Inherited Methods

Inherited From SimpleWizard

SimpleWizard::getMarkup()
SimpleWizard::withText()

Inherited From Wizard

Wizard::addEventListener()
Wizard::getIdString()
Wizard::getLayout()
Wizard::getMarkup()
Wizard::getValidationJavascript()
Wizard::getWizard()
Wizard::getWizardFormName()
Wizard::go()
Wizard::parseText()
Wizard::setIdString()
Wizard::setParent()
Wizard::triggerEvent()
Wizard::triggerLater()
Wizard::update()

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