Docs For Class WColorWheel

Description

This class allows for the creation of a ColorWheel color management tool.

version: $Id: WColorWheel.class.php,v 1.4 2007/09/19 14:04:51 adamfranco Exp $
author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
license: GNU General Public License (GPL)
license: This
copyright: Copyright © 2005, Middlebury College
since: Jul 21, 2005

Located in /polyphony/main/library/Wizard/Components/WColorWheel.class.php (line 27)

SObject
   |
   --WizardComponent
      |
      --WColorWheel

Variable Summary

mixed $_settings

mixed $_style

mixed $_value

Method Summary

WSelectList WColorWheel ()

mixed getAllValues ()

string getMarkup (string $fieldName)

string getSettings ()

void setStyle (string $style)

void setValue (string $value)

boolean update (string $fieldName)

Variables

mixed $_settings = '' (line 32)

mixed $_style = null (line 33)

mixed $_value (line 31)

Inherited Variables

Inherited from WizardComponent

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

Methods

Constructor WColorWheel (line 41)

Constructor

access: public

WSelectList WColorWheel ()

getAllValues (line 114)

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.

getMarkup (line 126)

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.

getSettings (line 88)

Gets the current Settings of the ColorWheel object. The settings are returned as a string with the attributes separated by semicolons.

The order is: mainColor;preset;slider-value;safecolor;shift1;shift2;shift3;shift4;schema;

return: settings
access: public

string getSettings ()

setStyle (line 51)

sets the CSS style for the labels of the radio buttons.

access: public

void setStyle (string $style)

string $style

setValue (line 74)

Sets the value of this ColorWheel object.

The value is a string containing the hex representation of the selected colors. Colors come in groups of 4:first is the base color and then follow three variations. Some schemata give more than one group of colors. Thus, the string starts with the number of color groups returned by the ColorWheel and then follow the colors themselves(in hex) all separated by a semicolon. So an example could be: 1;#007D48;#BFFFE4;#80FFC9;#00B366; where you are given 1 group of 4 colors.

access: public

void setValue (string $value)

string $value

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
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.

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