Class WizardComponent

Description

A WizardComponent is an element that you can add to a Wizard. They can be used to create simple interface components or to handle form input and validation.

Located in /polyphony/main/library/Wizard/WizardComponent.abstract.php (line 24)

SObject
   |
   --WizardComponent
Direct descendents
Class Description
PrimitiveIO Defines an interface for PrimitiveIO classes that allow interfacing between the DataManager and the Wizard.
WGUIComponent This class is an abstract class for associating StyleComponents with a wizard component.
WAgentBrowser This component allows you to search the agents in the system and select a number of them for some action.
WCheckBox This class allows for the creation of a input type='checkbox' element.
WColorWheel This class allows for the creation of a ColorWheel color management tool.
WEventButton This is a base class for any button in a Wizard that will throw an event when it is activated.
WFileUploadField This adds an input type='text' field to a Wizard.
WHiddenField This class allows for the creation of a input type='hidden'
WizardEventListener Supplies an event listener to a Wizard
WizardStepContainer This is a special WizardComponent that will keep track of WizardSteps and switch from one to the other.
WMultiSelectList This class allows for the creation of select lists where you can select multiple elements.
WPasswordField This adds an input type='password' field to a Wizard.
WRadioList This class allows for the creation of lists of input type='radio' items of a specific group.
WSaveWithChoiceButtonList The WSaveWithChoiceButtonList provides a set of multiple elements similar to the WRadioList, but triggers a save action when one of the buttons is pressed.
WSelectList This class allows for the creation of select lists.
WStepDisplayBar This adds a "Next" button to the wizard and throws the appropriate event.
WText This class allows for the creation of simple block of text.
ErrorCheckingWizardComponent Defines a component that makes use of the Wizard's javascript error checking abilities.
WizardComponentWithChildren This is an abstract class that defines a WizardComponent that can have children.
Variable Summary
mixed $_enabled
mixed $_parent
Method Summary
mixed getAllValues ()
string getMarkup (string $fieldName)
ref getWizard ()
boolean isEnabled ()
void setEnabled (boolean $enabled, [boolean $sticky = false])
void setParent (ref $parent)
boolean update (string $fieldName)
boolean validate ()
Variables
mixed $_enabled = true (line 28)
mixed $_enabledSticky = false (line 29)
mixed $_parent (line 27)
Methods
getAllValues (line 109)

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

  • abstract:
  • access: public
mixed getAllValues ()

Redefined in descendants as:
  • PrimitiveIO_blob::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WGUIComponent::getAllValues() : Returns the values of wizard-components. It may return the value of the wizard component, but this may be overridden.
  • WAgentBrowser::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WCheckBox::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WColorWheel::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WEventButton::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • 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.
  • WFileUploadField::getAllValues() : For file upload, returns an array:
  • WHiddenField::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WizardEventListener::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • 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.
  • WizardStepContainer::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WMultiSelectList::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WPasswordField::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WRadioList::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_boolean::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WSaveWithChoiceButtonList::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WSelectList::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_Authoritative_datetime::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_Authoritative_string::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WStepDisplayBar::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WText::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WStyleComponent::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WTextInput::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_string::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_datetime::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_shortstring::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_integer::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_float::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WizardComponentWithChildren::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • PrimitiveIO_okitype::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WMoreOptions::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WRepeatableComponentCollection::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WOrderedRepeatableComponentCollection::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WSelectOrNew::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • WVerifiedChangeInput::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • SimpleStepWizard::getAllValues() : Returns the values of wizard-components. Should return an array if children are involved, otherwise a whatever type of object is expected.
  • StepWizard::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 119)

Returns a block of XHTML-valid code that contains markup for this specific component.

  • abstract:
  • access: public
string getMarkup (string $fieldName)
  • string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefined in descendants as:
getWizard (line 48)

Returns the top-level Wizard in which this component resides.

  • return: object
  • access: public
ref getWizard ()

Redefined in descendants as:
isEnabled (line 88)

Answers true if this component will be enabled.

  • access: public
boolean isEnabled ()

Redefined in descendants as:
setEnabled (line 71)

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.

Redefined in descendants as:
setParent (line 39)

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

Redefined in descendants as:
update (line 101)

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
  • abstract:
  • access: public
boolean update (string $fieldName)
  • string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefined in descendants as:
  • PrimitiveIO_blob::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.
  • WGUIComponent::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.
  • WAgentBrowser::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.
  • WCheckBox::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.
  • WColorWheel::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.
  • 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.
  • 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.
  • WFileUploadField::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.
  • WHiddenField::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.
  • WizardEventListener::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.
  • 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.
  • WizardStepContainer::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.
  • WLogicStepContainer::update() : tells the wizard component to update itself... via the current step.
  • WMultiSelectList::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.
  • WPasswordField::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.
  • WRadioList::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.
  • WSaveWithChoiceButtonList::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.
  • WSelectList::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.
  • WStepDisplayBar::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.
  • WText::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.
  • WStyleComponent::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.
  • WTextInput::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.
  • HtmlTextArea::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.
  • 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.
  • WStyleCollection::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.
  • WStyleProperty::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.
  • WMoreOptions::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.
  • WRepeatableComponentCollection::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.
  • WAddFromListRepeatableComponentCollection::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.
  • WOrderedRepeatableComponentCollection::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.
  • WSelectOrNew::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.
  • PrimitiveIO_AuthoritativeContainer::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.
  • WVerifiedChangeInput::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.
  • Wizard::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 59)

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

Redefined in descendants as:

Inherited Methods

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:04 -0400 by phpDocumentor 1.3.0RC3