User interface class for a checkbox list overlay. More...

Collaboration diagram for ilCheckboxListOverlayGUI:

Public Member Functions
	__construct ($a_id="")
	Constructor. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get id. More...

	setHeaderIcon ($a_headericon)
	Set Header Icon. More...

	getHeaderIcon ()
	Get Header Icon. More...

	setLinkTitle ($a_val)
	Set link title. More...

	getLinkTitle ()
	Get link title. More...

	setItems ($a_val)
	Set items. More...

	getItems ()
	Get items. More...

	setSelectionHeaderClass ($a_selectionheaderclass)
	Set Selection Header Class. More...

	getSelectionHeaderClass ()
	Get Selection Header Class. More...

	setFormCmd ($a_val)
	Set form command. More...

	getFormCmd ()
	Get form command. More...

	setFieldVar ($a_val)
	Set field var. More...

	getFieldVar ()
	Get field var. More...

	setHiddenVar ($a_val)
	Set hidden var (used to indicated that checkbox array has been sent in a form) More...

	getHiddenVar ()
	Get hidden var. More...

	getHTML ()
	Get selection list HTML. More...

Data Fields
const	DOWN_ARROW_LIGHT = "mm_down_arrow.png"

const	DOWN_ARROW_DARK = "mm_down_arrow_dark.png"

const	NO_ICON = ""

Private Attributes
	$items = array()

Detailed Description

User interface class for a checkbox list overlay.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id:$

Definition at line 10 of file class.ilCheckboxListOverlayGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCheckboxListOverlayGUI::__construct ( $a_id = "" )

Constructor.

Definition at line 23 of file class.ilCheckboxListOverlayGUI.php.

References DOWN_ARROW_DARK, setHeaderIcon(), and setId().

         {
                 $this->setHeaderIcon(ilCheckboxListOverlayGUI::DOWN_ARROW_DARK);
                 $this->setId($a_id);
         }

Here is the call graph for this function:

Member Function Documentation

◆ getFieldVar()

ilCheckboxListOverlayGUI::getFieldVar ( )

Get field var.

Returns: string field var

Definition at line 164 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

         {
                 return $this->field_var;
         }

Here is the caller graph for this function:

◆ getFormCmd()

ilCheckboxListOverlayGUI::getFormCmd ( )

Get form command.

Returns: string form command

Definition at line 144 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

         {
                 return $this->form_cmd;
         }

Here is the caller graph for this function:

◆ getHeaderIcon()

ilCheckboxListOverlayGUI::getHeaderIcon ( )

Get Header Icon.

Returns: string Header Icon

Definition at line 64 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

         {
                 return $this->headericon;
         }

Here is the caller graph for this function:

◆ getHiddenVar()

ilCheckboxListOverlayGUI::getHiddenVar ( )

Get hidden var.

Returns: string hidden var

Definition at line 184 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

         {
                 return $this->hidden_var;
         }

Here is the caller graph for this function:

◆ getHTML()

ilCheckboxListOverlayGUI::getHTML ( )

Get selection list HTML.

Definition at line 191 of file class.ilCheckboxListOverlayGUI.php.

References $items, $lng, $tpl, DOWN_ARROW_DARK, DOWN_ARROW_LIGHT, getFieldVar(), getFormCmd(), getHeaderIcon(), getHiddenVar(), getId(), ilUtil\getImagePath(), getItems(), getLinkTitle(), and getSelectionHeaderClass().

         {
                 global $lng;
                 
                 $items = $this->getItems();
 
                 include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
                 $overlay = new ilOverlayGUI("ilChkboxListOverlay_".$this->getId());
                 $overlay->setAnchor("ilChkboxListAnchorEl_".$this->getId());
                 $overlay->setTrigger("ilChkboxListTrigger_".$this->getId());
                 $overlay->setAutoHide(false);
                 //$overlay->setSize("300px", "300px");
                 $overlay->add();
 
                 $tpl = new ilTemplate("tpl.checkbox_list_overlay.html", true, true,
                         "Services/UIComponent/CheckboxListOverlay", "DEFAULT", false, true);
                 
                 $tpl->setCurrentBlock("top_img");
                 switch ($this->getHeaderIcon())
                 {
                         case ilCheckboxListOverlayGUI::DOWN_ARROW_LIGHT:
                                 $tpl->setVariable("IMG_DOWN",
                                         ilUtil::getImagePath(ilCheckboxListOverlayGUI::DOWN_ARROW_LIGHT));
                                 break;
                         case ilCheckboxListOverlayGUI::DOWN_ARROW_DARK:
                                 $tpl->setVariable("IMG_DOWN",
                                         ilUtil::getImagePath(ilCheckboxListOverlayGUI::DOWN_ARROW_DARK));
                                 break;
                         default:
                                 $tpl->setVariable("IMG_DOWN", $this->getHeaderIcon());
                                 break;
                 }
                 // do not repeat title (accessibility) -> empty alt
                 $tpl->setVariable("TXT_SEL_TOP", $this->getLinkTitle());
                 $tpl->setVariable("ALT_SEL_TOP", "");
                 $tpl->setVariable("CLASS_SEL_TOP", $this->getSelectionHeaderClass());
                 $tpl->parseCurrentBlock();
                 
                 reset($items);
                 foreach ($items as $k => $v)
                 {
                         $tpl->setCurrentBlock("list_entry");
                         $tpl->setVariable("VAR", $this->getFieldVar());
                         $tpl->setVariable("VAL_ENTRY", $k);
                         $tpl->setVariable("TXT_ENTRY", $v["txt"]);
                         if ($v["selected"])
                         {
                                 $tpl->setVariable("CHECKED", "checked='checked'");
                         }
                         $tpl->parseCurrentBlock();
                 }
                 
                 $tpl->setVariable("ID", $this->getId());
                 $tpl->setVariable("HIDDEN_VAR", $this->getHiddenVar());
                 $tpl->setVariable("CMD_SUBMIT", $this->getFormCmd());
                 $tpl->setVariable("VAL_SUBMIT", $lng->txt("refresh"));
                 return $tpl->get();
         }

Here is the call graph for this function:

◆ getId()

ilCheckboxListOverlayGUI::getId ( )

Get id.

Returns: string id

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

Referenced by getHTML().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getItems()

ilCheckboxListOverlayGUI::getItems ( )

Get items.

Returns: array items

Definition at line 104 of file class.ilCheckboxListOverlayGUI.php.

References $items.

Referenced by getHTML().

         {
                 return $this->items;
         }

Here is the caller graph for this function:

◆ getLinkTitle()

ilCheckboxListOverlayGUI::getLinkTitle ( )

Get link title.

Returns: string link title

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

Referenced by getHTML().

         {
                 return $this->link_title;
         }

Here is the caller graph for this function:

◆ getSelectionHeaderClass()

ilCheckboxListOverlayGUI::getSelectionHeaderClass ( )

Get Selection Header Class.

Returns: string Selection Header Class

Definition at line 124 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

         {
                 return $this->selectionheaderclass;
         }

Here is the caller graph for this function:

◆ setFieldVar()

ilCheckboxListOverlayGUI::setFieldVar ( $a_val )

Set field var.

Parameters

string field var

Definition at line 154 of file class.ilCheckboxListOverlayGUI.php.

         {
                 $this->field_var = $a_val;
         }

◆ setFormCmd()

ilCheckboxListOverlayGUI::setFormCmd ( $a_val )

Set form command.

Parameters

string form command

Definition at line 134 of file class.ilCheckboxListOverlayGUI.php.

         {
                 $this->form_cmd = $a_val;
         }

◆ setHeaderIcon()

ilCheckboxListOverlayGUI::setHeaderIcon ( $a_headericon )

Set Header Icon.

Parameters

string $a_headericon Header Icon

Definition at line 54 of file class.ilCheckboxListOverlayGUI.php.

Referenced by __construct().

         {
                 $this->headericon = $a_headericon;
         }

Here is the caller graph for this function:

◆ setHiddenVar()

ilCheckboxListOverlayGUI::setHiddenVar ( $a_val )

Set hidden var (used to indicated that checkbox array has been sent in a form)

Parameters

string hidden var

Definition at line 174 of file class.ilCheckboxListOverlayGUI.php.

         {
                 $this->hidden_var = $a_val;
         }

◆ setId()

ilCheckboxListOverlayGUI::setId ( $a_val )

Set id.

Parameters

string id

Definition at line 34 of file class.ilCheckboxListOverlayGUI.php.

Referenced by __construct().

         {
                 $this->id = $a_val;
         }

Here is the caller graph for this function:

◆ setItems()

ilCheckboxListOverlayGUI::setItems ( $a_val )

Set items.

Parameters

array items

Definition at line 94 of file class.ilCheckboxListOverlayGUI.php.

         {
                 $this->items = $a_val;
         }

◆ setLinkTitle()

ilCheckboxListOverlayGUI::setLinkTitle ( $a_val )

Set link title.

Parameters

string link title

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

         {
                 $this->link_title = $a_val;
         }

◆ setSelectionHeaderClass()

ilCheckboxListOverlayGUI::setSelectionHeaderClass ( $a_selectionheaderclass )

Set Selection Header Class.

Parameters

string $a_selectionheaderclass Selection Header Class

Definition at line 114 of file class.ilCheckboxListOverlayGUI.php.

         {
                 $this->selectionheaderclass = $a_selectionheaderclass;
         }

Field Documentation

◆ $items

ilCheckboxListOverlayGUI::$items = array()

private

Definition at line 12 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML(), and getItems().

◆ DOWN_ARROW_DARK

const ilCheckboxListOverlayGUI::DOWN_ARROW_DARK = "mm_down_arrow_dark.png"

Definition at line 15 of file class.ilCheckboxListOverlayGUI.php.

Referenced by __construct(), and getHTML().

◆ DOWN_ARROW_LIGHT

const ilCheckboxListOverlayGUI::DOWN_ARROW_LIGHT = "mm_down_arrow.png"

Definition at line 14 of file class.ilCheckboxListOverlayGUI.php.

Referenced by getHTML().

◆ NO_ICON

const ilCheckboxListOverlayGUI::NO_ICON = ""

Definition at line 16 of file class.ilCheckboxListOverlayGUI.php.

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

Services/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php

Public Member Functions

Data Fields

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFieldVar()

◆ getFormCmd()

◆ getHeaderIcon()

◆ getHiddenVar()

◆ getHTML()

◆ getId()

◆ getItems()

◆ getLinkTitle()

◆ getSelectionHeaderClass()

◆ setFieldVar()

◆ setFormCmd()

◆ setHeaderIcon()

◆ setHiddenVar()

◆ setId()

◆ setItems()

◆ setLinkTitle()

◆ setSelectionHeaderClass()

Field Documentation

◆ $items

◆ DOWN_ARROW_DARK

◆ DOWN_ARROW_LIGHT

◆ NO_ICON