ilAdvancedSelectionListGUI Class Reference

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

Collaboration diagram for ilAdvancedSelectionListGUI:

Public Member Functions
	__construct ()
	Constructor.
	setLinksMode ($a_link_class="")
	Set links mode (for no js fallback)
	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)
	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)
	Add an item.
	flush ()
	getItems ()
	Get items.
	setListTitle ($a_listtitle)
	Set List Title.
	getListTitle ()
	Get List Title.
	setSelectionHeaderClass ($a_selectionheaderclass)
	Set Selection Header Class.
	getSelectionHeaderClass ()
	Get Selection Header Class.
	setSelectionHeaderSpanClass ($a_val)
	Set selection header span class.
	getSelectionHeaderSpanClass ()
	Get selection header span class.
	setHeaderIcon ($a_headericon)
	Set Header Icon.
	getHeaderIcon ()
	Get Header Icon.
	setNoJSLinkClass ($a_nojslinkclass)
	Set No Javascript Link Style Class.
	getNoJSLinkClass ()
	Get No Javascript Link Style Class.
	setItemLinkClass ($a_itemlinkclass)
	Set Item Link Class.
	getItemLinkClass ()
	Get Item Link Class.
	setId ($a_id)
	Set Id.
	getId ()
	Get Id.
	setUseImages ($a_useimages)
	Set Use Images.
	getUseImages ()
	Get Use Images.
	setAccessKey ($a_val)
	Set access key.
	getAccessKey ()
	Get access key.
	setTriggerEvent ($a_val)
	Set trigger event.
	getTriggerEvent ()
	Get trigger event.
	setAutoHide ($a_val)
	Set auto hide.
	getAutoHide ()
	Get auto hide.
	setOnClickMode ($a_val, $a_onclick_form_id="")
	Set "onClick"- Mode.
	getOnClickMode ()
	Get "onClick"-Mode.
	setSelectedValue ($a_val)
	Set selected value.
	getSelectedValue ()
	Get selected value.
	setAdditionalToggleElement ($a_el, $a_on)
	Set additional toggle element.
	getAdditionalToggleElement ()
	Get additional toggle element.
	setAsynch ($a_val)
	Set asynch mode (this is set to true, if list should get items asynchronously)
	getAsynch ()
	Get asynch mode.
	setAsynchUrl ($a_val)
	Set asynch url.
	getAsynchUrl ()
	Get asynch url.
	setSelectCallback ($a_val)
	Set select callback.
	getSelectCallback ()
	Get select callback.
	getHTML ($a_only_cmd_list_asynch=false)
	Get selection list HTML.

Data Fields
const	DOWN_ARROW_LIGHT = "mm_down_arrow.png"
const	DOWN_ARROW_DARK = "mm_down_arrow_dark.png"
const	DOWN_ARROW_TOPBAR = "mm_down_arrow_topbar.png"
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"

Protected Attributes
	$css_row = ""
	$access_key = false
	$toggle = false
	$asynch_url = false
	$selected_value = ""
	$trigger_event = "click"
	$auto_hide = false

Private Attributes
	$items = array()
	$id = "asl"
	$asynch = false

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

ilAdvancedSelectionListGUI::__construct

(

)

Constructor.

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

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

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

Here is the call graph for this function:

Member Function Documentation

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
	)

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 115 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);
        }

ilAdvancedSelectionListGUI::flush

(

)

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

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

ilAdvancedSelectionListGUI::getAccessKey

(

)

Get access key.

Returns

integer access key function id

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

References $access_key.

Referenced by getHTML().

        {
                return $this->access_key;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getAdditionalToggleElement

(

)

Get additional toggle element.

Returns

array

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

References $toggle.

Referenced by getHTML().

        {
                return $this->toggle;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getAsynch

(

)

Get asynch mode.

Returns

boolean turn asynch mode on/off

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

References $asynch.

Referenced by getHTML().

        {
                return $this->asynch;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getAsynchUrl

(

)

Get asynch url.

Returns

string asynch url

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

References $asynch_url.

Referenced by getHTML().

        {
                return $this->asynch_url;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getAutoHide

(

)

Get auto hide.

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

References $auto_hide.

Referenced by getHTML().

        {
                return $this->auto_hide;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getHeaderIcon

(

)

Get Header Icon.

Returns

string Header Icon

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

Referenced by getHTML().

        {
                return $this->headericon;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getHTML

(

$a_only_cmd_list_asynch = false

)

Get selection list HTML.

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

References $GLOBALS, $items, $toggle, $tpl, ilTooltipGUI\addTooltip(), DOWN_ARROW_DARK, DOWN_ARROW_LIGHT, DOWN_ARROW_TOPBAR, ilJsonUtil\encode(), getAccessKey(), getAdditionalToggleElement(), getAsynch(), getAsynchUrl(), ilAccessKeyGUI\getAttribute(), getAutoHide(), getHeaderIcon(), getId(), ilUtil\getImagePath(), getItemLinkClass(), getItems(), getListTitle(), getOnClickMode(), getSelectCallback(), getSelectedValue(), getSelectionHeaderClass(), getSelectionHeaderSpanClass(), getTriggerEvent(), getUseImages(), ilYuiUtil\initOverlay(), MODE_FORM_SELECT, MODE_LINKS, NO_ICON, ON_ITEM_CLICK_FORM_SELECT, ON_ITEM_CLICK_FORM_SUBMIT, ON_ITEM_CLICK_HREF, and ON_ITEM_CLICK_NOP.

        {
                $items = $this->getItems();

                // do not show list, if no item is in list
                if (count($items) == 0 && !$this->getAsynch())
                {
                        return "";
                }

                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.gif"));
                        $tpl->parseCurrentBlock();
                }
                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();
                                        }

                                        $tpl->setCurrentBlock("href_s");
                                        $tpl->setVariable("HREF_ITEM",'href="'.$item["link"].'"');
                                        $tpl->setVariable("ID_ITEM", $this->getId()."_".$item["value"]);
                                        $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"].";".'"');
                                                }
                                        }

                                }
                                else if ($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"]."');\"");
                                }
                                else if ($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"]."');\"");
                                }
                                else if ($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();
                        }
                }

                $tpl->setCurrentBlock("cmd_table");
                $tpl->parseCurrentBlock();
                
                if ($a_only_cmd_list_asynch)
                {
                        return $tpl->get("cmd_table");
                }

                if ($this->getHeaderIcon() != ilAdvancedSelectionListGUI::NO_ICON)
                {
                        $tpl->setCurrentBlock("top_img");
                        switch ($this->getHeaderIcon())
                        {
                                case ilAdvancedSelectionListGUI::DOWN_ARROW_LIGHT:
                                        $tpl->setVariable("IMG_DOWN",
                                                ilUtil::getImagePath(ilAdvancedSelectionListGUI::DOWN_ARROW_LIGHT));
                                        break;
                                case ilAdvancedSelectionListGUI::DOWN_ARROW_DARK:
                                        $tpl->setVariable("IMG_DOWN",
                                                ilUtil::getImagePath(ilAdvancedSelectionListGUI::DOWN_ARROW_DARK));
                                        break;
                                case ilAdvancedSelectionListGUI::DOWN_ARROW_TOPBAR:
                                        $tpl->setVariable("IMG_DOWN",
                                                ilUtil::getImagePath(ilAdvancedSelectionListGUI::DOWN_ARROW_TOPBAR));
                                        break;
                                default:
                                        $tpl->setVariable("IMG_DOWN", $this->getHeaderIcon());
                                        break;
                        }
                        // do not repeat title (accessibility) -> empty alt
                        //$tpl->setVariable("ALT_SEL_TOP", $this->getListTitle());
                        $tpl->setVariable("ALT_SEL_TOP", "");
                        $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();
                }
                
                // 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("TXT_SEL_TOP", $this->getListTitle());
                $tpl->setVariable("ID", $this->getId());
                $tpl->setVariable("CFG", ilJsonUtil::encode($cfg));
//echo htmlentities(ilJsonUtil::encode($cfg));
                $tpl->setVariable("CLASS_SEL_TOP", $this->getSelectionHeaderClass());
                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();
                
                // no js sections
if (false)
{
                switch ($this->mode)
                {
                        // links mode
                        case ilAdvancedSelectionListGUI::MODE_LINKS:
                                reset($items);
                                $cnt = 0;
                                foreach($items as $item)
                                {
                                        $tpl->setCurrentBlock("no_js_link");
                                        $tpl->setVariable("LINKS_CLASS", $this->links_mode["link_class"]);
                                        $tpl->setVariable("LINKS_HREF", $item["link"]);
                                        $tpl->setVariable("LINKS_TXT", $item["title"]);
                                        $tpl->parseCurrentBlock();
                                        $tpl->setCurrentBlock("no_js_section");
                                        $tpl->parseCurrentBlock();
                                }
                                break;
                                
                        case ilAdvancedSelectionListGUI::MODE_FORM_SELECT:
                                reset($items);
                                $cnt = 0;
                                foreach($items as $item)
                                {
                                        $tpl->setCurrentBlock("no_js_form_option");
                                        $tpl->setVariable("FRM_OPTION_TXT", $item["title"]);
                                        $tpl->setVariable("FRM_OPTION_VAL", $item["value"]);
                                        if ($this->getSelectedValue() == $item["value"])
                                        {
                                                $tpl->setVariable("SELECTED", ' selected="selected" ');
                                        }
                                        $tpl->parseCurrentBlock();
                                }
                                if ($this->form_mode["include_form_tag"])
                                {
                                        $tpl->setCurrentBlock("no_js_form_begin");
                                        $tpl->setVariable("FRM_ID", $this->form_mode["form_id"]);
                                        $tpl->setVariable("FRM_CLASS", $this->form_mode["form_class"]);
                                        $tpl->setVariable("FRM_ACTION", $this->form_mode["form_action"]);
                                        $tpl->setVariable("FRM_TARGET", $this->form_mode["form_target"]);
                                        $tpl->parseCurrentBlock();
                                        $tpl->touchBlock("no_js_form_end");
                                }
                                if ($this->form_mode["button_text"])
                                {
                                        $tpl->setCurrentBlock("no_js_form_button");
                                        $tpl->setVariable("FRM_BT_TXT", $this->form_mode["button_text"]);
                                        $tpl->setVariable("FRM_BT_CLASS", $this->form_mode["button_class"]);
                                        if ($this->form_mode["button_cmd"] != "")
                                        {
                                                $tpl->setVariable("FRM_BT_CMD", 'name="cmd['.$this->form_mode["button_cmd"].']"');
                                        }
                                        $tpl->parseCurrentBlock();
                                }
                                $tpl->setVariable("FRM_SELECT_NAME", $this->form_mode["select_name"]);
                                $tpl->setVariable("FRM_SELECT_CLASS", $this->form_mode["select_class"]);
                                
                                if ($this->getAccessKey() > 0)
                                {
                                        include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
                                        $tpl->setVariable("ACCKEYNJS", ilAccessKeyGUI::getAttribute($this->getAccessKey()));
                                }
                                
                                $tpl->setCurrentBlock("no_js_section");
                                $tpl->parseCurrentBlock();
                                break;
                }
}

                return $tpl->get();
        }

Here is the call graph for this function:

ilAdvancedSelectionListGUI::getId

(

)

Get Id.

Returns

string Id

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

References $id.

Referenced by getHTML().

        {
                return $this->id;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getItemLinkClass

(

)

Get Item Link Class.

Returns

string Item Link Class

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

Referenced by getHTML().

        {
                return $this->itemlinkclass;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getItems

(

)

Get items.

Returns

array array of items

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

References $items.

Referenced by getHTML().

        {
                return $this->items;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getListTitle

(

)

Get List Title.

Returns

string List Title

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

Referenced by getHTML().

        {
                return $this->listtitle;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getNoJSLinkClass

(

)

Get No Javascript Link Style Class.

Returns

string No Javascript Link Style Class

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

        {
                return $this->nojslinkclass;
        }

ilAdvancedSelectionListGUI::getOnClickMode

(

)

Get "onClick"-Mode.

Returns

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

Referenced by getHTML().

        {
                return $this->on_click;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getSelectCallback

(

)

Get select callback.

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

Referenced by getHTML().

        {
                return $this->select_callback;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getSelectedValue

(

)

Get selected value.

Returns

string selected value

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

References $selected_value.

Referenced by getHTML().

        {
                return $this->selected_value;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getSelectionHeaderClass

(

)

Get Selection Header Class.

Returns

string Selection Header Class

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

Referenced by getHTML().

        {
                return $this->selectionheaderclass;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getSelectionHeaderSpanClass

(

)

Get selection header span class.

Returns

string header span class

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

Referenced by getHTML().

        {
                return $this->sel_head_span_class;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getTriggerEvent

(

)

Get trigger event.

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

References $trigger_event.

Referenced by getHTML().

        {
                return $this->trigger_event;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::getUseImages

(

)

Get Use Images.

Returns

boolean Use Images

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

Referenced by getHTML().

        {
                return $this->useimages;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::setAccessKey

(

$a_val

)

Set access key.

Parameters

integer

access function id

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

        {
                $this->access_key = $a_val;
        }

ilAdvancedSelectionListGUI::setAdditionalToggleElement	(		$a_el,
			$a_on
	)

Set additional toggle element.

Parameters

string	element id
string	class for "on"

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

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

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 425 of file class.ilAdvancedSelectionListGUI.php.

References ilYuiUtil\initConnection().

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

Here is the call graph for this function:

ilAdvancedSelectionListGUI::setAsynchUrl

(

$a_val

)

Set asynch url.

Parameters

string

asynch url

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

        {
                $this->asynch_url = $a_val;
        }

ilAdvancedSelectionListGUI::setAutoHide

(

$a_val

)

Set auto hide.

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

        {
                $this->auto_hide = $a_val;
        }

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 84 of file class.ilAdvancedSelectionListGUI.php.

References MODE_FORM_SELECT.

        {
                $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
                        );
        }

ilAdvancedSelectionListGUI::setHeaderIcon

(

$a_headericon

)

Set Header Icon.

Parameters

string

$a_headericon

Header Icon

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

Referenced by __construct().

        {
                $this->headericon = $a_headericon;
        }

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::setId

(

$a_id

)

Set Id.

Parameters

string

$a_id

Id

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

        {
                $this->id = $a_id;
        }

ilAdvancedSelectionListGUI::setItemLinkClass

(

$a_itemlinkclass

)

Set Item Link Class.

Parameters

string

$a_itemlinkclass

Item Link Class

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

        {
                $this->itemlinkclass = $a_itemlinkclass;
        }

ilAdvancedSelectionListGUI::setLinksMode

(

$a_link_class = ""

)

Set links mode (for no js fallback)

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

References MODE_LINKS.

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

ilAdvancedSelectionListGUI::setListTitle

(

$a_listtitle

)

Set List Title.

Parameters

string

$a_listtitle

List Title

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

        {
                $this->listtitle = $a_listtitle;
        }

ilAdvancedSelectionListGUI::setNoJSLinkClass

(

$a_nojslinkclass

)

Set No Javascript Link Style Class.

Parameters

string

$a_nojslinkclass

No Javascript Link Style Class

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

        {
                $this->nojslinkclass = $a_nojslinkclass;
        }

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 363 of file class.ilAdvancedSelectionListGUI.php.

Referenced by __construct().

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

Here is the caller graph for this function:

ilAdvancedSelectionListGUI::setSelectCallback

(

$a_val

)

Set select callback.

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

        {
                $this->select_callback = $a_val;
        }

ilAdvancedSelectionListGUI::setSelectedValue

(

$a_val

)

Set selected value.

Parameters

string

selected value

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

        {
                $this->selected_value = $a_val;
        }

ilAdvancedSelectionListGUI::setSelectionHeaderClass

(

$a_selectionheaderclass

)

Set Selection Header Class.

Parameters

string

$a_selectionheaderclass

Selection Header Class

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

        {
                $this->selectionheaderclass = $a_selectionheaderclass;
        }

ilAdvancedSelectionListGUI::setSelectionHeaderSpanClass

(

$a_val

)

Set selection header span class.

Parameters

string

$a_val

header span class

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

        {
                $this->sel_head_span_class = $a_val;
        }

ilAdvancedSelectionListGUI::setTriggerEvent

(

$a_val

)

Set trigger event.

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

        {
                $this->trigger_event = $a_val;
        }

ilAdvancedSelectionListGUI::setUseImages

(

$a_useimages

)

Set Use Images.

Parameters

boolean

$a_useimages

Use Images

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

        {
                $this->useimages = $a_useimages;
        }

Field Documentation

ilAdvancedSelectionListGUI::$access_key = false

protected

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

Referenced by getAccessKey().

ilAdvancedSelectionListGUI::$asynch = false

private

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

Referenced by getAsynch().

ilAdvancedSelectionListGUI::$asynch_url = false

protected

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

Referenced by getAsynchUrl().

ilAdvancedSelectionListGUI::$auto_hide = false

protected

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

Referenced by getAutoHide().

ilAdvancedSelectionListGUI::$css_row = ""

protected

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

ilAdvancedSelectionListGUI::$id = "asl"

private

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

Referenced by getId().

ilAdvancedSelectionListGUI::$items = array()

private

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

Referenced by getHTML(), and getItems().

ilAdvancedSelectionListGUI::$selected_value = ""

protected

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

Referenced by getSelectedValue().

ilAdvancedSelectionListGUI::$toggle = false

protected

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

Referenced by getAdditionalToggleElement(), and getHTML().

ilAdvancedSelectionListGUI::$trigger_event = "click"

protected

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

Referenced by getTriggerEvent().

const ilAdvancedSelectionListGUI::DOWN_ARROW_DARK = "mm_down_arrow_dark.png"

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

Referenced by __construct(), ilPCParagraphGUI\getCharStyleSelector(), getHTML(), ilPersonalSkillsGUI\getSkillHTML(), ilPCParagraphGUI\getStyleSelector(), ilAdvSelectInputGUI\insert(), and ilObjectListGUI\insertCommands().

const ilAdvancedSelectionListGUI::DOWN_ARROW_LIGHT = "mm_down_arrow.png"

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

Referenced by getHTML(), and ilMainMenuGUI\renderDropDown().

const ilAdvancedSelectionListGUI::DOWN_ARROW_TOPBAR = "mm_down_arrow_topbar.png"

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

Referenced by getHTML(), and ilMainMenuGUI\getLanguageSelection().

const ilAdvancedSelectionListGUI::MODE_FORM_SELECT = "select"

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

Referenced by getHTML(), and setFormSelectMode().

const ilAdvancedSelectionListGUI::MODE_LINKS = "links"

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

Referenced by __construct(), getHTML(), and setLinksMode().

const ilAdvancedSelectionListGUI::NO_ICON = ""

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

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

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().

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_FORM_SUBMIT = "submit"

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

Referenced by getHTML().

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_HREF = "href"

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

Referenced by __construct(), and getHTML().

const ilAdvancedSelectionListGUI::ON_ITEM_CLICK_NOP = "nop"

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

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

---

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

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