Docs For Class WCheckBox

Description

This class allows for the creation of a input type='checkbox' element.

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

SObject
   |
   --WizardComponent
      |
      --WCheckBox

Variable Summary

mixed $_label

mixed $_style

mixed $_value

Method Summary

WCheckBox WCheckBox ()

void addConfirm (string $confirmText)

mixed getAllValues ()

string getCheckJS (mixed $fieldName)

string getMarkup (string $fieldName)

string getSetJS (string $fieldName)

string getToggleJS (string $fieldName)

string getUncheckJS (mixed $fieldName)

void setChecked (boolean $checked)

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

void setStyle (string $style)

void setValue (boolean $checked)

boolean update (string $fieldName)

ref withLabel (string $label)

Variables

mixed $_label = '' (line 33)

mixed $_style = null (line 31)

mixed $_value (line 29)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WCheckBox (line 53)

Constructor

access: public

WCheckBox WCheckBox ()

addConfirm (line 133)

Add a confirmation question that will be present in a javascript 'confirm' dialog onchange press.

since: 6/14/06
access: public

void addConfirm (string $confirmText)

string $confirmText

getAllValues (line 120)

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.

getCheckJS (line 243)

Answer the javascript commands to check the checkbox.

since: 10/20/05
access: public

string getCheckJS (mixed $fieldName)

getMarkup (line 147)

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.

getSetJS (line 229)

Answer the javascript commands to execute when the checkbox is clicked.

since: 10/20/05
access: public

string getSetJS (string $fieldName)

string $fieldName

getToggleJS (line 213)

Answer the javascript commands to execute when the checkbox is clicked.

since: 10/20/05
access: public

string getToggleJS (string $fieldName)

string $fieldName

getUncheckJS (line 258)

Answer the javascript commands to check the checkbox.

since: 10/20/05
access: public

string getUncheckJS (mixed $fieldName)

setChecked (line 83)

Sets if this checkbox should be checked or not as a default value.

access: public

void setChecked (boolean $checked)

boolean $checked

setLabel (line 93)

Sets the label for this checkbox element.

access: public

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

string $label;

setStyle (line 63)

Sets the CSS style of the label for this element.

access: public

void setStyle (string $style)

string $style

setValue (line 73)

Sets if this checkbox should be checked or not as a default value.

access: public

void setValue (boolean $checked)

boolean $checked

update (line 106)

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.

withLabel (line 42)

Virtual Constructor

return: object
static:
access: public

ref withLabel (string $label)

string $label

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