Docs For Class SimpleWizard

Description

The SimpleWizard is a WizardClass which contains children and a block of formatting text in which to include those children.

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

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

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

Direct descendents

Class	Description
SimpleStepWizard	typecomment
StepWizard	Abstract parent for wizards that contain multiple steps

Variable Summary

mixed $_text

Method Summary

string getMarkup (string $fieldName)

ref withText (string $text, [mixed $class = 'SimpleWizard'])

Variables

mixed $_text (line 27)

Inherited Variables

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

getMarkup (line 50)

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:

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

withText (line 36)

Returns a new SimpleWizard object with the text supplied.

return: object
access: public
static:

ref withText (string $text, [mixed $class = 'SimpleWizard'])

string $text

Redefined in descendants as:

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

Inherited Methods

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