Docs For Class SingleStepWizard

Description

This is a single-step wizard. It operates just like the multiple-step wizard, but doesn't have or allow more than one step.

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

Located in /polyphony/main/library/Wizard/SingleStepWizard.class.php (line 26)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --Wizard
            |
            --SimpleWizard
               |
               --SimpleStepWizard
                  |
                  --SingleStepWizard

Method Summary

ref addStep (string $name, ref $step)

ref withDefaultLayout ([optional $pre = ''])

Variables

Inherited Variables

Inherited from SimpleStepWizard

SimpleStepWizard::$_cancelButton
SimpleStepWizard::$_nextButton
SimpleStepWizard::$_prevButton
SimpleStepWizard::$_saveButton
SimpleStepWizard::$_stepContainer

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

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

Redefinition of:

SimpleStepWizard::addStep(): Adds a new WizardStep to this wizard.

withDefaultLayout (line 51)

Returns a new SimpleStepWizard with the default layout including all the buttons.

return: object
static:
access: public

ref withDefaultLayout ([optional $pre = ''])

optional $pre: string $pre Some text to put before the layout text.

Redefinition of:

SimpleStepWizard::withDefaultLayout(): Returns a new SimpleStepWizard with the default layout including all the buttons.

Inherited Methods

Inherited From SimpleStepWizard

SimpleStepWizard::SimpleStepWizard()
SimpleStepWizard::addStep()
SimpleStepWizard::getAllValues()
SimpleStepWizard::getCancelButton()
SimpleStepWizard::getCurrentStepName()
SimpleStepWizard::getSaveButton()
SimpleStepWizard::setStep()
SimpleStepWizard::withDefaultLayout()
SimpleStepWizard::withText()
SimpleStepWizard::withTitleAndDefaultLayout()

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