Class WEventButton

Description
Description | Descendents | Vars (details) | Methods (details)

This is a base class for any button in a Wizard that will throw an event when it is activated.

Located in /polyphony/main/library/Wizard/Components/WEventButton.class.php (line 24) 

SObject
   |
   --WizardComponent
      |
      --WEventButton
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
WBackButton This adds a "Back" button to the wizard and throws the appropriate event.
WCallbackButton This class simply evaluates its event as a callback function when pressed.
WCancelButton This adds a cancel button to a wizard. It will automatically trigger the Wizard's cancel event.
WChooseOptionButton This appears to be an implementation of EventButton that centers around a dropdown menu.
WForwardButton This adds a "Back" button to the wizard and throws the appropriate event.
WLogicButton Buttons of this class tree are used in logic wizards to control wizard flow.
WNextStepButton This adds a "Next" button to the wizard and throws the appropriate event.
WPreviousStepButton This adds a "Previous" button to the wizard.
WSaveButton This adds a save button to a wizard. It will automatically trigger the Wizard's save event
WSaveContinueButton This is a base class for any button in a Wizard that will throw an event when it is activated.
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_event
mixed $_label
mixed $_onclick
mixed $_pressed
Method Summary
Description | Descendents | Vars (details) | Methods (details)
void addConfirm (string $confirmText)
void addOnClick (string $javascript)
mixed getAllValues ()
string getMarkup (string $fieldName)
void setEventAndLabel (string $event, string $label, optional 2)
void setLabel (string $label, optional 1)
boolean update (string $fieldName)
ref withEventAndLabel (string $event, string $label)
ref withLabel (string $label)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_event = "nop" (line 27)
mixed $_label = "NO LABEL" (line 28)
Redefined in descendants as:
mixed $_onclick = null (line 30)
Redefined in descendants as:
mixed $_pressed = false (line 29)
Redefined in descendants as:

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
 WizardComponent::$_enabledSticky
 WizardComponent::$_parent
Methods
Description | Descendents | Vars (details) Methods (details)
addConfirm (line 102)

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

  • since: 6/7/06
  • access: public
void addConfirm (string $confirmText)
  • string $confirmText
addOnClick (line 89)

Sets the on-click javascript to be called.

  • access: public
void addOnClick (string $javascript)
  • string $javascript
Redefined in descendants as:
getAllValues (line 133)

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:
  • WChooseOptionButton::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WLogicButton::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 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.
Redefined in descendants as:
setEventAndLabel (line 67)

Sets the event type and label for the button.

  • access: public
void setEventAndLabel (string $event, string $label, optional 2)
  • string $event
  • string $label
  • optional 2: string $textDomain the gettext() text domain to use for the label.
setLabel (line 79)

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.
Redefined in descendants as:
update (line 117)

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:
  • WBackButton::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.
  • WCallbackButton::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.
  • WChooseOptionButton::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.
  • WForwardButton::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.
  • WLogicButton::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.
  • WNextStepButton::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.
  • WPreviousStepButton::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.
  • WSaveContinueButton::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.
withEventAndLabel (line 40)

virtual constructor

  • return: object
  • static:
  • access: public
ref withEventAndLabel (string $event, string $label)
  • string $event
  • string $label
Redefined in descendants as:
withLabel (line 53)

virtual constructor - creates the button with a "nop" event

  • return: object
  • access: public
ref withLabel (string $label)
  • string $label
Redefined in descendants as:

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

Documentation generated on Wed, 19 Sep 2007 10:27:57 -0400 by phpDocumentor 1.3.0RC3