Docs For Class WText

Description

This class allows for the creation of simple block of text.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WText.class.php,v 1.5 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: Jul 21, 2005

Located in /polyphony/main/library/Wizard/Components/WText.class.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WText

Variable Summary

mixed $_style

mixed $_value

Method Summary

ref fromString (string $aString)

mixed getAllValues ()

string getMarkup (string $fieldName)

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

ref withValue (string $value)

Variables

mixed $_style = '' (line 30)

mixed $_value (line 29)

Inherited Variables

Inherited from WizardComponent

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

Methods

fromString (line 52)

Virtual Constructor with fromString naming convention

return: object
static:
access: public

ref fromString (string $aString)

string $aString

getAllValues (line 89)

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

In this case, a "1" or a "0" is returned, depending on the checked state of the checkbox.

access: public

mixed getAllValues ()

Redefinition of:

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

getMarkup (line 111)

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.

setStyle (line 98)

Sets the CSS style for this span of text.

void setStyle (string $style)

string $style

setValue (line 64)

Sets the value of this text.

access: public

void setValue (string $value)

string $value

update (line 77)

Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

return: - TRUE if everything is OK
access: public

boolean update (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefinition of:

WizardComponent::update(): Tells the wizard component to update itself - this may include getting form post data or validation - whatever this particular component wants to do every pageload.

withValue (line 39)

Virtual Constructor

return: object
static:
access: public

ref withValue (string $value)

string $value

Inherited Methods

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