ColorPicker Class Reference

Inheritance diagram for ColorPicker:

Public Member Functions
	__construct ($path_type)
	initialise ($name='cp', $config='default', $mode='popup')
	display ($name=null, $color=null)
	execute_request ()
	display_modalWindow ()
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	initialise ($params=array())
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	get_varFile ($file)

Protected Attributes
	$cp_name
	The object name. More...
	$mode
	Running mode. More...
	$modaldisplay = false
	Is in modal mode. More...
	$color
	Current color. More...
	$config
	Color config to display. More...

Private Member Functions
	get_configs ()
	get_config ()

Additional Inherited Members
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

ColorPicker Input class.

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Constructor & Destructor Documentation

__construct()

ColorPicker::__construct

(

$path_type

)

Class constructor.

Parameters

String

$path_type

Returns

void

Member Function Documentation

initialise()

ColorPicker::initialise	(		$name = 'cp',
			$config = 'default',
			$mode = 'popup'
	)

Initialise input.

Parameters

string	$name
string	$config
string	$mode

Returns

void

display()

ColorPicker::display	(		$name = null,
			$color = null
	)

Display Input.

Parameters

string	$name
string	$color

Returns

void

execute_request()

ColorPicker::execute_request

(

)

Execute Input in request mode.

Returns

void

Reimplemented from Plugin.

display_modalWindow()

ColorPicker::display_modalWindow

(

)

Display modal window.

Returns

void

get_configs()

ColorPicker::get_configs ( )

private

Return available configurations.

Returns

array

get_config()

ColorPicker::get_config ( )

private

Load configuration.

Returns

void

Member Data Documentation

$cp_name

ColorPicker::$cp_name

protected

The object name.

var string $cp_name

$mode

ColorPicker::$mode

protected

Running mode.

var string $mode

$modaldisplay

ColorPicker::$modaldisplay = false

protected

Is in modal mode.

var boolean $modaldisplay

$color

ColorPicker::$color

protected

Current color.

var string $color

$config

ColorPicker::$config

protected

Color config to display.

var string $config

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/ColorPicker/ColorPicker.php.inc