Docs For Class WLogicButton

Description

Buttons of this class tree are used in logic wizards to control wizard flow.

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

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

SObject
   |
   --WizardComponent
      |
      --WEventButton
         |
         --WLogicButton

Variable Summary

mixed $_label

mixed $_logic

mixed $_onclick

mixed $_pressed

Method Summary

void addOnClick (string $javascript)

mixed getAllValues ()

ref getLogicRule ()

string getMarkup (string $fieldName)

void setLabel (string $label, optional 1)

void setLogic (ref $controller)

void setLogicAndLabel (ref $controller, string $label)

boolean update (string $fieldName)

ref withLabel (string $label)

ref withLogicAndLabel (ref $controller, string $label)

Variables

mixed $_label = "NO LABEL" (line 28)

Redefinition of:

WEventButton::$_label

mixed $_logic = null (line 27)

mixed $_onclick = null (line 30)

Redefinition of:

WEventButton::$_onclick

mixed $_pressed = false (line 29)

Redefinition of:

WEventButton::$_pressed

Inherited Variables

Inherited from WEventButton

WEventButton::$_event

Inherited from WizardComponent

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

Methods

addOnClick (line 108)

Sets the on-click javascript to be called.

access: public

void addOnClick (string $javascript)

string $javascript

Redefinition of:

WEventButton::addOnClick(): Sets the on-click javascript to be called.

getAllValues (line 148)

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:

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

getLogicRule (line 138)

Gets the logic controller for the button

return: object WLogicController the controller
since: 7/31/06
access: public

ref getLogicRule ()

getMarkup (line 162)

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:

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

setLabel (line 98)

Sets the label for the button.

access: public

void setLabel (string $label, optional 1)

string $label
optional 1: string $textDomain the gettext() text domain to use for the label.

Redefinition of:

WEventButton::setLabel(): Sets the label for the button.

setLogic (line 87)

Sets the logic controller for the button

since: 7/31/06
access: public

void setLogic (ref $controller)

ref $controller: object WLogicController $controller

setLogicAndLabel (line 74)

Sets the logic controller and label for the button

since: 5/31/06
access: public

void setLogicAndLabel (ref $controller, string $label)

string $label
ref $controller: object WLogicController $controller

update (line 121)

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:

WEventButton::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 57)

virtual constructor

return: object
since: 5/31/06
access: public

ref withLabel (string $label)

string $label

Redefinition of:

WEventButton::withLabel(): virtual constructor - creates the button with a "nop" event

withLogicAndLabel (line 42)

virtual constructor

return: object
since: 5/31/06
access: public

ref withLogicAndLabel (ref $controller, string $label)

string $label
ref $controller: object WLogicController $controller

Inherited Methods

Inherited From WEventButton

WEventButton::addConfirm()
WEventButton::addOnClick()
WEventButton::getAllValues()
WEventButton::getMarkup()
WEventButton::setEventAndLabel()
WEventButton::setLabel()
WEventButton::update()
WEventButton::withEventAndLabel()
WEventButton::withLabel()

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