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 (string $a_title="", string $a_postvar="")

	setAllValue (string $a_allvalue)

	getAllValue ()

	setTopValue (string $a_topvalue)

	getTopValue ()

	setBottomValue (string $a_bottomvalue)

	getBottomValue ()

	setLeftValue (string $a_leftvalue)

	getLeftValue ()

	setRightValue (string $a_rightvalue)

	getRightValue ()

	setDefaultColor (string $a_defaultcolor)

	getDefaultColor ()

	setAcceptNamedColors (bool $a_acceptnamedcolors)

	getAcceptNamedColors ()

	checkInput ()

	getInput ()

	insert (ilTemplate $a_tpl)

Public Member Functions inherited from ilTextInputGUI
	__construct (string $a_title="", string $a_postvar="")

	setValue ($a_value)

	getValue ()

	setValidationFailureMessage (string $a_msg)

	getValidationFailureMessage ()

	setValidationRegexp (string $a_value)

	getValidationRegexp ()

	setMaxLength (?int $a_maxlength)

	getMaxLength ()

	setSize (int $a_size)

	setInlineStyle (string $a_style)

	getInlineStyle ()

	setCssClass (string $a_class)

	getCssClass ()

	setValueByArray (array $a_values)

	getSize ()

	setSuffix (string $a_value)

	getSuffix ()

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

	getInputType ()

	setSubmitFormOnEnter (bool $a_val)

	getSubmitFormOnEnter ()

	checkInput ()

	getInput ()

	getDataSource ()

	setDataSource (string $href, ?string $a_delimiter=null)

	setDataSourceSubmitOnSelection (bool $a_stat)

	getDataSourceSubmitOnSelection ()

	setDataSourceSubmitUrl (string $a_url)

	getDataSourceSubmitUrl ()

	setMultiValues (array $a_values)

	render (string $a_mode="")

	insert (ilTemplate $a_tpl)

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

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

	setDisableHtmlAutoComplete (bool $autocomplete)

	isHtmlAutoCompleteDisabled ()

	getPostValueForComparison ()

Public Member Functions inherited from ilSubEnabledFormPropertyGUI
	addSubItem (ilFormPropertyGUI $a_item)

	getSubItems ()

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

	checkSubItemsInput ()
	Check SubItems. More...

	getSubForm ()

	getItemByPostVar (string $a_post_var)

Public Member Functions inherited from ilFormPropertyGUI
	__construct (string $a_title="", string $a_postvar="")

	executeCommand ()

	getType ()

	setTitle (string $a_title)

	getTitle ()

	setPostVar (string $a_postvar)

	getPostVar ()

	getFieldId ()

	setInfo (string $a_info)

	getInfo ()

	setAlert (string $a_alert)

	getAlert ()

	setRequired (bool $a_required)

	getRequired ()

	setDisabled (bool $a_disabled)

	getDisabled ()

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

	setParentForm (ilPropertyFormGUI $a_parentform)

	getParentForm ()

	setParent (ilFormPropertyGUI $a_val)

	getParent ()

	getSubForm ()

	hideSubForm ()

	setHiddenTitle (string $a_val)

	getHiddenTitle ()

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

	serializeData ()

	unserializeData (string $a_data)

	setParentTable ($a_val)
	Set parent table. More...

	getParentTable ()
	Get parent table. More...

	writeToSession ()

	clearFromSession ()

	readFromSession ()

	getHiddenTag (string $a_post_var, string $a_value)

	setMulti (bool $a_multi, bool $a_sortable=false, bool $a_addremove=true)

	getMulti ()

	setMultiValues (array $a_values)

	getMultiValues ()

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

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

	getTableFilterLabelFor ()
	Get label "for" attribute value for filter. More...

	getFormLabelFor ()
	Get label "for" attribute value for form. More...

	setRequestParam (string $key, $val)
	This writes the request (aka post) values. More...

Public Member Functions inherited from ilTableFilterItem
	getTableFilterLabelFor ()
	Get label "for" attribute value. More...

Protected Attributes
bool	$acceptnamedcolors = false

string	$defaultcolor = ""

string	$allvalue = ""

string	$leftvalue = ""

string	$rightvalue = ""

string	$bottomvalue = ""

string	$topvalue = ""

array	$dirs = []

string	$hex = ""

Protected Attributes inherited from ilTextInputGUI
	$value = null

int	$maxlength = 200

int	$size = 40

string	$validationRegexp = ""

string	$validationFailureMessage = ''

string	$suffix = ""

string	$style_css = ""

string	$css_class = ""

string	$ajax_datasource = ""

string	$ajax_datasource_delimiter = null

bool	$ajax_datasource_commit = false

string	$ajax_datasource_commit_url = ""

bool	$submit_form_on_enter = false

bool	$autocomplete_disabled = false

string	$input_type = ""

Protected Attributes inherited from ilSubEnabledFormPropertyGUI
array	$sub_items = array()

Protected Attributes inherited from ilFormPropertyGUI
array	$set_params = []

ilTable2GUI	$parent_table = null

ilFormPropertyGUI	$parent_gui = null

ilCtrl	$ctrl

ilLanguage	$lng

string	$type = ""

string	$title = ""

string	$postvar = ""

string	$info = ""

string	$alert = ""

bool	$required = false

ilPropertyFormGUI	$parentform = null

string	$hidden_title = ""

bool	$multi = false

bool	$multi_sortable = false

bool	$multi_addremove = true

array	$multi_values = []

RequestInterface	$request

HTTP Services	$http

Refinery Factory	$refinery = null

bool	$disabled = false

ilGlobalTemplateInterface	$global_tpl = null

Additional Inherited Members
Static Public Member Functions inherited from ilFormPropertyGUI
static	removeProhibitedCharacters (string $a_text)
	Remove prohibited characters see #19159. More...

Protected Member Functions inherited from ilFormPropertyGUI
	symbol ()

	setType (string $a_type)

	checkParentFormTable ()

	getSessionKey ()

	getMultiIconsHTML ()

	int ($key)

	intArray ($key)

	str ($key)

	raw ($key)

	strArray ($key)

	arrayArray ($key)

	isRequestParamArray (string $key)

	getRequestParam (string $key, Refinery\Transformation $t)

Detailed Description

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

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setType().

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

Here is the call graph for this function:

Member Function Documentation

◆ checkInput()

ilTRBLColorPickerInputGUI::checkInput ( )

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

References ilTextInputGUI\$value, getInput(), setAllValue(), setBottomValue(), setLeftValue(), setRightValue(), and setTopValue().

                                 : bool
     {
         $input = $this->getInput();
         foreach ($this->dirs as $dir) {
             $value = $input[$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;
     }

Here is the call graph for this function:

◆ getAcceptNamedColors()

ilTRBLColorPickerInputGUI::getAcceptNamedColors ( )

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

References $acceptnamedcolors.

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

                                           : bool
     {
         return $this->acceptnamedcolors;
     }

Here is the caller graph for this function:

◆ getAllValue()

ilTRBLColorPickerInputGUI::getAllValue ( )

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

References $allvalue.

                                  : string
     {
         return $this->allvalue;
     }

◆ getBottomValue()

ilTRBLColorPickerInputGUI::getBottomValue ( )

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

References $bottomvalue.

                                     : string
     {
         return $this->bottomvalue;
     }

◆ getDefaultColor()

ilTRBLColorPickerInputGUI::getDefaultColor ( )

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

References $defaultcolor.

                                      : string
     {
         return $this->defaultcolor;
     }

◆ getInput()

ilTRBLColorPickerInputGUI::getInput ( )

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

References ilFormPropertyGUI\arrayArray(), and ilFormPropertyGUI\getPostVar().

Referenced by checkInput().

                               : array
     {
         return $this->arrayArray($this->getPostVar());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLeftValue()

ilTRBLColorPickerInputGUI::getLeftValue ( )

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

References $leftvalue.

                                   : string
     {
         return $this->leftvalue;
     }

◆ getRightValue()

ilTRBLColorPickerInputGUI::getRightValue ( )

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

References $rightvalue.

                                    : string
     {
         return $this->rightvalue;
     }

◆ getTopValue()

ilTRBLColorPickerInputGUI::getTopValue ( )

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

References $topvalue.

                                  : string
     {
         return $this->topvalue;
     }

◆ insert()

ilTRBLColorPickerInputGUI::insert ( ilTemplate $a_tpl )

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

References Vendor\Package\$f, ilFormPropertyGUI\$lng, ilTextInputGUI\$value, ilColorPickerInputGUI\determineHexcode(), getAcceptNamedColors(), ilFormPropertyGUI\getDisabled(), ilFormPropertyGUI\getFieldId(), ilFormPropertyGUI\getPostVar(), ilTextInputGUI\getValue(), ilTemplate\parseCurrentBlock(), ilLegacyFormElementsUtil\prepareFormOutput(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilLanguage\txt().

                                              : void
     {
         $lng = $this->lng;
 
         $layout_tpl = new ilTemplate("tpl.prop_trbl_layout.html", true, true, "components/ILIAS/Style/Content");
 
         $funcs = array(
             "all" => "getAllValue", "top" => "getTopValue",
             "bottom" => "getBottomValue", "left" => "getLeftValue",
             "right" => "getRightValue");
 
         foreach ($this->dirs as $dir) {
             $f = $funcs[$dir];
             $value = trim($this->$f());
             if (!$this->getAcceptNamedColors() || substr($value, 0, 1) != "!") {
                 $value = strtoupper($value);
             }
 
             $tpl = new ilTemplate('tpl.prop_color.html', true, true, 'components/ILIAS/Form');
             $tpl->setVariable('COLOR_ID', $this->getFieldId() . "_" . $dir);
             $ic = ilColorPickerInputGUI::determineHexcode($value);
             if ($ic == "") {
                 $ic = "FFFFFF";
             }
             $tpl->setVariable('INIT_COLOR_SHORT', $ic);
             $tpl->setVariable('POST_VAR', $this->getPostVar());
 
             if ($this->getDisabled()) {
                 $a_tpl->setVariable('COLOR_DISABLED', 'disabled="disabled"');
             }
 
             $tpl->setVariable("POST_VAR", $this->getPostVar() . "[" . $dir . "][value]");
             $tpl->setVariable("PROP_COLOR_ID", $this->getFieldId() . "_" . $dir);
 
             if (substr(trim((string) $this->getValue()), 0, 1) == "!" && $this->getAcceptNamedColors()) {
                 $tpl->setVariable(
                     "PROPERTY_VALUE_COLOR",
                     ilLegacyFormElementsUtil::prepareFormOutput(trim($this->getValue()))
                 );
             } else {
                 $tpl->setVariable("PROPERTY_VALUE_COLOR", ilLegacyFormElementsUtil::prepareFormOutput($value));
                 $tpl->setVariable('INIT_COLOR', '#' . $value);
             }
 
             $tpl->setVariable("TXT_PREFIX", $lng->txt("sty_$dir"));
 
             $layout_tpl->setVariable(strtoupper($dir), $tpl->get());
         }
 
         $a_tpl->setCurrentBlock("prop_generic");
         $a_tpl->setVariable("PROP_GENERIC", $layout_tpl->get());
         $a_tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ setAcceptNamedColors()

ilTRBLColorPickerInputGUI::setAcceptNamedColors ( bool $a_acceptnamedcolors )

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

Referenced by ilStyleCharacteristicGUI\initTagStyleForm().

                                                                    : void
     {
         $this->acceptnamedcolors = $a_acceptnamedcolors;
     }

Here is the caller graph for this function:

◆ setAllValue()

ilTRBLColorPickerInputGUI::setAllValue ( string $a_allvalue )

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

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

Referenced by checkInput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBottomValue()

ilTRBLColorPickerInputGUI::setBottomValue ( string $a_bottomvalue )

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

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

Referenced by checkInput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultColor()

ilTRBLColorPickerInputGUI::setDefaultColor ( string $a_defaultcolor )

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

                                                            : void
     {
         $this->defaultcolor = $a_defaultcolor;
     }

◆ setLeftValue()

ilTRBLColorPickerInputGUI::setLeftValue ( string $a_leftvalue )

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

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

Referenced by checkInput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRightValue()

ilTRBLColorPickerInputGUI::setRightValue ( string $a_rightvalue )

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

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

Referenced by checkInput().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTopValue()

ilTRBLColorPickerInputGUI::setTopValue ( string $a_topvalue )

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

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

Referenced by checkInput().

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