Docs For Class WizardStep

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: WizardStep.class.php,v 1.5 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/WizardStep.class.php (line 25)

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

Direct descendents

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

Variable Summary

mixed $_contentText

mixed $_displayName

Method Summary

string getContent ()

string getDisplayName ()

string getMarkup (string $fieldName)

void setContent (mixed $content, string $content;)

void setDisplayName (string $displayName)

Variables

mixed $_contentText (line 28)

mixed $_displayName (line 27)

Inherited Variables

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

getContent (line 65)

Answer the step's conent text. Useful for appending new properties to the step

since: 5/11/07
access: public

string getContent ()

getDisplayName (line 34)

Returns the displayName of this WizardStep

string getDisplayName ()

getMarkup (line 77)

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:

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

Redefined in descendants as:

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

setContent (line 53)

Sets this step's content text. This text will be parsed with Wizard::parseText()

access: public

void setContent (mixed $content, string $content;)

string $content;

setDisplayName (line 43)

Sets the display name of this wizard step

void setDisplayName (string $displayName)

string $displayName

Inherited Methods

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