Docs For Class PrimitiveIO_AuthoritativeContainer

Description

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

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
version: $Id: PrimitiveIO_AuthoritativeContainer.class.php,v 1.7 2007/09/19 14:04:44 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 5/1/06

Located in /polyphony/main/library/DataManagerGUI/PrimitiveIO/IOClasses/PrimitiveIO_AuthoritativeContainer.class.php (line 24)

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

Method Summary

void addOnChange (string $commands)

void addOptionFromSObject (object SObject $valueObject)

boolean isUsingNewValue ()

void setSize (integer $size)

void setStartingDisplayText (string $text)

void setValue (string $value)

void setValueFromSObject (ref $value)

boolean update (string $fieldName)

void _init ()

Variables

Inherited Variables

Inherited from WSelectOrNew

WSelectOrNew::$_errorMessage
WSelectOrNew::$_errorRule
WSelectOrNew::$_errorStyle
WSelectOrNew::$_label
WSelectOrNew::$_new
WSelectOrNew::$_select
WSelectOrNew::$_showError

Inherited from WizardComponentWithChildren

WizardComponentWithChildren::$_children

Inherited from WizardComponent

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

Methods

addOnChange (line 83)

Sets the javascript onchange attribute.

access: public

void addOnChange (string $commands)

string $commands

addOptionFromSObject (line 106)

Add an option to our choose list

since: 5/1/06
access: public

void addOptionFromSObject (object SObject $valueObject)

object SObject $valueObject

isUsingNewValue (line 131)

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

since: 6/2/06
access: public

boolean isUsingNewValue ()

Redefinition of:

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

setSize (line 68)

Set the size of the new input components

since: 5/1/06
access: public

void setSize (integer $size)

integer $size

setStartingDisplayText (line 94)

Sets the text of the field to display until the user enters the field.

access: public

void setStartingDisplayText (string $text)

string $text

setValue (line 47)

Set the value of the input component

since: 10/21/05
access: public

void setValue (string $value)

string $value

Redefinition of:

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

setValueFromSObject (line 119)

Sets the value of this Component to the SObject passed.

void setValueFromSObject (ref $value)

ref $value: object $value The SObject value to use.

update (line 152)

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:

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.

_init (line 34)

Initialize our fields

since: 6/2/06
access: public

void _init ()

Redefinition of:

WSelectOrNew::_init(): Initialize our fields

Inherited Methods

Inherited From WSelectOrNew

WSelectOrNew::WSelectOrNew()
WSelectOrNew::addOption()
WSelectOrNew::getAllValues()
WSelectOrNew::getErrorRule()
WSelectOrNew::getErrorStyle()
WSelectOrNew::getErrorText()
WSelectOrNew::getMarkup()
WSelectOrNew::isUsingNewValue()
WSelectOrNew::postCopy()
WSelectOrNew::setEnabled()
WSelectOrNew::setErrorRule()
WSelectOrNew::setErrorStyle()
WSelectOrNew::setErrorText()
WSelectOrNew::setLabel()
WSelectOrNew::setNewComponent()
WSelectOrNew::setSelectComponent()
WSelectOrNew::setValue()
WSelectOrNew::update()
WSelectOrNew::validate()
WSelectOrNew::_init()

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