Docs For Class WTextInput

Description

This adds an input type='text' field to a Wizard.

abstract:
author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WTextInput.abstract.php,v 1.11 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/WTextInput.abstract.php (line 25)

SObject
   |
   --WizardComponent
      |
      --ErrorCheckingWizardComponent
         |
         --WTextInput

Direct descendents

Class	Description
WTextArea	This class allows for the creation of a textarea element
WTextField	This adds an input type='text' field to a Wizard.

Variable Summary

mixed $_onchange

mixed $_showError

mixed $_startingDisplay

mixed $_style

mixed $_value

Method Summary

void addOnChange (string $commands)

mixed getAllValues ()

void setStartingDisplayText (string $text)

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

boolean validate ()

Variables

mixed $_onchange = null (line 32)

mixed $_showError = false (line 33)

mixed $_startingDisplay = null (line 31)

mixed $_style = null (line 29)

mixed $_value = null (line 30)

Inherited Variables

Inherited from ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::$_errorMessage
ErrorCheckingWizardComponent::$_errorRule
ErrorCheckingWizardComponent::$_errorStyle

Inherited from WizardComponent

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

Methods

addOnChange (line 120)

Add commands to the javascript onchange attribute.

access: public

void addOnChange (string $commands)

string $commands

Redefined in descendants as:

HtmlTextArea::addOnChange() : Add commands to the javascript onchange attribute.

getAllValues (line 110)

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:

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

Redefined in descendants as:

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

setStartingDisplayText (line 41)

Sets the text of the field to display until the user enters the field.

access: public

void setStartingDisplayText (string $text)

string $text

Redefined in descendants as:

HtmlTextArea::setStartingDisplayText() : Sets the text of the field to display until the user enters the field.

setStyle (line 51)

Sets the CSS style of this field.

access: public

void setStyle (string $style)

string $style

Redefined in descendants as:

HtmlTextArea::setStyle() : Sets the CSS style of this field.

setValue (line 61)

Sets the value of this text field.

access: public

void setValue (string $value)

string $value

Redefined in descendants as:

PrimitiveIO_string::setValue() : Sets the value of this Component to the SObject passed.
HtmlTextArea::setValue() : Sets the value of this text field.
PrimitiveIO_datetime::setValue() : Sets the value of this Component to the SObject passed.
PrimitiveIO_shortstring::setValue() : Sets the value of this Component to the SObject passed.
PrimitiveIO_integer::setValue() : Sets the value of this Component to the SObject passed.
PrimitiveIO_float::setValue() : Sets the value of this Component to the SObject passed.

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.

Redefined in descendants as:

HtmlTextArea::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.

validate (line 92)

Returns true if this component (and all child components if applicable) have valid values.

By default, this will just return TRUE.

access: public

boolean validate ()

Redefinition of:

WizardComponent::validate(): Returns true if this component (and all child components if applicable) have valid values.

Redefined in descendants as:

HtmlTextArea::validate() : Returns true if this component (and all child components if applicable) have valid values.
PrimitiveIO_datetime::validate() : Returns true if this component (and all child components if applicable) have valid values.
PrimitiveIO_integer::validate() : Returns true if this component (and all child components if applicable) have valid values.
PrimitiveIO_float::validate() : Returns true if this component (and all child components if applicable) have valid values.

Inherited Methods

Inherited From ErrorCheckingWizardComponent

ErrorCheckingWizardComponent::getErrorRule()
ErrorCheckingWizardComponent::getErrorStyle()
ErrorCheckingWizardComponent::getErrorText()
ErrorCheckingWizardComponent::setErrorRule()
ErrorCheckingWizardComponent::setErrorStyle()
ErrorCheckingWizardComponent::setErrorText()

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