Docs For Class WVerifiedChangeInput

Description

This component provides a checkbox next to the input field with which the user can confirm that they wish to change this field. This is useful when making forms which allow for the editing of many fields across multiple items where the user may only wish to change one of the fields across all items.

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

Located in /polyphony/main/library/Wizard/Components/WVerifiedChangeInput.class.php (line 27)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WVerifiedChangeInput

Variable Summary

mixed $_checkbox

mixed $_input

mixed $_label

Method Summary

object WVerifiedChangeInput ()

mixed getAllValues ()

string getMarkup (string $fieldName)

object postCopy ()

void setChecked (boolean $checked)

void setEnabled (boolean $enabled, [boolean $sticky = false])

object WComponent setInputComponent (object WComponent $input)

void setLabel (mixed $label, string $label;)

void setStartingDisplayText (string $text)

void setValue (string $value)

boolean update (string $fieldName)

boolean validate ()

object withInputComponent (object WComponent $input)

Variables

mixed $_checkbox (line 32)

mixed $_input (line 31)

mixed $_label (line 33)

Inherited Variables

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

Constructor WVerifiedChangeInput (line 78)

Constructor

since: 10/20/05
access: public

object WVerifiedChangeInput ()

getAllValues (line 196)

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.

getMarkup (line 212)

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.

postCopy (line 65)

$this is a shallow copy, subclasses should override to copy fields as necessary to complete the full copy.

since: 7/11/05
access: public

object postCopy ()

Redefinition of:

SObject::postCopy(): $this is a shallow copy, subclasses should override to copy fields as necessary to complete the full copy.

setChecked (line 139)

Set the checked state of the checkbox

since: 10/24/05
access: public

void setChecked (boolean $checked)

boolean $checked

setEnabled (line 151)

Sets if this component will be enabled or disabled.

access: public

void setEnabled (boolean $enabled, [boolean $sticky = false])

boolean $enabled
boolean $sticky: If true, future calls to setEnabled without sticky will have no effect.

Redefinition of:

WizardComponentWithChildren::setEnabled(): Sets if this component will be enabled or disabled.

setInputComponent (line 93)

Set the input component

since: 10/20/05
access: public

object WComponent setInputComponent (object WComponent $input)

object WComponent $input

setLabel (line 161)

Sets the label for this checkbox element.

access: public

void setLabel (mixed $label, string $label;)

string $label;

setStartingDisplayText (line 127)

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

access: public

void setStartingDisplayText (string $text)

string $text

setValue (line 113)

Set the value of the input component

since: 10/21/05
access: public

void setValue (string $value)

string $value

update (line 185)

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:

WizardComponentWithChildren::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 172)

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

By default, this will just return TRUE. Validate should be called usually before a save event is handled, to make sure everything went smoothly.

access: public

boolean validate ()

Redefinition of:

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

withInputComponent (line 47)

Create a new VerifiedChangeInput with the component specified

since: 10/20/05
access: public

object withInputComponent (object WComponent $input)

object WComponent $input

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