Docs For Class WMoreOptions

Description

The goal here is to provide a system for having a simple view that the user can expand to get more options.

author: Gabe Schine
version: $Id: WMoreOptions.abstract.php,v 1.4 2007/09/19 14:04:51 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2006, Middlebury College

Located in /polyphony/main/library/Wizard/Components/WMoreOptions.abstract.php (line 25)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WMoreOptions

Direct descendents

Class	Description
WBackgroundEditor	This class allows for the modification of the layout of a font.
WFontEditor	This class allows for the modification of a font.
WMultiCollection	This class allows for the modification of the layout of a font.
	This class allows for the modification of the layout of a font.

Variable Summary

mixed $_usingAdvanced

Method Summary

string advancedMarkup (string $fieldName)

mixed getAllValues ()

string getCheckboxMarkup (string $fieldName)

string getMarkup (string $fieldName)

void getOptionalComponentsMarkup (string $fieldName)

void init ([mixed $set = false])

boolean isUsingAdvanced ()

boolean update (string $fieldName)

Variables

mixed $_usingAdvanced (line 29)

Inherited Variables

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

advancedMarkup (line 140)

Returns a block of XHTML-valid code that contains markup for the "advanced" options.

access: public

string advancedMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

Redefined in descendants as:

WBackgroundEditor::advancedMarkup() : Returns a block of XHTML-valid code that contains markup for the "advanced" options.
WFontEditor::advancedMarkup() : Returns a block of XHTML-valid code that contains markup for the "advanced" options.
WMultiCollection::advancedMarkup() : Returns a block of XHTML-valid code that contains markup for the "advanced" options.
WTextLayoutEditor::advancedMarkup() : Returns a block of XHTML-valid code that contains markup for the "advanced" options.

getAllValues (line 73)

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:

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

getCheckboxMarkup (line 153)

Returns a block of XHTML-valid code that contains markup for the checkbox

access: public

string getCheckboxMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

getMarkup (line 93)

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:

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

getOptionalComponentsMarkup (line 116)

Returns a block of XHTML-valid code that contains markup for the "advanced" options plus the block that hides them.

access: public

void getOptionalComponentsMarkup (string $fieldName)

string $fieldName: The field name to use when outputting form data or similar parameters/information.

init (line 31)

void init ([mixed $set = false])

isUsingAdvanced (line 104)

Return true if we should be using the new value rather than the select

since: 6/2/06
access: public

boolean isUsingAdvanced ()

update (line 45)

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:

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.

Inherited Methods

Inherited From WizardComponentWithChildren

WizardComponentWithChildren::addComponent()
WizardComponentWithChildren::getAllValues()
WizardComponentWithChildren::getChild()
WizardComponentWithChildren::getChildren()
WizardComponentWithChildren::removeChild()
WizardComponentWithChildren::setEnabled()
WizardComponentWithChildren::update()
WizardComponentWithChildren::validate()

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