User interface class for advanced drop-down selection lists. More...

Collaboration diagram for ilAdvancedSelectionListGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	setLinksMode ($a_link_class="")
	Set links mode (for no js fallback) More...

	setFormSelectMode ( $a_select_name, $a_select_class="", $a_include_form_tag=false, $a_form_action="", $a_form_id="", $a_form_class="", $a_form_target="_top", $a_button_text="", $a_button_class="", $a_button_cmd="")
	Set form mode (for no js fallback) More...

	addItem ( $a_title, $a_value="", $a_link="", $a_img="", $a_alt="", $a_frame="", $a_html="", $a_prevent_background_click=false, $a_onclick="", $a_ttip="", $a_tt_my="right center", $a_tt_at="left center", $a_tt_use_htmlspecialchars=true, $a_data=array())
	Add an item. More...

	setGroupedList ($a_val)
	Set Grouped List. More...

	getGroupedList ()
	Get Grouped List. More...

	flush ()

	getItems ()
	Get items. More...

	setListTitle ($a_listtitle)
	Set List Title. More...

	getListTitle ()
	Get List Title. More...

	setAriaListTitle ($a_listtitle)
	Set List Title. More...

	getAriaListTitle ()
	Get List Title. More...

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

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

	setStyle ($a_val)
	Set style. More...

	getStyle ()
	Get style. More...

	setSelectionHeaderSpanClass ($a_val)
	Set selection header span class. More...

	getSelectionHeaderSpanClass ()
	Get selection header span class. More...

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

	getHeaderIcon ()
	Get Header Icon. More...

	setNoJSLinkClass ($a_nojslinkclass)
	Set No Javascript Link Style Class. More...

	getNoJSLinkClass ()
	Get No Javascript Link Style Class. More...

	setItemLinkClass ($a_itemlinkclass)
	Set Item Link Class. More...

	getItemLinkClass ()
	Get Item Link Class. More...

	setId ($a_id)
	Set Id. More...

	getId ()
	Get Id. More...

	setUseImages ($a_useimages)
	Set Use Images. More...

	getUseImages ()
	Get Use Images. More...

	setAccessKey ($a_val)
	Set access key. More...

	getAccessKey ()
	Get access key. More...

	setTriggerEvent ($a_val)
	Set trigger event. More...

	getTriggerEvent ()
	Get trigger event. More...

	setAutoHide ($a_val)
	Set auto hide. More...

	getAutoHide ()
	Get auto hide. More...

	setOnClickMode ($a_val, $a_onclick_form_id="")
	Set "onClick"- Mode. More...

	getOnClickMode ()
	Get "onClick"-Mode. More...

	setSelectedValue ($a_val)
	Set selected value. More...

	getSelectedValue ()
	Get selected value. More...

	setAdditionalToggleElement ($a_el, $a_on)
	Set additional toggle element. More...

	getAdditionalToggleElement ()
	Get additional toggle element. More...

	setAsynch ($a_val)
	Set asynch mode (this is set to true, if list should get items asynchronously) More...

	getAsynch ()
	Get asynch mode. More...

	setAsynchUrl ($a_val)
	Set asynch url. More...

	getAsynchUrl ()
	Get asynch url. More...

	setSelectCallback ($a_val)
	Set select callback. More...

	getSelectCallback ()
	Get select callback. More...

	setPullRight ($a_val)
	Set pull right. More...

	getPullRight ()
	Get pull right. More...

	getHTML ($a_only_cmd_list_asynch=false)
	Get selection list HTML. More...

Data Fields
const	DOWN_ARROW_DARK = "down_arrow_dark"

const	ICON_ARROW = "caret"

const	ICON_CONFIG = "glyphicon glyphicon-cog"

const	NO_ICON = ""

const	MODE_LINKS = "links"

const	MODE_FORM_SELECT = "select"

const	ON_ITEM_CLICK_HREF = "href"

const	ON_ITEM_CLICK_FORM_SUBMIT = "submit"

const	ON_ITEM_CLICK_FORM_SELECT = "select"

const	ON_ITEM_CLICK_NOP = "nop"

const	STYLE_DEFAULT = 0

const	STYLE_LINK = 1

const	STYLE_EMPH = 2

const	STYLE_LINK_BUTTON = 3

Protected Attributes
	$css_row = ""

	$access_key = false

	$toggle = false

	$asynch_url = false

	$selected_value = ""

	$trigger_event = "click"

	$auto_hide = false

	$grouped_list = null

	$style = 0

	$listtitle

	$aria_listtitle

Private Attributes
	$items = array()

	$id = "asl"

	$asynch = false

	$dd_pullright = true

Detailed Description

User interface class for advanced drop-down selection lists.

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

Version: $Id:$

Definition at line 11 of file class.ilAdvancedSelectionListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedSelectionListGUI::__construct ( )

Constructor.

Definition at line 73 of file class.ilAdvancedSelectionListGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->mode = ilAdvancedSelectionListGUI::MODE_LINKS;
        $this->setHeaderIcon(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK);
        $this->setOnClickMode(ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF);
    }

References $DIC, DOWN_ARROW_DARK, MODE_LINKS, ON_ITEM_CLICK_HREF, setHeaderIcon(), and setOnClickMode().

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

ilAdvancedSelectionListGUI::addItem	(	$a_title,
		$a_value = `""`,
		$a_link = `""`,
		$a_img = `""`,
		$a_alt = `""`,
		$a_frame = `""`,
		$a_html = `""`,
		$a_prevent_background_click = `false`,
		$a_onclick = `""`,
		$a_ttip = `""`,
		$a_tt_my = `"right center"`,
		$a_tt_at = `"left center"`,
		$a_tt_use_htmlspecialchars = `true`,
		$a_data = `array()`
	)

Add an item.

Parameters

string	item title
string	value (used for select input)
link	href for the item
string	image href attribute
string	image alt attribute
string	frame target
string	item html (is used instead of title if js is active)

Definition at line 136 of file class.ilAdvancedSelectionListGUI.php.

      {
        $this->items[] = array("title" => $a_title, "value" => $a_value,
            "link" => $a_link, "img" => $a_img, "alt" => $a_alt, "frame" => $a_frame,
            "html" => $a_html, "prevent_background_click" => $a_prevent_background_click,
            "onclick" => $a_onclick, "ttip" => $a_ttip, "tt_my" => $a_tt_my, "tt_at" => $a_tt_at,
            "tt_use_htmlspecialchars" => $a_tt_use_htmlspecialchars, "data" => $a_data);
    }

Referenced by ilSystemStylesTableGUI\addManagementActionsToList().

Here is the caller graph for this function:

◆ flush()

ilAdvancedSelectionListGUI::flush ( )

Definition at line 179 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->items = array();
    }

◆ getAccessKey()

ilAdvancedSelectionListGUI::getAccessKey ( )

Get access key.

Returns: integer access key function id

Definition at line 413 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->access_key;
    }

References $access_key.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAdditionalToggleElement()

ilAdvancedSelectionListGUI::getAdditionalToggleElement ( )

Get additional toggle element.

Returns: array

Definition at line 512 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->toggle;
    }

References $toggle.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAriaListTitle()

ilAdvancedSelectionListGUI::getAriaListTitle ( )

Get List Title.

Returns: string List Title

Definition at line 229 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->aria_listtitle;
    }

References $aria_listtitle.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAsynch()

ilAdvancedSelectionListGUI::getAsynch ( )

Get asynch mode.

Returns: boolean turn asynch mode on/off

Definition at line 536 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->asynch;
    }

References $asynch.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAsynchUrl()

ilAdvancedSelectionListGUI::getAsynchUrl ( )

Get asynch url.

Returns: string asynch url

Definition at line 556 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->asynch_url;
    }

References $asynch_url.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAutoHide()

ilAdvancedSelectionListGUI::getAutoHide ( )

Get auto hide.

Definition at line 445 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->auto_hide;
    }

References $auto_hide.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getGroupedList()

ilAdvancedSelectionListGUI::getGroupedList ( )

Get Grouped List.

Returns: ilGroupedListGUI grouped list object

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

    {
        return $this->grouped_list;
    }

References $grouped_list.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHeaderIcon()

ilAdvancedSelectionListGUI::getHeaderIcon ( )

Get Header Icon.

Returns: string Header Icon

Definition at line 313 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->headericon;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilAdvancedSelectionListGUI::getHTML ( $a_only_cmd_list_asynch = false )

Get selection list HTML.

Definition at line 600 of file class.ilAdvancedSelectionListGUI.php.

    {
        $items = $this->getItems();
 
        // do not show list, if no item is in list
        if (count($items) == 0 && !$this->getAsynch() && $this->getGroupedList() == null) {
            return "";
        }
 
        /* bootstrap made this obsolete ?!
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initOverlay();
        $GLOBALS["tpl"]->addJavascript("./Services/UIComponent/Overlay/js/ilOverlay.js");
        */
        $GLOBALS["tpl"]->addJavascript("./Services/UIComponent/AdvancedSelectionList/js/AdvancedSelectionList.js");
        
        $tpl = new ilTemplate(
            "tpl.adv_selection_list.html",
            true,
            true,
            "Services/UIComponent/AdvancedSelectionList",
            "DEFAULT",
            false,
            true
        );
            
        reset($items);
 
        $cnt = 0;
 
        if ($this->getAsynch()) {
            $tpl->setCurrentBlock("asynch_request");
            $tpl->setVariable("IMG_LOADER", ilUtil::getImagePath("loader.svg"));
            $tpl->parseCurrentBlock();
        } else {
            if ($this->getGroupedList() != null) {
                $tpl->setVariable("GROUPED_LIST_HTML", $this->getGroupedList()->getHTML());
            } else {
                foreach ($items as $item) {
                    if (isset($item["ref_id"])) {
                        $sel_arr[$item["ref_id"]] = (isset($item["title"]))
                            ? $item["title"]
                            : "";
                    }
                    $this->css_row = ($this->css_row != "tblrow1_mo")
                        ? "tblrow1_mo"
                        : "tblrow2_mo";
 
                    if ($this->getUseImages()) {
                        if ($item["img"]) {
                            $tpl->setCurrentBlock("image");
                            $tpl->setVariable("IMG_ITEM", $item["img"]);
                            $tpl->setVariable("ALT_ITEM", $item["alt"]);
                            $tpl->parseCurrentBlock();
                        } else {
                            $tpl->touchBlock("no_image");
                        }
                    }
 
                    if ($this->getOnClickMode() ==
                        ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF ||
                        $this->getItemLinkClass() != "") {
                        if ($item["frame"]) {
                            $tpl->setCurrentBlock("frame");
                            $tpl->setVariable("TARGET_ITEM", $item["frame"]);
                            $tpl->parseCurrentBlock();
                        }
 
                        if ($this->getItemLinkClass() != "") {
                            $tpl->setCurrentBlock("item_link_class");
                            $tpl->setVariable("ITEM_LINK_CLASS", $this->getItemLinkClass());
                            $tpl->parseCurrentBlock();
                        }
 
                        if (is_array($item["data"])) {
                            foreach ($item["data"] as $k => $v) {
                                $tpl->setCurrentBlock("f_data");
                                $tpl->setVariable("DATA_KEY", $k);
                                $tpl->setVariable("DATA_VAL", ilUtil::prepareFormOutput($v));
                                $tpl->parseCurrentBlock();
                            }
                        }
                        if ($item["value"] != "") {
                            $tpl->setCurrentBlock("item_id");
                            $tpl->setVariable("ID_ITEM", $this->getId() . "_" . $item["value"]);
                            $tpl->parseCurrentBlock();
                        }
 
                        $tpl->setCurrentBlock("href_s");
                        $tpl->setVariable("HREF_ITEM", 'href="' . $item["link"] . '"');
                        $tpl->parseCurrentBlock();
 
                        $tpl->touchBlock("href_e");
                    }
 
                    $tpl->setCurrentBlock("item");
                    if ($this->getOnClickMode() ==
                        ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF) {
                        if ($item["prevent_background_click"]) {
                            $tpl->setVariable("ONCLICK_ITEM", '');
                        } else {
                            if ($item["onclick"] == "") {
                                $tpl->setVariable(
                                    "ONCLICK_ITEM",
                                    'onclick="' . "return il.AdvancedSelectionList.openTarget('" . $item["link"] . "','" . $item["frame"] . "');" . '"'
                                );
                            } else {
                                $tpl->setVariable(
                                    "ONCLICK_ITEM",
                                    'onclick="' . "return " . $item["onclick"] . ";" . '"'
                                );
                            }
                        }
                    } elseif ($this->getOnClickMode() ==
                        ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SUBMIT) {
                        $tpl->setVariable(
                            "ONCLICK_ITEM",
                            'onclick="return il.AdvancedSelectionList.submitForm(\'' . $this->getId() . '\'' .
                                ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                                "'" . $this->on_click_form_id . "','" . $this->form_mode["button_cmd"] . "');\""
                        );
                    } elseif ($this->getOnClickMode() ==
                        ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SELECT) {
                        $tpl->setVariable(
                            "ONCLICK_ITEM",
                            'onclick="return il.AdvancedSelectionList.selectForm(\'' . $this->getId() . '\'' .
                                ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                                "'" . $item["title"] . "');\""
                        );
                    } elseif ($this->getOnClickMode() ==
                        ilAdvancedSelectionListGUI::ON_ITEM_CLICK_NOP) {
                        $tpl->setVariable(
                            "ONCLICK_ITEM",
                            'onclick="il.AdvancedSelectionList.clickNop(\'' . $this->getId() . '\'' .
                                ", '" . $this->form_mode["select_name"] . "','" . $item["value"] . "'," .
                                "'" . $item["title"] . "');\""
                        );
                    }
 
                    $tpl->setVariable("CSS_ROW", $this->css_row);
                    if ($item["html"] == "") {
                        $tpl->setVariable("TXT_ITEM", $item["title"]);
                    } else {
                        $tpl->setVariable("TXT_ITEM", $item["html"]);
                    }
 
                    $tpl->setVariable("ID_ITEM_TR", $this->getId() . "_" . $item["value"] . "_tr");
                    if ($item["ttip"] != "") {
                        include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                        ilTooltipGUI::addTooltip(
                            $this->getId() . "_" . $item["value"] . "_tr",
                            $item["ttip"],
                            "",
                            $item["tt_my"],
                            $item["tt_at"],
                            $item["tt_use_htmlspecialchars"]
                        );
                    }
 
                    $tpl->parseCurrentBlock();
 
                    // add item to js object
                    $tpl->setCurrentBlock("js_item");
                    $tpl->setVariable("IT_ID", $this->getId());
                    $tpl->setVariable("IT_HID_NAME", $this->form_mode["select_name"]);
                    $tpl->setVariable("IT_HID_VAL", $item["value"]);
                    $tpl->setVariable("IT_TITLE", str_replace("'", "\\'", $item["title"]));
                    $tpl->parseCurrentBlock();
                }
 
                // output hidden input, if click mode is form submission
                if ($this->getOnClickMode() == ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SUBMIT) {
                    $tpl->setCurrentBlock("hidden_input");
                    $tpl->setVariable("HID", $this->getId());
                    $tpl->parseCurrentBlock();
                }
 
                // output hidden input and initialize
                if ($this->getOnClickMode() == ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SELECT) {
                    $tpl->setCurrentBlock("hidden_input");
                    $tpl->setVariable("HID", $this->getId());
                    $tpl->parseCurrentBlock();
 
                    // init hidden input with selected value
                    $tpl->setCurrentBlock("init_hidden_input");
                    $tpl->setVariable("H2ID", $this->getId());
                    $tpl->setVariable("HID_NAME", $this->form_mode["select_name"]);
                    $tpl->setVariable("HID_VALUE", $this->getSelectedValue());
                    $tpl->parseCurrentBlock();
                }
            }
        }
        
        if ($a_only_cmd_list_asynch) {
            $tpl->touchBlock("cmd_table");
            return $tpl->get("cmd_table");
        }
 
        if ($this->getGroupedList() == null) {
            $tpl->setCurrentBlock("dd_content");
            if ($this->getPullRight()) {
                $tpl->setVariable("UL_CLASS", "dropdown-menu pull-right");
            } else {
                $tpl->setVariable("UL_CLASS", "dropdown-menu");
            }
            $tpl->setVariable("TABLE_ID", $this->getId());
            $tpl->parseCurrentBlock();
        }
 
        if ($this->getHeaderIcon() != ilAdvancedSelectionListGUI::NO_ICON) {
            $tpl->setCurrentBlock("top_img");
            switch ($this->getHeaderIcon()) {
                case ilAdvancedSelectionListGUI::ICON_CONFIG:
                    $tpl->setVariable("IMG_SPAN_STYLE", ilAdvancedSelectionListGUI::ICON_CONFIG);
                    break;
 
                case ilAdvancedSelectionListGUI::DOWN_ARROW_DARK:
                default:
                    $tpl->setVariable("IMG_SPAN_STYLE", ilAdvancedSelectionListGUI::ICON_ARROW);
                    break;
            }
            $tpl->parseCurrentBlock();
        }
        
        
        if ($this->getAsynch()) {
            $tpl->setCurrentBlock("asynch_bl");
            $tpl->setVariable("ASYNCH_URL", $this->getAsynchUrl());
            $tpl->setVariable("ASYNCH_ID", $this->getId());
            $tpl->setVariable("ASYNCH_TRIGGER_ID", $this->getId());
            $tpl->parseCurrentBlock();
        }
    
        // js section
        $tpl->setCurrentBlock("js_section");
        if ($this->getAccessKey() > 0) {
            include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
            $tpl->setVariable("ACCKEY", ilAccessKeyGUI::getAttribute($this->getAccessKey()));
        }
 
        $cfg["trigger_event"] = $this->getTriggerEvent();
        $cfg["auto_hide"] = $this->getAutoHide();
 
        if ($this->getSelectCallback() != "") {
            $cfg["select_callback"] = $this->getSelectCallback();
        }
        $cfg["anchor_id"] = "ilAdvSelListAnchorElement_" . $this->getId();
        $cfg["asynch"] = $this->getAsynch()
            ? true
            : false;
        $cfg["asynch_url"] = $this->getAsynchUrl();
        $toggle = $this->getAdditionalToggleElement();
        if (is_array($toggle)) {
            $cfg["toggle_el"] = $toggle["el"];
            $cfg["toggle_class_on"] = $toggle["class_on"];
        }
        //echo "<br>".htmlentities($this->getAsynchUrl());
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
        $tpl->setVariable("CFG", ilJsonUtil::encode($cfg));
         
        //echo htmlentities(ilJsonUtil::encode($cfg));
        
        $tpl->setVariable("TXT_SEL_TOP", $this->getListTitle());
        if ($this->getListTitle() == "" || $this->getAriaListTitle() != "") {
            $aria_title = ($this->getAriaListTitle() != "")
                ? $this->getAriaListTitle() != ""
                : $this->lng->txt("actions");
            $tpl->setVariable("TXT_ARIA_TOP", $aria_title);
        }
        $tpl->setVariable("ID", $this->getId());
        
        //$tpl->setVariable("CLASS_SEL_TOP", $this->getSelectionHeaderClass());
        switch ($this->getStyle()) {
            case self::STYLE_DEFAULT:
                $tpl->setVariable("BTN_CLASS", "btn btn-default");
                $tpl->setVariable("TAG", "button");
                break;
 
            case self::STYLE_EMPH:
                $tpl->setVariable("BTN_CLASS", "btn btn-primary");
                $tpl->setVariable("TAG", "button");
                break;
 
            case self::STYLE_LINK_BUTTON:
                $tpl->setVariable("BTN_CLASS", "btn btn-link");
                $tpl->setVariable("TAG", "button");
                break;
 
            case self::STYLE_LINK:
                $tpl->setVariable("BTN_CLASS", "");
                $tpl->setVariable("TAG", "a");
                break;
        }
 
 
        if ($this->getSelectionHeaderSpanClass() != "") {
            $tpl->setVariable(
                "CLASS_SEL_TOP_SPAN",
                $this->getSelectionHeaderSpanClass()
            );
        }
 
        // set the async url to an extra template variable
        // (needed for a mobile skin)
        // $tpl->setVariable("ASYNC_URL", $this->getAsynchUrl());
 
        $tpl->parseCurrentBlock();
 
        return $tpl->get();
    }

References $cfg, $GLOBALS, $items, $toggle, $tpl, ilTooltipGUI\addTooltip(), DOWN_ARROW_DARK, ilJsonUtil\encode(), getAccessKey(), getAdditionalToggleElement(), getAriaListTitle(), getAsynch(), getAsynchUrl(), ilAccessKeyGUI\getAttribute(), getAutoHide(), getGroupedList(), getHeaderIcon(), getHTML(), getId(), ilUtil\getImagePath(), getItemLinkClass(), getItems(), getListTitle(), getOnClickMode(), getPullRight(), getSelectCallback(), getSelectedValue(), getSelectionHeaderSpanClass(), getStyle(), getTriggerEvent(), getUseImages(), ICON_ARROW, ICON_CONFIG, NO_ICON, ON_ITEM_CLICK_FORM_SELECT, ON_ITEM_CLICK_FORM_SUBMIT, ON_ITEM_CLICK_HREF, ON_ITEM_CLICK_NOP, ilUtil\prepareFormOutput(), STYLE_DEFAULT, STYLE_EMPH, STYLE_LINK, and STYLE_LINK_BUTTON.

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilAdvancedSelectionListGUI::getId ( )

Get Id.

Returns: string Id

Definition at line 373 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->id;
    }

References $id.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getItemLinkClass()

ilAdvancedSelectionListGUI::getItemLinkClass ( )

Get Item Link Class.

Returns: string Item Link Class

Definition at line 353 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->itemlinkclass;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getItems()

ilAdvancedSelectionListGUI::getItems ( )

Get items.

Returns: array array of items

Definition at line 189 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->items;
    }

References $items.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getListTitle()

ilAdvancedSelectionListGUI::getListTitle ( )

Get List Title.

Returns: string List Title

Definition at line 209 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->listtitle;
    }

References $listtitle.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getNoJSLinkClass()

ilAdvancedSelectionListGUI::getNoJSLinkClass ( )

Get No Javascript Link Style Class.

Returns: string No Javascript Link Style Class

Definition at line 333 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->nojslinkclass;
    }

◆ getOnClickMode()

ilAdvancedSelectionListGUI::getOnClickMode ( )

Get "onClick"-Mode.

Returns

Definition at line 471 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->on_click;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getPullRight()

ilAdvancedSelectionListGUI::getPullRight ( )

Get pull right.

Returns: bool pull right

Definition at line 592 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->dd_pullright;
    }

References $dd_pullright.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getSelectCallback()

ilAdvancedSelectionListGUI::getSelectCallback ( )

Get select callback.

Definition at line 572 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->select_callback;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getSelectedValue()

ilAdvancedSelectionListGUI::getSelectedValue ( )

Get selected value.

Returns: string selected value

Definition at line 491 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->selected_value;
    }

References $selected_value.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getSelectionHeaderClass()

ilAdvancedSelectionListGUI::getSelectionHeaderClass ( )

Get Selection Header Class.

Returns: string Selection Header Class

Definition at line 251 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->selectionheaderclass;
    }

◆ getSelectionHeaderSpanClass()

ilAdvancedSelectionListGUI::getSelectionHeaderSpanClass ( )

Get selection header span class.

Returns: string header span class

Definition at line 293 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->sel_head_span_class;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ getStyle()

ilAdvancedSelectionListGUI::getStyle ( )

Get style.

Returns: int button style STYLE_DEFAULT, STYLE_LINK, STYLE_EMPH

Definition at line 271 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->style;
    }

References $style.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getTriggerEvent()

ilAdvancedSelectionListGUI::getTriggerEvent ( )

Get trigger event.

Definition at line 429 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->trigger_event;
    }

References $trigger_event.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getUseImages()

ilAdvancedSelectionListGUI::getUseImages ( )

Get Use Images.

Returns: boolean Use Images

Definition at line 393 of file class.ilAdvancedSelectionListGUI.php.

    {
        return $this->useimages;
    }

Referenced by getHTML().

Here is the caller graph for this function:

◆ setAccessKey()

ilAdvancedSelectionListGUI::setAccessKey ( $a_val )

Set access key.

Parameters

integer access function id

Definition at line 403 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->access_key = $a_val;
    }

◆ setAdditionalToggleElement()

ilAdvancedSelectionListGUI::setAdditionalToggleElement	(	$a_el,
		$a_on
	)

Set additional toggle element.

Parameters

string	element id
string	class for "on"

Definition at line 502 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->toggle = array("el" => $a_el, "class_on" => $a_on);
    }

◆ setAriaListTitle()

ilAdvancedSelectionListGUI::setAriaListTitle ( $a_listtitle )

Set List Title.

Parameters

string $a_listtitle List Title

Definition at line 219 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->aria_listtitle = $a_listtitle;
    }

◆ setAsynch()

ilAdvancedSelectionListGUI::setAsynch ( $a_val )

Set asynch mode (this is set to true, if list should get items asynchronously)

Parameters

boolean turn asynch mode on/off

Definition at line 522 of file class.ilAdvancedSelectionListGUI.php.

    {
        if ($a_val) {
            include_once("./Services/YUI/classes/class.ilYuiUtil.php");
            ilYuiUtil::initConnection();
        }
        $this->asynch = $a_val;
    }

References ilYuiUtil\initConnection().

Here is the call graph for this function:

◆ setAsynchUrl()

ilAdvancedSelectionListGUI::setAsynchUrl ( $a_val )

Set asynch url.

Parameters

string asynch url

Definition at line 546 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->asynch_url = $a_val;
    }

◆ setAutoHide()

ilAdvancedSelectionListGUI::setAutoHide ( $a_val )

Set auto hide.

Definition at line 437 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->auto_hide = $a_val;
    }

◆ setFormSelectMode()

ilAdvancedSelectionListGUI::setFormSelectMode	(	$a_select_name,
		$a_select_class = `""`,
		$a_include_form_tag = `false`,
		$a_form_action = `""`,
		$a_form_id = `""`,
		$a_form_class = `""`,
		$a_form_target = `"_top"`,
		$a_button_text = `""`,
		$a_button_class = `""`,
		$a_button_cmd = `""`
	)

Set form mode (for no js fallback)

Outputs form selection including sourrounding form

Definition at line 98 of file class.ilAdvancedSelectionListGUI.php.

      {
        $this->mode = ilAdvancedSelectionListGUI::MODE_FORM_SELECT;
        $this->form_mode = array(
            "select_name" => $a_select_name,
            "select_class" => $a_select_class,
            "include_form_tag" => $a_include_form_tag,
            "form_action" => $a_form_action,
            "form_id" => $a_form_id,
            "form_class" => $a_form_class,
            "form_target" => $a_form_target,
            "button_text" => $a_button_text,
            "button_class" => $a_button_class,
            "button_cmd" => $a_button_cmd
            );
    }

References MODE_FORM_SELECT.

◆ setGroupedList()

ilAdvancedSelectionListGUI::setGroupedList ( $a_val )

Set Grouped List.

Parameters

ilGroupedListGUI $a_val grouped list object

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

    {
        $this->grouped_list = $a_val;
    }

◆ setHeaderIcon()

ilAdvancedSelectionListGUI::setHeaderIcon ( $a_headericon )

Set Header Icon.

Parameters

string $a_headericon Header Icon

Definition at line 303 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->headericon = $a_headericon;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilAdvancedSelectionListGUI::setId ( $a_id )

Set Id.

Parameters

string $a_id Id

Definition at line 363 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->id = $a_id;
    }

◆ setItemLinkClass()

ilAdvancedSelectionListGUI::setItemLinkClass ( $a_itemlinkclass )

Set Item Link Class.

Parameters

string $a_itemlinkclass Item Link Class

Definition at line 343 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->itemlinkclass = $a_itemlinkclass;
    }

◆ setLinksMode()

ilAdvancedSelectionListGUI::setLinksMode ( $a_link_class = "" )

Set links mode (for no js fallback)

Definition at line 86 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->mode = ilAdvancedSelectionListGUI::MODE_LINKS;
        $this->links_mode = array(
            "link_class" => $a_link_class);
    }

References MODE_LINKS.

◆ setListTitle()

ilAdvancedSelectionListGUI::setListTitle ( $a_listtitle )

Set List Title.

Parameters

string $a_listtitle List Title

Definition at line 199 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->listtitle = $a_listtitle;
    }

◆ setNoJSLinkClass()

ilAdvancedSelectionListGUI::setNoJSLinkClass ( $a_nojslinkclass )

Set No Javascript Link Style Class.

Parameters

string $a_nojslinkclass No Javascript Link Style Class

Definition at line 323 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->nojslinkclass = $a_nojslinkclass;
    }

◆ setOnClickMode()

ilAdvancedSelectionListGUI::setOnClickMode	(	$a_val,
		$a_onclick_form_id = `""`
	)

Set "onClick"- Mode.

Valid values are: ilAdvancedSelectionList::ON_ITEM_CLICK_HREF or ilAdvancedSelectionList::ON_ITEM_CLICK_FORM_SUBMIT ilAdvancedSelectionList::ON_ITEM_CLICK_FORM_SELECT

Parameters

string mode

Definition at line 460 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->on_click = $a_val;
        $this->on_click_form_id = $a_onclick_form_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setPullRight()

ilAdvancedSelectionListGUI::setPullRight ( $a_val )

Set pull right.

Parameters

bool $a_val pull right

Definition at line 582 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->dd_pullright = $a_val;
    }

◆ setSelectCallback()

ilAdvancedSelectionListGUI::setSelectCallback ( $a_val )

Set select callback.

Definition at line 564 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->select_callback = $a_val;
    }

◆ setSelectedValue()

ilAdvancedSelectionListGUI::setSelectedValue ( $a_val )

Set selected value.

Parameters

string selected value

Definition at line 481 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->selected_value = $a_val;
    }

◆ setSelectionHeaderClass()

ilAdvancedSelectionListGUI::setSelectionHeaderClass ( $a_selectionheaderclass )

Set Selection Header Class.

DEPRECATED use set style instead

Parameters

string $a_selectionheaderclass Selection Header Class

Definition at line 241 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->selectionheaderclass = $a_selectionheaderclass;
    }

◆ setSelectionHeaderSpanClass()

ilAdvancedSelectionListGUI::setSelectionHeaderSpanClass ( $a_val )

Set selection header span class.

Parameters

string $a_val header span class

Definition at line 283 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->sel_head_span_class = $a_val;
    }

◆ setStyle()

ilAdvancedSelectionListGUI::setStyle ( $a_val )

Set style.

Parameters

int $a_val button style STYLE_DEFAULT, STYLE_LINK, STYLE_EMPH

Definition at line 261 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->style = $a_val;
    }

◆ setTriggerEvent()

ilAdvancedSelectionListGUI::setTriggerEvent ( $a_val )

Set trigger event.

Definition at line 421 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->trigger_event = $a_val;
    }

◆ setUseImages()

ilAdvancedSelectionListGUI::setUseImages ( $a_useimages )

Set Use Images.

Parameters

boolean $a_useimages Use Images

Definition at line 383 of file class.ilAdvancedSelectionListGUI.php.

    {
        $this->useimages = $a_useimages;
    }

Field Documentation

◆ $access_key

ilAdvancedSelectionListGUI::$access_key = false

protected

Definition at line 36 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getAccessKey().

◆ $aria_listtitle

ilAdvancedSelectionListGUI::$aria_listtitle

protected

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

Referenced by getAriaListTitle().

◆ $asynch

ilAdvancedSelectionListGUI::$asynch = false

private

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

Referenced by getAsynch().

◆ $asynch_url

ilAdvancedSelectionListGUI::$asynch_url = false

protected

Definition at line 38 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getAsynchUrl().

◆ $auto_hide

ilAdvancedSelectionListGUI::$auto_hide = false

protected

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

Referenced by getAutoHide().

◆ $css_row

ilAdvancedSelectionListGUI::$css_row = ""

protected

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

◆ $dd_pullright

ilAdvancedSelectionListGUI::$dd_pullright = true

private

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

Referenced by getPullRight().

◆ $grouped_list

ilAdvancedSelectionListGUI::$grouped_list = null

protected

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

Referenced by getGroupedList().

◆ $id

ilAdvancedSelectionListGUI::$id = "asl"

private

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

Referenced by getId().

◆ $items

ilAdvancedSelectionListGUI::$items = array()

private

Definition at line 13 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML(), and getItems().

◆ $listtitle

ilAdvancedSelectionListGUI::$listtitle

protected

Definition at line 46 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getListTitle().

◆ $selected_value

ilAdvancedSelectionListGUI::$selected_value = ""

protected

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

Referenced by getSelectedValue().

◆ $style

ilAdvancedSelectionListGUI::$style = 0

protected

Definition at line 43 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getStyle().

◆ $toggle

ilAdvancedSelectionListGUI::$toggle = false

protected

Definition at line 37 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getAdditionalToggleElement(), and getHTML().

◆ $trigger_event

ilAdvancedSelectionListGUI::$trigger_event = "click"

protected

Definition at line 40 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getTriggerEvent().

◆ DOWN_ARROW_DARK

const ilAdvancedSelectionListGUI::DOWN_ARROW_DARK = "down_arrow_dark"

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

Referenced by __construct(), ilPCParagraphGUI\getCharStyleSelector(), getHTML(), ilPCParagraphGUI\getStyleSelector(), ilAdvSelectInputGUI\insert(), ilObjectListGUI\insertCommands(), ilCalendarPresentationGUI\prepareOutput(), and ilNewsTimelineItemGUI\render().

◆ ICON_ARROW

const ilAdvancedSelectionListGUI::ICON_ARROW = "caret"

Definition at line 18 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML().

◆ ICON_CONFIG

const ilAdvancedSelectionListGUI::ICON_CONFIG = "glyphicon glyphicon-cog"

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

Referenced by ilBlockGUI\fillHeaderCommands(), and getHTML().

◆ MODE_FORM_SELECT

const ilAdvancedSelectionListGUI::MODE_FORM_SELECT = "select"

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

Referenced by setFormSelectMode().

◆ MODE_LINKS

const ilAdvancedSelectionListGUI::MODE_LINKS = "links"

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

Referenced by __construct(), and setLinksMode().

◆ NO_ICON

const ilAdvancedSelectionListGUI::NO_ICON = ""

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

Referenced by getHTML(), and ilNavigationHistoryGUI\getHTML().

◆ ON_ITEM_CLICK_FORM_SELECT

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SELECT = "select"

Definition at line 27 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML(), ilPCParagraphGUI\getStyleSelector(), and ilAdvSelectInputGUI\insert().

◆ ON_ITEM_CLICK_FORM_SUBMIT

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SUBMIT = "submit"

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

Referenced by getHTML().

◆ ON_ITEM_CLICK_HREF

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF = "href"

Definition at line 25 of file class.ilAdvancedSelectionListGUI.php.

Referenced by __construct(), and getHTML().

◆ ON_ITEM_CLICK_NOP

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_NOP = "nop"

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

Referenced by ilPCParagraphGUI\getCharStyleSelector(), and getHTML().

◆ STYLE_DEFAULT

const ilAdvancedSelectionListGUI::STYLE_DEFAULT = 0

Definition at line 30 of file class.ilAdvancedSelectionListGUI.php.

Referenced by getHTML().

◆ STYLE_EMPH

const ilAdvancedSelectionListGUI::STYLE_EMPH = 2

Definition at line 32 of file class.ilAdvancedSelectionListGUI.php.

Referenced by ilCloudPluginInitGUI\addToolbar(), getHTML(), and ilObjectAddNewItemGUI\render().

◆ STYLE_LINK

const ilAdvancedSelectionListGUI::STYLE_LINK = 1

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

Referenced by ilWikiFunctionsBlockGUI\fillDataSection(), and getHTML().

◆ STYLE_LINK_BUTTON

const ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON = 3

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

Referenced by ilTable2GUI\fillFooter(), ilBlockGUI\fillHeaderCommands(), and getHTML().

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

Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php

Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItem()

◆ flush()

◆ getAccessKey()

◆ getAdditionalToggleElement()

◆ getAriaListTitle()

◆ getAsynch()

◆ getAsynchUrl()

◆ getAutoHide()

◆ getGroupedList()

◆ getHeaderIcon()

◆ getHTML()

◆ getId()

◆ getItemLinkClass()

◆ getItems()

◆ getListTitle()

◆ getNoJSLinkClass()

◆ getOnClickMode()

◆ getPullRight()

◆ getSelectCallback()

◆ getSelectedValue()

◆ getSelectionHeaderClass()

◆ getSelectionHeaderSpanClass()

◆ getStyle()

◆ getTriggerEvent()

◆ getUseImages()

◆ setAccessKey()

◆ setAdditionalToggleElement()

◆ setAriaListTitle()

◆ setAsynch()

◆ setAsynchUrl()

◆ setAutoHide()

◆ setFormSelectMode()

◆ setGroupedList()

◆ setHeaderIcon()

◆ setId()

◆ setItemLinkClass()

◆ setLinksMode()

◆ setListTitle()

◆ setNoJSLinkClass()

◆ setOnClickMode()

◆ setPullRight()

◆ setSelectCallback()

◆ setSelectedValue()

◆ setSelectionHeaderClass()

◆ setSelectionHeaderSpanClass()

◆ setStyle()

◆ setTriggerEvent()

◆ setUseImages()

Field Documentation

◆ $access_key

◆ $aria_listtitle

◆ $asynch

◆ $asynch_url

◆ $auto_hide

◆ $css_row

◆ $dd_pullright

◆ $grouped_list

◆ $id

◆ $items

◆ $listtitle

◆ $selected_value

◆ $style

◆ $toggle

◆ $trigger_event

◆ DOWN_ARROW_DARK

◆ ICON_ARROW

◆ ICON_CONFIG

◆ MODE_FORM_SELECT

◆ MODE_LINKS

◆ NO_ICON

◆ ON_ITEM_CLICK_FORM_SELECT

◆ ON_ITEM_CLICK_FORM_SUBMIT