Docs For Class WSelectOrNew

Class WSelectOrNew

Description

<##>

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: WSelectOrNew.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: 4/28/06

Located in /polyphony/main/library/Wizard/Components/WSelectOrNew.class.php (line 23)

SObject
   |
   --WizardComponent
      |
      --WizardComponentWithChildren
         |
         --WSelectOrNew

Direct descendents

Class	Description
PrimitiveIO_AuthoritativeContainer	The authoritavieContainer holds multiple fields to allow for choosing from a list or adding a new value. Its children are the list and the new value

Variable Summary

mixed $_errorMessage

mixed $_errorRule

mixed $_errorStyle

mixed $_label

mixed $_new

mixed $_select

mixed $_showError

Method Summary

<##> WSelectOrNew (<##> 0)

void addOption (string $value, string $displayText, [string $styles = null])

mixed getAllValues ()

ref getErrorRule ()

string getErrorStyle ()

string getErrorText ()

string getMarkup (string $fieldName)

boolean isUsingNewValue ()

object postCopy ()

void setEnabled (boolean $enabled, [boolean $sticky = false])

void setErrorRule (mixed $rule, string $regex)

void setErrorStyle (string $style)

void setErrorText (string $text)

void setLabel (mixed $label, string $label;)

object WComponent setNewComponent (object WComponent $input)

object WComponent setSelectComponent (object WComponent $input)

void setValue (string $value)

boolean update (string $fieldName)

boolean validate ()

void _init ()

Variables

mixed $_errorMessage = null (line 33)

mixed $_errorRule = null (line 32)

mixed $_errorStyle = "color: red;" (line 34)

mixed $_label (line 30)

mixed $_new (line 29)

mixed $_select (line 28)

mixed $_showError (line 35)

Inherited Variables

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

Constructor WSelectOrNew (line 45)

Constructor

since: 4/28/06
access: public

<##> WSelectOrNew (<##> 0)

<##> 0

addOption (line 145)

Adds an option to this list.

access: public

void addOption (string $value, string $displayText, [string $styles = null])

string $value: The short value that represents the displayed text.
string $displayText: The text to show to the end user.
string $styles: Any styles to pass into the menu option.

getAllValues (line 213)

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.

getErrorRule (line 277)

Returns the error WECRule.

return: object
access: public

ref getErrorRule ()

getErrorStyle (line 295)

Returns the error text CSS style.

access: public

string getErrorStyle ()

getErrorText (line 286)

Returns the error text.

access: public

string getErrorText ()

getMarkup (line 308)

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.

isUsingNewValue (line 227)

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

since: 6/2/06
access: public

boolean isUsingNewValue ()

Redefined in descendants as:

PrimitiveIO_AuthoritativeContainer::isUsingNewValue() : Return true if we should be using the new value rather than the select

postCopy (line 157)

$this is a shallow copy, subclasses should override to copy fields as necessary to complete the full copy.

since: 7/11/05
access: public

object postCopy ()

Redefinition of:

SObject::postCopy(): $this is a shallow copy, subclasses should override to copy fields as necessary to complete the full copy.

setEnabled (line 92)

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.

Redefinition of:

WizardComponentWithChildren::setEnabled(): Sets if this component will be enabled or disabled.

setErrorRule (line 248)

Sets this element's regular expression. Its value must match this to be considered valid.

access: public

void setErrorRule (mixed $rule, string $regex)

string $regex

setErrorStyle (line 268)

Sets the CSS style of the error text.

access: public

void setErrorStyle (string $style)

string $style

setErrorText (line 258)

Sets the text to be displayed if an error occurs.

access: public

void setErrorText (string $text)

string $text

setLabel (line 169)

Sets the label for this checkbox element.

access: public

void setLabel (mixed $label, string $label;)

string $label;

setNewComponent (line 127)

Set the input component

since: 10/20/05
access: public

object WComponent setNewComponent (object WComponent $input)

object WComponent $input

setSelectComponent (line 105)

Set the input component

since: 10/20/05
access: public

object WComponent setSelectComponent (object WComponent $input)

object WComponent $input

setValue (line 74)

Set the value of the input component

since: 10/21/05
access: public

void setValue (string $value)

string $value

Redefined in descendants as:

PrimitiveIO_AuthoritativeContainer::setValue() : Set the value of the input component

update (line 200)

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.

Redefined in descendants as:

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.

validate (line 180)

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

Redefinition of:

WizardComponentWithChildren::validate(): Returns true if this component (and all child components if applicable) have valid values.

_init (line 61)

Initialize our fields

since: 6/2/06
access: public

void _init ()

Redefined in descendants as:

PrimitiveIO_AuthoritativeContainer::_init() : Initialize our fields

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

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