View source for Class: I2CE Module ColorPicker (4.0.5)

{{otherversions|Class: I2CE_Module_ColorPicker}}
This article describes the class ''I2CE_Module_ColorPicker'' .
*Extends the class: [[Class: I2CE_Module (4.0.5) | I2CE_Module]].
*Location: Part of the module [[I2CE Module List (4.0.5)#ColorPicker|ColorPicker]] in the package [https://launchpad.net/i2ce I2CE] 4.0.5-release
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L29 modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_ColorPicker
==Variables==
===$color_triples===
An array of color pickers that need to update  triple of rgb
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L61 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 61
*Type: protected $color_triples

==Methods==
===__construct()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L62 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 62
*Signature: public function __construct()
===addColorPickerTriple()===
Add a color picker which set a triple of (preferably hidden) input values to the RGB values selected @param mixed $attach.  Either the id of a element to append the color picker to. @param string $showColor.  The id of element to set the background color to when clicking on the color picker @param string $colorIDs.  An array indexed by 0,1,2 of the id of input button to update the values to @param mixed $initColor.  An optional inital color to set the color picker to.  Either an array of rgb values (indexed by 012,rgb or RGB) or a hexmode color
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L278 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 278
*Signature: public function addColorPickerTriple($obj,$args)
*Parameters:
**$obj 
**$args 
===addUpdateBackgroundColor()===
Update a background color on a click @param string $id_action @param string $id_update
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L264 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 264
*Signature: public function addUpdateBackgroundColor($event,$action_id,$update_id,$color)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $event
**$action_id 
**$update_id 
** [http://www.php.net/manual/en/language.types.string.php string ] $color <br/>The hex color
===convertColorTripleHexToRGB()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L350 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 350
*Signature: protected function convertColorTripleHexToRGB($c)
*Parameters:
**$c 
===convertColorTripleRGBToHex()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L354 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 354
*Signature: protected function convertColorTripleRGBToHex($c)
*Parameters:
**$c 
===displayValue_color_triple_hex_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L181 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 181
*Signature: public function displayValue_color_triple_hex_single($swissConfig,$valNode,$status,$config)
*Parameters:
**$swissConfig 
**$valNode 
**$status 
**$config 
===displayValue_color_triple_rgb_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L104 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 104
*Signature: public function displayValue_color_triple_rgb_single($swissConfig,$valNode,$status,$config)
*Parameters:
**$swissConfig 
**$valNode 
**$status 
**$config 
===ensureColorTripleHex()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L392 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 392
*Signature: protected function ensureColorTripleHex($c)
*Parameters:
**$c 
===ensureColorTripleRGB()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L358 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 358
*Signature: protected function ensureColorTripleRGB($c)
*Parameters:
**$c 
===ensureHexColor()===
Given an array which is a triple of colors or a string turn it into a hex string of colors. If it cannnot recognize it as a color, returns an empty string
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L308 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 308
*Signature: protected function ensureHexColor($c)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $c
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===ensureRGBColor()===
Given an array which is a triple of colors or a string turn it into a comma seperated string of colors. If it cannnot recognize it as a color, returns an empty string
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L341 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 341
*Signature: protected function ensureRGBColor($c)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $c
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L50 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 50
*Signature: static public function getHooks()
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L31 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 31
*Signature: static public function getMethods()
===processValues_color_triple_hex_many()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L77 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 77
*Signature: public function processValues_color_triple_hex_many($configurator,$valueList,$status)
*Parameters:
**$configurator 
**$valueList 
**$status 
***Default Value: array()
===processValues_color_triple_hex_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L69 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 69
*Signature: public function processValues_color_triple_hex_single($configurator,$value,$status)
*Parameters:
**$configurator 
**$value 
**$status 
***Default Value: array()
===processValues_color_triple_rgb_many()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L88 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 88
*Signature: public function processValues_color_triple_rgb_many($configurator,$valueList,$status)
*Parameters:
**$configurator 
**$valueList 
**$status 
***Default Value: array()
===processValues_color_triple_rgb_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L73 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 73
*Signature: public function processValues_color_triple_rgb_single($configurator,$value,$status)
*Parameters:
**$configurator 
**$value 
**$status 
***Default Value: array()
===writeOutJS()===
writes out the JS in any needed to display the color pickers.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.5-release/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L425 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 425
*Signature: public function writeOutJS($args)
*Parameters:
**$args 
==Inherited Methods==
===action_configure()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#action_configure() | I2CE_Module->action_configure()]]

===action_disable()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#action_disable() | I2CE_Module->action_disable()]]

===action_enable()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#action_enable() | I2CE_Module->action_enable()]]

===action_initialize()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#action_initialize() | I2CE_Module->action_initialize()]]

===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#getCLIHooks() | I2CE_Module->getCLIHooks()]]

===getCLIMethods()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#getCLIMethods() | I2CE_Module->getCLIMethods()]]

===getConfig()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#getConfig() | I2CE_Module->getConfig()]]

===post_update()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#post_update() | I2CE_Module->post_update()]]

===pre_upgrade()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#pre_upgrade() | I2CE_Module->pre_upgrade()]]

===upgrade()===
This public method is inherited from [[Class: I2CE_Module (4.0.5)#upgrade() | I2CE_Module->upgrade()]]

===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (4.0.5)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Module (4.0.5)#launchBackgroundProcess() | I2CE_Module->launchBackgroundProcess()]]

===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Module (4.0.5)#launchBackgroundPHPScript() | I2CE_Module->launchBackgroundPHPScript()]]

===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Module (4.0.5)#launchBackgroundPage() | I2CE_Module->launchBackgroundPage()]]

===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy (4.0.5)#userMessage() | I2CE_Fuzzy->userMessage()]]


[[Category:Class Documentation (4.0.5)]]