ilGroupedListGUI Class Reference

Grouped list GUI class. More...

Inheritance diagram for ilGroupedListGUI:

Collaboration diagram for ilGroupedListGUI:

Public Member Functions
	__construct ($id="")
	Constructor. More...
	setAsDropDown ($a_val, $a_pullright=false)
	Set as drop down. More...
	getAsDropDown ()
	Get as drop down. More...
	addGroupHeader ($a_content, $a_add_class="")
	Add group header. More...
	addSeparator ()
	Add separator. More...
	nextColumn ()
	Add separator. More...
	addEntry ( $a_content, $a_href="", $a_target="", $a_onclick="", $a_add_class="", $a_id="", $a_ttip="", $a_tt_my="right center", $a_tt_at="left center", $a_tt_use_htmlspecialchars=true)
	Add entry. More...
	getHTML ()
	Get HTML. More...

Protected Attributes
	$ctrl
	$multi_column = false
	$items = array()
	$as_dropdown = false
	$dd_pullright = false
	$id

Detailed Description

Grouped list GUI class.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilGroupedListGUI::__construct

(

$id = ""

)

Constructor.

Definition at line 28 of file class.ilGroupedListGUI.php.

References $DIC, and $id.

    {
        global $DIC;

        $this->id = $id;
        $this->ctrl = $DIC->ctrl();
    }

Member Function Documentation

addEntry()

ilGroupedListGUI::addEntry	(		$a_content,
			$a_href = "",
			$a_target = "",
			$a_onclick = "",
			$a_add_class = "",
			$a_id = "",
			$a_ttip = "",
			$a_tt_my = "right center",
			$a_tt_at = "left center",
			$a_tt_use_htmlspecialchars = true
	)

Add entry.

Parameters

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

      {
        $this->items[] = array("type" => "entry", "content" => $a_content,
            "href" => $a_href, "target" => $a_target, "onclick" => $a_onclick,
            "add_class" => $a_add_class, "id" => $a_id, "ttip" => $a_ttip,
            "tt_my" => $a_tt_my, "tt_at" => $a_tt_at,
            "tt_use_htmlspecialchars" => $a_tt_use_htmlspecialchars);
    }

addGroupHeader()

ilGroupedListGUI::addGroupHeader	(		$a_content,
			$a_add_class = ""
	)

Add group header.

Parameters

Definition at line 63 of file class.ilGroupedListGUI.php.

    {
        $this->items[] = array("type" => "group_head", "content" => $a_content,
            "add_class" => $a_add_class);
    }

addSeparator()

ilGroupedListGUI::addSeparator

(

)

Add separator.

Definition at line 72 of file class.ilGroupedListGUI.php.

    {
        $this->items[] = array("type" => "sep");
    }

getAsDropDown()

ilGroupedListGUI::getAsDropDown

(

)

Get as drop down.

Returns

bool as drop down menu

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

References $as_dropdown.

Referenced by getHTML().

    {
        return $this->as_dropdown;
    }

Here is the caller graph for this function:

getHTML()

ilGroupedListGUI::getHTML

(

)

Get HTML.

Parameters

Definition at line 118 of file class.ilGroupedListGUI.php.

References $ctrl, $i, $tpl, ilTooltipGUI\addTooltip(), getAsDropDown(), and ilUtil\secureUrl().

    {
        $ilCtrl = $this->ctrl;
        
        $tpl = new ilTemplate("tpl.grouped_list.html", true, true, "Services/UIComponent/GroupedList");
        $tt_calls = "";
        foreach ($this->items as $i) {
            switch ($i["type"]) {
                case "sep":
                    $tpl->touchBlock("sep");
                    $tpl->touchBlock("item");
                    break;
                    
                case "next_col":
                    $tpl->touchBlock("next_col");
                    $tpl->touchBlock("item");
                    break;
                    
                case "group_head":
                    $tpl->setCurrentBlock("group_head");
                    if ($i["add_class"] != "") {
                        $tpl->setVariable("ADD_CLASS", $i["add_class"]);
                    }
                    $tpl->setVariable("GROUP_HEAD", $i["content"]);
                    $tpl->parseCurrentBlock();
                    $tpl->touchBlock("item");
                    break;
                    
                case "entry":
                    if ($i["href"] != "") {
                        $tpl->setCurrentBlock("linked_entry");
                        if ($i["add_class"] != "") {
                            $tpl->setVariable("ADD_CLASS", $i["add_class"]);
                        }
                        $tpl->setVariable("HREF", str_replace('&', '&', ilUtil::secureUrl($i["href"])));
                        $tpl->setVariable("TXT_ENTRY", $i["content"]);
                        if ($i["target"] != "") {
                            $tpl->setVariable("TARGET", 'target="' . $i["target"] . '"');
                        } else {
                            $tpl->setVariable("TARGET", 'target="_top"');
                        }
                        if ($i["onclick"] != "") {
                            $tpl->setVariable("ONCLICK", 'onclick="' . $i["onclick"] . '"');
                        }
                        if ($i["id"] != "") {
                            $tpl->setVariable("ID", 'id="' . $i["id"] . '"');
                        }
                        $tpl->parseCurrentBlock();
                        $tpl->touchBlock("item");
                        if ($i["ttip"] != "" && $i["id"] != "") {
                            include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                            if ($ilCtrl->isAsynch()) {
                                $tt_calls .= " " . ilTooltipGUI::getTooltip(
                                    $i["id"],
                                    $i["ttip"],
                                    "",
                                    $i["tt_my"],
                                    $i["tt_at"],
                                    $i["tt_use_htmlspecialchars"]
                                );
                            } else {
                                ilTooltipGUI::addTooltip(
                                    $i["id"],
                                    $i["ttip"],
                                    "",
                                    $i["tt_my"],
                                    $i["tt_at"],
                                    $i["tt_use_htmlspecialchars"]
                                );
                            }
                        }
                    } else {
                        $tpl->setCurrentBlock("unlinked_entry");
                        if ($i["add_class"] != "") {
                            $tpl->setVariable("ADD_CLASS2", $i["add_class"]);
                        }
                        $tpl->setVariable("TXT_ENTRY2", $i["content"]);
                        $tpl->parseCurrentBlock();
                    }
                    break;
            }
        }
        
        if ($this->multi_column) {
            $tpl->touchBlock("multi_start");
            $tpl->touchBlock("multi_end");
        }
        
        if ($tt_calls != "") {
            $tpl->setCurrentBlock("script");
            $tpl->setVariable("TT_CALLS", $tt_calls);
            $tpl->parseCurrentBlock();
        }

        if ($this->id != "") {
            $tpl->setCurrentBlock("id");
            $tpl->setVariable("ID", $this->id);
            $tpl->parseCurrentBlock();
        }

        if ($this->getAsDropDown()) {
            if ($this->dd_pullright) {
                $tpl->setVariable("LIST_CLASS", "dropdown-menu pull-right");
            } else {
                $tpl->setVariable("LIST_CLASS", "dropdown-menu");
            }
            $tpl->setVariable("LIST_ROLE", 'role="menu"');
        } else {
            $tpl->setVariable("LIST_CLASS", "");
            $tpl->setVariable("LIST_ROLE", "");
        }
        
        return $tpl->get();
    }

Here is the call graph for this function:

nextColumn()

ilGroupedListGUI::nextColumn

(

)

Add separator.

Definition at line 80 of file class.ilGroupedListGUI.php.

    {
        $this->items[] = array("type" => "next_col");
        $this->multi_column = true;
    }

setAsDropDown()

ilGroupedListGUI::setAsDropDown	(		$a_val,
			$a_pullright = false
	)

Set as drop down.

Parameters

bool

$a_val

as drop down menu

Definition at line 41 of file class.ilGroupedListGUI.php.

    {
        $this->as_dropdown = $a_val;
        $this->dd_pullright = $a_pullright;
    }

Field Documentation

$as_dropdown

ilGroupedListGUI::$as_dropdown = false

protected

Definition at line 21 of file class.ilGroupedListGUI.php.

Referenced by getAsDropDown().

$ctrl

ilGroupedListGUI::$ctrl

protected

Definition at line 17 of file class.ilGroupedListGUI.php.

Referenced by getHTML().

$dd_pullright

ilGroupedListGUI::$dd_pullright = false

protected

Definition at line 22 of file class.ilGroupedListGUI.php.

$id

ilGroupedListGUI::$id

protected

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

Referenced by __construct().

$items

ilGroupedListGUI::$items = array()

protected

Definition at line 20 of file class.ilGroupedListGUI.php.

$multi_column

ilGroupedListGUI::$multi_column = false

protected

Definition at line 19 of file class.ilGroupedListGUI.php.

---

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

• Services/UIComponent/GroupedList/classes/class.ilGroupedListGUI.php