Class WizardEventListener

Description
Description | Descendents | Vars | Methods (details)

Supplies an event listener to a Wizard

Located in /polyphony/main/library/Wizard/Components/WizardEventListener.abstract.php (line 27) 

SObject
   |
   --WizardComponent
      |
      --WizardEventListener
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
WSaveCancelListener Supplies an event listener to a Wizard and keeps track of if a Save or Cancel event was posted. This is useful for when saving Wizards in session to handle events.
WStepChangedListener Supplies an event listener to a Wizard for update events, this will pass the control back to the wizard if it would like it.
WUpdateListener Supplies an event listener to a Wizard for update events, this will pass the control back to the wizard if it would like it.
Method Summary
Description | Descendents | Vars | Methods (details)
mixed getAllValues ()
string getMarkup (string $fieldName)
void handleEvent (string $eventType, ref $source, array $context)
void setParent (ref $parent)
boolean update (string $fieldName)
void _attemptAdding ()
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from WizardComponent

WizardComponent::$_enabled
 WizardComponent::$_enabledSticky
 WizardComponent::$_parent
Methods
Description | Descendents | Vars Methods (details)
getAllValues (line 78)

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:
  • WSaveCancelListener::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WStepChangedListener::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WUpdateListener::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 90)

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:
handleEvent (line 103)

Handles an event triggered by an EventTrigger. The event type is passed in case this particular EventListener is handling more than one type of event.

  • access: public
void handleEvent (string $eventType, ref $source, array $context)
  • string $eventType
  • array $context: An array of contextual parameters - the content will be dependent on the thrown event.
  • ref $source: object $source The source object of the event.
Redefined in descendants as:
setParent (line 38)

Sets this component's parent (some kind of WizardComponentWithChildren so that it can have access to its information, if needed.

  • access: public
void setParent (ref $parent)
  • ref $parent: object $parent
Redefinition of:
WizardComponent::setParent()
Sets this component's parent (some kind of WizardComponentWithChildren so that it can have access to its information, if needed.
Redefined in descendants as:
update (line 68)

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:
  • WSaveCancelListener::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.
  • WStepChangedListener::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.
  • WUpdateListener::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.
_attemptAdding (line 49)

Attempts to add ourselves to the parent Wizard as an EventListener.

  • access: public
void _attemptAdding ()
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:28:05 -0400 by phpDocumentor 1.3.0RC3