Docs For Class SimpleStepWizard

Description

typecomment

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

Located in /polyphony/main/library/Wizard/SimpleStepWizard.class.php (line 33)

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

Direct descendents

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

Variable Summary

mixed $_cancelButton

mixed $_nextButton

mixed $_prevButton

mixed $_saveButton

mixed $_stepContainer

Method Summary

void SimpleStepWizard ()

ref addStep (string $name, ref $step)

mixed getAllValues ()

object WSaveButton getCancelButton ()

string getCurrentStepName ()

object WSaveButton getSaveButton ()

void setStep (string $name)

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

ref withText (string $text)

ref withTitleAndDefaultLayout (string $title)

Variables

mixed $_cancelButton (line 38)

mixed $_nextButton (line 35)

mixed $_prevButton (line 36)

mixed $_saveButton (line 37)

mixed $_stepContainer (line 34)

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

Constructor SimpleStepWizard (line 45)

Constructor

access: public

void SimpleStepWizard ()

addStep (line 68)

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

Redefined in descendants as:

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

getAllValues (line 156)

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.

getCancelButton (line 179)

Answer the 'Cancel' button to allow modification of its label and properties.

since: 6/4/07
access: public

object WSaveButton getCancelButton ()

getCurrentStepName (line 89)

Answer the name of the current step

since: 6/5/07
access: public

string getCurrentStepName ()

getSaveButton (line 168)

Answer the 'Save' button to allow modification of its label and properties.

since: 6/4/07
access: public

object WSaveButton getSaveButton ()

setStep (line 78)

Sets the step to the named step.

access: public

void setStep (string $name)

string $name

withDefaultLayout (line 129)

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.

Redefined in descendants as:

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

withText (line 107)

Returns a new SimpleStepWizard with the layout defined as passed. The layout may include any of the following tags:

_save - a save button _cancel - a cancel button _steps - the place where the current step content will go _next - the next step button _prev - the previous step button

return: object
static:
access: public

ref withText (string $text)

string $text

Redefinition of:

SimpleWizard::withText(): Returns a new SimpleWizard object with the text supplied.

withTitleAndDefaultLayout (line 117)

Returns a new SimpleStepWizard with the default layout and a title.

return: object
access: public

ref withTitleAndDefaultLayout (string $title)

string $title

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