ilGroupedListGUI Class Reference

Grouped list GUI class. More...

Collaboration diagram for ilGroupedListGUI:

Public Member Functions
	__construct ()
	Constructor.
	addGroupHeader ($a_content)
	Add group header.
	addSeparator ()
	Add separator.
	nextColumn ()
	Add separator.
	addEntry ($a_content, $a_href="", $a_target="")
	Add entry.
	getHTML ()
	Get HTML.

Private Attributes
	$multi_column = false
	$items = array()

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

ilGroupedListGUI::__construct

(

)

Constructor.

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

        {
        }

Member Function Documentation

ilGroupedListGUI::addEntry	(		$a_content,
			$a_href = "",
			$a_target = ""
	)

Add entry.

Parameters

@return

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

        {
                $this->items[] = array("type" => "entry", "content" => $a_content,
                        "href" => $a_href, "target" => $a_target);
        }

ilGroupedListGUI::addGroupHeader

(

$a_content

)

Add group header.

Parameters

@return

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

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

ilGroupedListGUI::addSeparator

(

)

Add separator.

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

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

ilGroupedListGUI::getHTML

(

)

Get HTML.

Parameters

@return

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

References $tpl.

        {
                $tpl = new ilTemplate("tpl.grouped_list.html", true, true, "Services/UIComponent/GroupedList");
                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");
                                        $tpl->setVariable("GROUP_HEAD", $i["content"]);
                                        $tpl->parseCurrentBlock();
                                        $tpl->touchBlock("item");
                                        break;
                                        
                                case "entry":
                                        if ($i["href"] != "")
                                        {
                                                $tpl->setCurrentBlock("linked_entry");
                                                $tpl->setVariable("HREF", $i["href"]);
                                                $tpl->setVariable("TXT_ENTRY", $i["content"]);
                                                if ($i["target"] != "")
                                                {
                                                        $tpl->setVariable("TARGET", 'target="'.$i["target"].'"');
                                                }
                                                else
                                                {
                                                        $tpl->setVariable("TARGET", 'target="_top"');
                                                }
                                                $tpl->parseCurrentBlock();
                                                $tpl->touchBlock("item");
                                        }
                                        break;
                        }
                }
                
                if ($this->multi_column)
                {
                        $tpl->touchBlock("multi_start");
                        $tpl->touchBlock("multi_end");
                }
                
                return $tpl->get();
        }

ilGroupedListGUI::nextColumn

(

)

Add separator.

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

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

Field Documentation

ilGroupedListGUI::$items = array()

private

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

ilGroupedListGUI::$multi_column = false

private

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

---

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

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