Class: I2CE Module ColorPicker

From IHRIS Wiki
Revision as of 15:01, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'The class I2CE_Module_ColorPicker contains 2 definitions: *Definition in [[#modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php|modules/MooTools/modules/ColorPicker/…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The class I2CE_Module_ColorPicker contains 2 definitions:

modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php

This article desrcibes the class I2CE_Module_ColorPickerwhich extends the class I2CE_Module It is contained in the module MooTools in the package I2CE The class is defined in the file: modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php I2CE_Module_ColorPicker @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$color_triples

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

  • Type: protected $color_triples

Methods

__construct()

  • 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

  • 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

  • Signature: public function addUpdateBackgroundColor($event,$action_id,$update_id,$color)

Parameters:

  • string $event
  • $action_id
  • $update_id
  • string $color
    The hex color

convertColorTripleHexToRGB()

  • Signature: protected function convertColorTripleHexToRGB($c)

Parameters:

  • $c

convertColorTripleRGBToHex()

  • Signature: protected function convertColorTripleRGBToHex($c)

Parameters:

  • $c

displayValue_color_triple_hex_single()

  • Signature: public function displayValue_color_triple_hex_single($swissConfig,$valNode,$status,$config)

Parameters:

  • $swissConfig
  • $valNode
  • $status
  • $config

displayValue_color_triple_rgb_single()

  • Signature: public function displayValue_color_triple_rgb_single($swissConfig,$valNode,$status,$config)

Parameters:

  • $swissConfig
  • $valNode
  • $status
  • $config

ensureColorTripleHex()

  • Signature: protected function ensureColorTripleHex($c)

Parameters:

  • $c

ensureColorTripleRGB()

  • 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

  • Signature: protected function ensureHexColor($c)
  • Returns: string

Parameters:

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

  • Signature: protected function ensureRGBColor($c)
  • Returns: string

Parameters:

getHooks()

  • Signature: static public function getHooks()

getMethods()

  • Signature: static public function getMethods()

processValues_color_triple_hex_many()

  • Signature: public function processValues_color_triple_hex_many($configurator,$valueList,$status)

Parameters:

  • $configurator
  • $valueList
  • $status
    • Default Value: array()

processValues_color_triple_hex_single()

  • Signature: public function processValues_color_triple_hex_single($configurator,$value,$status)

Parameters:

  • $configurator
  • $value
  • $status
    • Default Value: array()

processValues_color_triple_rgb_many()

  • Signature: public function processValues_color_triple_rgb_many($configurator,$valueList,$status)

Parameters:

  • $configurator
  • $valueList
  • $status
    • Default Value: array()

processValues_color_triple_rgb_single()

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

  • Signature: public function writeOutJS($args)

Parameters:

  • $args

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

modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php

This article desrcibes the class I2CE_Module_ColorPickerwhich extends the class I2CE_Module It is contained in the module MooTools in the package I2CE The class is defined in the file: modules/MooTools/modules/ColorPicker/I2CE_Module_ColorPicker.php I2CE_Module_ColorPicker @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$color_triples

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

  • Type: protected $color_triples

Methods

__construct()

  • 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

  • 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

  • Signature: public function addUpdateBackgroundColor($event,$action_id,$update_id,$color)

Parameters:

  • string $event
  • $action_id
  • $update_id
  • string $color
    The hex color

convertColorTripleHexToRGB()

  • Signature: protected function convertColorTripleHexToRGB($c)

Parameters:

  • $c

convertColorTripleRGBToHex()

  • Signature: protected function convertColorTripleRGBToHex($c)

Parameters:

  • $c

displayValue_color_triple_hex_single()

  • Signature: public function displayValue_color_triple_hex_single($swissConfig,$valNode,$status,$config)

Parameters:

  • $swissConfig
  • $valNode
  • $status
  • $config

displayValue_color_triple_rgb_single()

  • Signature: public function displayValue_color_triple_rgb_single($swissConfig,$valNode,$status,$config)

Parameters:

  • $swissConfig
  • $valNode
  • $status
  • $config

ensureColorTripleHex()

  • Signature: protected function ensureColorTripleHex($c)

Parameters:

  • $c

ensureColorTripleRGB()

  • 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

  • Signature: protected function ensureHexColor($c)
  • Returns: string

Parameters:

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

  • Signature: protected function ensureRGBColor($c)
  • Returns: string

Parameters:

getHooks()

  • Signature: static public function getHooks()

getMethods()

  • Signature: static public function getMethods()

processValues_color_triple_hex_many()

  • Signature: public function processValues_color_triple_hex_many($configurator,$valueList,$status)

Parameters:

  • $configurator
  • $valueList
  • $status
    • Default Value: array()

processValues_color_triple_hex_single()

  • Signature: public function processValues_color_triple_hex_single($configurator,$value,$status)

Parameters:

  • $configurator
  • $value
  • $status
    • Default Value: array()

processValues_color_triple_rgb_many()

  • Signature: public function processValues_color_triple_rgb_many($configurator,$valueList,$status)

Parameters:

  • $configurator
  • $valueList
  • $status
    • Default Value: array()

processValues_color_triple_rgb_single()

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

  • Signature: public function writeOutJS($args)

Parameters:

  • $args

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_Module_ColorPicker&oldid=4825"