Color picker form for selecting color hexcodes using yui library (all/top/right/bottom/left) More...

Inheritance diagram for ilTRBLColorPickerInputGUI:

Collaboration diagram for ilTRBLColorPickerInputGUI:

Public Member Functions
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setAllValue ($a_allvalue)
	Set All Value. More...

	getAllValue ()
	Get All Value. More...

	setTopValue ($a_topvalue)
	Set Top Value. More...

	getTopValue ()
	Get Top Value. More...

	setBottomValue ($a_bottomvalue)
	Set Bottom Value. More...

	getBottomValue ()
	Get Bottom Value. More...

	setLeftValue ($a_leftvalue)
	Set Left Value. More...

	getLeftValue ()
	Get Left Value. More...

	setRightValue ($a_rightvalue)
	Set Right Value. More...

	getRightValue ()
	Get Right Value. More...

	setDefaultColor ($a_defaultcolor)
	Set Default Color. More...

	getDefaultColor ()
	Get Default Color. More...

	setAcceptNamedColors ($a_acceptnamedcolors)
	Set Accept Named Colors (Leading '!'). More...

	getAcceptNamedColors ()
	Get Accept Named Colors (Leading '!'). More...

	checkInput ()
	check input More...

	insert ($a_tpl)
	Insert property html. More...

Public Member Functions inherited from ilTextInputGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

	setValue ($a_value)
	Set Value. More...

	getValue ()
	Get Value. More...

	setValidationFailureMessage ($a_msg)
	Set message string for validation failure. More...

	getValidationFailureMessage ()

	setValidationRegexp ($a_value)
	Set validation regexp. More...

	getValidationRegexp ()
	Get validation regexp. More...

	setMaxLength ($a_maxlength)
	Set Max Length. More...

	getMaxLength ()
	Get Max Length. More...

	setSize ($a_size)
	Set Size. More...

	setInlineStyle ($a_style)
	Set inline style. More...

	getInlineStyle ()
	Get inline style. More...

	setCssClass ($a_class)

	getCssClass ()

	setValueByArray ($a_values)
	Set value by array. More...

	getSize ()
	Get Size. More...

	setSuffix ($a_value)
	Set suffix. More...

	getSuffix ()
	Get suffix. More...

	setInputType ($a_type)
	set input type More...

	getInputType ()
	get input type More...

	setSubmitFormOnEnter ($a_val)
	Set submit form on enter. More...

	getSubmitFormOnEnter ()
	Get submit form on enter. More...

	checkInput ()
	Check input, strip slashes etc. More...

	getDataSource ()
	get datasource link for js autocomplete More...

	setDataSource ($href, $a_delimiter=null)
	set datasource link for js autocomplete More...

	setDataSourceSubmitOnSelection ($a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl ($a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)
	Set multi values. More...

	insert (&$a_tpl)
	Insert property html. More...

	getTableFilterHTML ()
	Get HTML for table filter. More...

	getToolbarHTML ()
	Get HTML for toolbar. More...

	setDisableHtmlAutoComplete ($autocomplete)

	isHtmlAutoCompleteDisabled ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem ($a_item)
	Add Subitem. More...

	getSubItems ()
	Get Subitems. More...

	getSubInputItemsRecursive ()
	returns a flat array of possibly existing subitems recursively More...

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()
	Get sub form html. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

Public Member Functions inherited from ilFormPropertyGUI
	__construct ($a_title="", $a_postvar="")
	Constructor. More...

&	executeCommand ()
	Execute command. More...

	getType ()
	Get Type. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setPostVar ($a_postvar)
	Set Post Variable. More...

	getPostVar ()
	Get Post Variable. More...

	getFieldId ()
	Get Post Variable. More...

	setInfo ($a_info)
	Set Information Text. More...

	getInfo ()
	Get Information Text. More...

	setAlert ($a_alert)
	Set Alert Text. More...

	getAlert ()
	Get Alert Text. More...

	setRequired ($a_required)
	Set Required. More...

	getRequired ()
	Get Required. More...

	setDisabled ($a_disabled)
	Set Disabled. More...

	getDisabled ()
	Get Disabled. More...

	checkInput ()
	Check input, strip slashes etc. More...

	setParentForm ($a_parentform)
	Set Parent Form. More...

	getParentForm ()
	Get Parent Form. More...

	setParent ($a_val)
	Set Parent GUI object. More...

	getParent ()
	Get Parent GUI object. More...

	getSubForm ()
	Get sub form html. More...

	hideSubForm ()
	Sub form hidden on init? More...

	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders) More...

	getHiddenTitle ()
	Get hidden title. More...

	getItemByPostVar ($a_post_var)
	Get item by post var. More...

	serializeData ()
	serialize data More...

	unserializeData ($a_data)
	unserialize data More...

	writeToSession ()
	Write to session. More...

	clearFromSession ()
	Clear session value. More...

	readFromSession ()
	Read from session. More...

	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties) More...

	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi. More...

	getMulti ()
	Get Multi. More...

	setMultiValues (array $a_values)
	Set multi values. More...

	getMultiValues ()
	Get multi values. More...

	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g. More...

	removeProhibitedCharacters ($a_text)
	Remove prohibited characters see #19159. More...

	stripSlashesAddSpaceFallback ($a_str)
	Strip slashes with add space fallback, see https://www.ilias.de/mantis/view.php?id=19727. More...

	getTableFilterHTML ()
	Get input item HTML to be inserted into table filters. More...

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Protected Attributes
	$hex

Protected Attributes inherited from ilTextInputGUI
	$value

	$maxlength = 200

	$size = 40

	$validationRegexp

	$validationFailureMessage = ''

	$suffix

	$style_css

	$css_class

	$ajax_datasource

	$ajax_datasource_delimiter

	$ajax_datasource_commit = FALSE

	$ajax_datasource_commit_url

	$submit_form_on_enter = false

	$autocomplete_disabled = false

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
	$type

	$title

	$postvar

	$info

	$alert

	$required = false

	$parentgui

	$parentform

	$hidden_title = ""

	$multi = false

	$multi_sortable = false

	$multi_addremove = true

	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type. More...

	getMultiIconsHTML ()
	Get HTML for multiple value icons. More...

Detailed Description

Color picker form for selecting color hexcodes using yui library (all/top/right/bottom/left)

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

Version: $Id$

Definition at line 33 of file class.ilTRBLColorPickerInputGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTRBLColorPickerInputGUI::__construct	(	$a_title = `""`,
		$a_postvar = `""`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilTextInputGUI.

Definition at line 44 of file class.ilTRBLColorPickerInputGUI.php.

        {
                parent::__construct($a_title, $a_postvar);
                $this->setType("trbl_color");
                $this->dirs = array("all", "top", "bottom", "left", "right");
        }

References ilFormPropertyGUI\setType().

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilTRBLColorPickerInputGUI::checkInput ( )

check input

@access public

Returns

Reimplemented from ilTextInputGUI.

Definition at line 237 of file class.ilTRBLColorPickerInputGUI.php.

        {
                foreach ($this->dirs as $dir)
                {
                        $value = $_POST[$this->getPostVar()][$dir]["value"] = 
                                ilUtil::stripSlashes($_POST[$this->getPostVar()][$dir]["value"]);
 
                        if (trim($value) != "")
                        {
                                switch ($dir)
                                {
                                        case "all": $this->setAllValue($value); break;
                                        case "top": $this->setTopValue($value); break;
                                        case "bottom": $this->setBottomValue($value); break;
                                        case "left": $this->setLeftValue($value); break;
                                        case "right": $this->setRightValue($value); break;
                                }
                        }
                }
                return true;
        }

References $_POST, ilTextInputGUI\$value, ilFormPropertyGUI\getPostVar(), setAllValue(), setBottomValue(), setLeftValue(), setRightValue(), setTopValue(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getAcceptNamedColors()

ilTRBLColorPickerInputGUI::getAcceptNamedColors ( )

Get Accept Named Colors (Leading '!').

Returns: boolean Accept Named Colors (Leading '!')

Definition at line 226 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->acceptnamedcolors;
        }

Referenced by insert(), setAllValue(), setBottomValue(), setLeftValue(), setRightValue(), and setTopValue().

Here is the caller graph for this function:

◆ getAllValue()

ilTRBLColorPickerInputGUI::getAllValue ( )

Get All Value.

Returns: string All Value

Definition at line 74 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->allvalue;
        }

◆ getBottomValue()

ilTRBLColorPickerInputGUI::getBottomValue ( )

Get Bottom Value.

Returns: string Bottom Value

Definition at line 130 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->bottomvalue;
        }

◆ getDefaultColor()

ilTRBLColorPickerInputGUI::getDefaultColor ( )

Get Default Color.

Returns: mixed Default Color

Definition at line 206 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->defaultcolor;
        }

◆ getLeftValue()

ilTRBLColorPickerInputGUI::getLeftValue ( )

Get Left Value.

Returns: string Left Value

Definition at line 158 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->leftvalue;
        }

◆ getRightValue()

ilTRBLColorPickerInputGUI::getRightValue ( )

Get Right Value.

Returns: string Right Value

Definition at line 186 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->rightvalue;
        }

◆ getTopValue()

ilTRBLColorPickerInputGUI::getTopValue ( )

Get Top Value.

Returns: string Top Value

Definition at line 102 of file class.ilTRBLColorPickerInputGUI.php.

        {
                return $this->topvalue;
        }

◆ insert()

ilTRBLColorPickerInputGUI::insert ( $a_tpl )

Insert property html.

Returns: int Size

Definition at line 264 of file class.ilTRBLColorPickerInputGUI.php.

        {
                global $lng;
                
                include_once('./Services/YUI/classes/class.ilYuiUtil.php');
                ilYuiUtil::initColorPicker();
                
                $layout_tpl = new ilTemplate("tpl.prop_trbl_layout.html", true, true, "Services/Style");
                
                $funcs = array(
                        "all" => "getAllValue", "top" => "getTopValue",
                        "bottom" => "getBottomValue", "left" => "getLeftValue",
                        "right" => "getRightValue");
                
                foreach ($this->dirs as $dir)
                {
                        /*switch($dir)
                        {
                                case "all": $value = strtoupper(trim($this->getAllValue())); break;
                                case "top": $value = strtoupper(trim($this->getTopValue())); break;
                                case "bottom": $value = strtoupper(trim($this->getBottomValue())); break;
                                case "left": $value = strtoupper(trim($this->getLeftValue())); break;
                                case "right": $value = strtoupper(trim($this->getRightValue())); break;
                        }*/
                        $value = trim($this->$funcs[$dir]());
                        if (!$this->getAcceptNamedColors() || substr($value, 0, 1) != "!")
                        {
                                $value = strtoupper($value);
                        }
 
                        $ctpl = new ilTemplate("tpl.prop_trbl_color.html", true, true, "Services/Style");
 
                        $js_tpl = new ilTemplate('tpl.trbl_color_picker.js',true,true,'Services/Style');
                        $js_tpl->setVariable('THUMB_PATH',ilUtil::getImagePath('color_picker_thumb.png','Services/Form'));
                        $js_tpl->setVariable('HUE_THUMB_PATH',ilUtil::getImagePath('color_picker_hue_thumb.png','Services/Form'));
                        $js_tpl->setVariable('COLOR_ID',$this->getFieldId()."_".$dir);
                        $ic = ilColorPickerInputGUI::determineHexcode($value);
                        if ($ic == "")
                        {
                                $ic = "FFFFFF";
                        }
                        $js_tpl->setVariable('INIT_COLOR_SHORT',$ic);
                        $js_tpl->setVariable('INIT_COLOR','#'.$value);
                        $js_tpl->setVariable('POST_VAR', $this->getPostVar());
                        $js_tpl->setVariable('DIR', $dir);
                
                
                        if($this->getDisabled())
                        {
                                $ctpl->setVariable('COLOR_DISABLED','disabled="disabled"');
                        }
                        else
                        {
                                $ctpl->setVariable('PROP_COLOR_JS',$js_tpl->get());             
                        }
                        $ctpl->setVariable("POST_VAR", $this->getPostVar());
                        $ctpl->setVariable("PROP_COLOR_ID", $this->getFieldId()."_".$dir);
                        
                        $ctpl->setVariable("PROPERTY_VALUE_COLOR", $value);
                        $ctpl->setVariable("DIR", $dir);
                        $ctpl->setVariable("TXT_DIR", $lng->txt("sty_$dir"));
                        
                        $layout_tpl->setVariable(strtoupper($dir), $ctpl->get());
                }
 
                $a_tpl->setCurrentBlock("prop_generic");
                $a_tpl->setVariable("PROP_GENERIC", $layout_tpl->get());
                $a_tpl->parseCurrentBlock();
                
        }

References $lng, ilTextInputGUI\$value, ilColorPickerInputGUI\determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilUtil\getImagePath(), ilFormPropertyGUI\getPostVar(), and ilYuiUtil\initColorPicker().

Here is the call graph for this function:

◆ setAcceptNamedColors()

ilTRBLColorPickerInputGUI::setAcceptNamedColors ( $a_acceptnamedcolors )

Set Accept Named Colors (Leading '!').

Parameters

boolean $a_acceptnamedcolors Accept Named Colors (Leading '!')

Definition at line 216 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $this->acceptnamedcolors = $a_acceptnamedcolors;
        }

◆ setAllValue()

ilTRBLColorPickerInputGUI::setAllValue ( $a_allvalue )

Set All Value.

Parameters

string $a_allvalue All Value

Definition at line 56 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $a_allvalue = trim($a_allvalue);
                if ($this->getAcceptNamedColors() && substr($a_allvalue, 0, 1) == "!")
                {
                        $this->allvalue = $a_allvalue;
                }
                else
                {
                        $this->allvalue = ilColorPickerInputGUI::determineHexcode($a_allvalue);
                }
        }

References ilColorPickerInputGUI\determineHexcode(), and getAcceptNamedColors().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBottomValue()

ilTRBLColorPickerInputGUI::setBottomValue ( $a_bottomvalue )

Set Bottom Value.

Parameters

string $a_bottomvalue Bottom Value

Definition at line 112 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $a_bottomvalue = trim($a_bottomvalue);
                if ($this->getAcceptNamedColors() && substr($a_bottomvalue, 0, 1) == "!")
                {
                        $this->bottomvalue = $a_bottomvalue;
                }
                else
                {
                        $this->bottomvalue = ilColorPickerInputGUI::determineHexcode($a_bottomvalue);
                }
        }

References ilColorPickerInputGUI\determineHexcode(), and getAcceptNamedColors().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultColor()

ilTRBLColorPickerInputGUI::setDefaultColor ( $a_defaultcolor )

Set Default Color.

Parameters

mixed $a_defaultcolor Default Color

Definition at line 196 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $this->defaultcolor = $a_defaultcolor;
        }

◆ setLeftValue()

ilTRBLColorPickerInputGUI::setLeftValue ( $a_leftvalue )

Set Left Value.

Parameters

string $a_leftvalue Left Value

Definition at line 140 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $a_leftvalue = trim($a_leftvalue);
                if ($this->getAcceptNamedColors() && substr($a_leftvalue, 0, 1) == "!")
                {
                        $this->leftvalue = $a_leftvalue;
                }
                else
                {
                        $this->leftvalue = ilColorPickerInputGUI::determineHexcode($a_leftvalue);
                }
        }

References ilColorPickerInputGUI\determineHexcode(), and getAcceptNamedColors().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRightValue()

ilTRBLColorPickerInputGUI::setRightValue ( $a_rightvalue )

Set Right Value.

Parameters

string $a_rightvalue Right Value

Definition at line 168 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $a_rightvalue = trim($a_rightvalue);
                if ($this->getAcceptNamedColors() && substr($a_rightvalue, 0, 1) == "!")
                {
                        $this->rightvalue = $a_rightvalue;
                }
                else
                {
                        $this->rightvalue = ilColorPickerInputGUI::determineHexcode($a_rightvalue);
                }
        }

References ilColorPickerInputGUI\determineHexcode(), and getAcceptNamedColors().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTopValue()

ilTRBLColorPickerInputGUI::setTopValue ( $a_topvalue )

Set Top Value.

Parameters

string $a_topvalue Top Value

Definition at line 84 of file class.ilTRBLColorPickerInputGUI.php.

        {
                $a_topvalue = trim($a_topvalue);
                if ($this->getAcceptNamedColors() && substr($a_topvalue, 0, 1) == "!")
                {
                        $this->topvalue = $a_topvalue;
                }
                else
                {
                        $this->topvalue = ilColorPickerInputGUI::determineHexcode($a_topvalue);
                }
        }

References ilColorPickerInputGUI\determineHexcode(), and getAcceptNamedColors().

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $hex

ilTRBLColorPickerInputGUI::$hex

protected

Definition at line 35 of file class.ilTRBLColorPickerInputGUI.php.

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

Services/Style/classes/class.ilTRBLColorPickerInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkInput()

◆ getAcceptNamedColors()

◆ getAllValue()

◆ getBottomValue()

◆ getDefaultColor()

◆ getLeftValue()

◆ getRightValue()

◆ getTopValue()

◆ insert()

◆ setAcceptNamedColors()

◆ setAllValue()

◆ setBottomValue()

◆ setDefaultColor()

◆ setLeftValue()

◆ setRightValue()

◆ setTopValue()

Field Documentation

◆ $hex