Class: I2CE Module ColorPicker (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_Module_ColorPicker}} This article describes the class ''I2CE_Module_ColorPicker'' . *Extends the class: [[Class: I2CE_Module (Development) | I2CE_Modu…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Module_ColorPicker'' .
This article describes the class ''I2CE_Module_ColorPicker'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[I2CE Module List (Development)#ColorPicker|ColorPicker]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#ColorPicker|ColorPicker]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L29 modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 29
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_ColorPicker
I2CE_Module_ColorPicker
Line 9: Line 9:
===$color_triples===
===$color_triples===
An array of color pickers that need to update  triple of rgb
An array of color pickers that need to update  triple of rgb
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L61 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 61
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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
*Type: protected $color_triples


==Methods==
==Methods==
===__construct()===
===__construct()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L62 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 62
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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()
*Signature: public function __construct()
===addColorPickerTriple()===
===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
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-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L278 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 278
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function addColorPickerTriple($obj,$args)
*Parameters:
*Parameters:
Line 25: Line 25:
===addUpdateBackgroundColor()===
===addUpdateBackgroundColor()===
Update a background color on a click @param string $id_action @param string $id_update
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-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L264 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 264
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function addUpdateBackgroundColor($event,$action_id,$update_id,$color)
*Parameters:
*Parameters:
Line 33: Line 33:
** [http://www.php.net/manual/en/language.types.string.php string ] $color <br/>The hex color
** [http://www.php.net/manual/en/language.types.string.php string ] $color <br/>The hex color
===convertColorTripleHexToRGB()===
===convertColorTripleHexToRGB()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L350 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 350
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function convertColorTripleHexToRGB($c)
*Parameters:
*Parameters:
**$c  
**$c  
===convertColorTripleRGBToHex()===
===convertColorTripleRGBToHex()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L354 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 354
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function convertColorTripleRGBToHex($c)
*Parameters:
*Parameters:
**$c  
**$c  
===displayValue_color_triple_hex_single()===
===displayValue_color_triple_hex_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L181 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 181
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function displayValue_color_triple_hex_single($swissConfig,$valNode,$status,$config)
*Parameters:
*Parameters:
Line 51: Line 51:
**$config  
**$config  
===displayValue_color_triple_rgb_single()===
===displayValue_color_triple_rgb_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L104 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 104
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function displayValue_color_triple_rgb_single($swissConfig,$valNode,$status,$config)
*Parameters:
*Parameters:
Line 59: Line 59:
**$config  
**$config  
===ensureColorTripleHex()===
===ensureColorTripleHex()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L392 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 392
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function ensureColorTripleHex($c)
*Parameters:
*Parameters:
**$c  
**$c  
===ensureColorTripleRGB()===
===ensureColorTripleRGB()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L358 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 358
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function ensureColorTripleRGB($c)
*Parameters:
*Parameters:
Line 70: Line 70:
===ensureHexColor()===
===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
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-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L308 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 308
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function ensureHexColor($c)
*Parameters:
*Parameters:
Line 76: Line 76:
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===ensureRGBColor()===
===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
Given an array which is a triple of colors or a string turn it into a comma separated 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-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L341 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 341
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: protected function ensureRGBColor($c)
*Parameters:
*Parameters:
Line 83: Line 83:
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getHooks()===
===getHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L50 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 50
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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()
*Signature: static public function getHooks()
===getMethods()===
===getMethods()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L31 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 31
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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()
*Signature: static public function getMethods()
===processValues_color_triple_hex_many()===
===processValues_color_triple_hex_many()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L77 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 77
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function processValues_color_triple_hex_many($configurator,$valueList,$status)
*Parameters:
*Parameters:
Line 97: Line 97:
***Default Value: array()
***Default Value: array()
===processValues_color_triple_hex_single()===
===processValues_color_triple_hex_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L69 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 69
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function processValues_color_triple_hex_single($configurator,$value,$status)
*Parameters:
*Parameters:
Line 105: Line 105:
***Default Value: array()
***Default Value: array()
===processValues_color_triple_rgb_many()===
===processValues_color_triple_rgb_many()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L88 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 88
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function processValues_color_triple_rgb_many($configurator,$valueList,$status)
*Parameters:
*Parameters:
Line 113: Line 113:
***Default Value: array()
***Default Value: array()
===processValues_color_triple_rgb_single()===
===processValues_color_triple_rgb_single()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L73 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 73
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function processValues_color_triple_rgb_single($configurator,$value,$status)
*Parameters:
*Parameters:
Line 122: Line 122:
===writeOutJS()===
===writeOutJS()===
writes out the JS in any needed to display the color pickers.
writes out the JS in any needed to display the color pickers.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php#L425 i2ce/modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php] on line 425
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
*Signature: public function writeOutJS($args)
*Parameters:
*Parameters:
Line 138: Line 138:
===action_initialize()===
===action_initialize()===
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
This public method is inherited from [[Class: I2CE_Module (Development)#action_initialize() | I2CE_Module->action_initialize()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getCLIHooks() | I2CE_Module->getCLIHooks()]]


===getCLIMethods()===
===getCLIMethods()===

Latest revision as of 09:15, 6 May 2015


This article describes the class I2CE_Module_ColorPicker .

I2CE_Module_ColorPicker

Variables

$color_triples

An array of color pickers that need to update triple of rgb

Methods

__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

addUpdateBackgroundColor()

Update a background color on a click @param string $id_action @param string $id_update

convertColorTripleHexToRGB()

convertColorTripleRGBToHex()

displayValue_color_triple_hex_single()

displayValue_color_triple_rgb_single()

ensureColorTripleHex()

ensureColorTripleRGB()

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

ensureRGBColor()

Given an array which is a triple of colors or a string turn it into a comma separated string of colors. If it cannnot recognize it as a color, returns an empty string

getHooks()

getMethods()

processValues_color_triple_hex_many()

processValues_color_triple_hex_single()

processValues_color_triple_rgb_many()

processValues_color_triple_rgb_single()

writeOutJS()

writes out the JS in any needed to display the color pickers.

Inherited Methods

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

action_initialize()

This public method is inherited from I2CE_Module->action_initialize()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

post_update()

This public method is inherited from I2CE_Module->post_update()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

upgrade()

This public method is inherited from I2CE_Module->upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()