This is a utility class for the yui overlays. More...

Inheritance diagram for ilOverlayGUI:

Collaboration diagram for ilOverlayGUI:

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

	setAnchor ($a_anchor_el_id, $a_ov_corner="tl", $a_anch_corner="bl")
	Set anchor element. More...

	setSize ($a_width="", $a_height="")
	Set size. More...

	setFixedCenter ($a_fixed_center=true)
	Set fixed center. More...

	setVisible ($a_visible=true)
	Set visible. More...

	setTrigger ($a_el_id, $a_event="click", $a_trigger_anchor_el_id=null)
	Set trigger element. More...

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

	getAutoHide ()
	Get auto_hide. More...

	setCloseElementId ($a_val)
	Set close element id. More...

	getCloseElementId ()
	Get close element id. More...

	getOnLoadCode ()
	Makes an existing HTML element an overlay. More...

	add ()
	Makes an existing HTML element an overlay. More...

	getTriggerOnLoadCode ( $a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center=false, $a_ov_corner="tl", $a_anch_corner="bl")
	Get trigger onload code. More...

	addTrigger ( $a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center=false, $a_ov_corner="tl", $a_anch_corner="bl")
	Add trigger. More...

Static Public Member Functions
static	initJavascript ()
	Init javascript. More...

Protected Attributes
	$tpl

	$width = ""

	$height = ""

	$fixed_center = false

	$visible = false

	$anchor_el_id = ""

	$anchor_ov_corner = ""

	$anchor_anch_corner = ""

	$auto_hide = false

	$close_el = null

Detailed Description

This is a utility class for the yui overlays.

this only works, if a parent has class="yui-skin-sam" attached.

Definition at line 8 of file class.ilOverlayGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilOverlayGUI::__construct ( $a_overlay_el_id )

Constructor.

Parameters

return

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

    {
        global $DIC;
 
        // please check learning modules (e.g. rating) before removing this globals
        // use (they do not use standard template)
        $this->tpl = $GLOBALS["tpl"];
        $this->overlay_el_id = $a_overlay_el_id;
    }

References $DIC, and $GLOBALS.

Member Function Documentation

◆ add()

ilOverlayGUI::add ( )

Makes an existing HTML element an overlay.

Definition at line 177 of file class.ilOverlayGUI.php.

    {
        $tpl = $this->tpl;
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        
        self::initJavascript();
        $tpl->addOnLoadCode($this->getOnLoadCode());
    }

References $tpl, getOnLoadCode(), and initJavascript().

Referenced by ilAssLacLegendGUI\initOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addTrigger()

ilOverlayGUI::addTrigger	(	$a_tr_id,
		$a_tr_event,
		$a_anchor_el_id,
		$a_center = `false`,
		$a_ov_corner = `"tl"`,
		$a_anch_corner = `"bl"`
	)

Add trigger.

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

      {
        $tpl = $this->tpl;
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        //echo "-".$a_tr_id."-".$a_tr_event."-".$a_anchor_el_id."-";
        self::initJavascript();
        $tpl->addOnLoadCode($this->getTriggerOnLoadCode(
            $a_tr_id,
            $a_tr_event,
            $a_anchor_el_id,
            $a_center,
            $a_ov_corner,
            $a_anch_corner
        ));
    }

References $tpl, getTriggerOnLoadCode(), and initJavascript().

Here is the call graph for this function:

◆ getAutoHide()

ilOverlayGUI::getAutoHide ( )

Get auto_hide.

Returns: boolean auto hide

Definition at line 115 of file class.ilOverlayGUI.php.

    {
        return $this->auto_hide;
    }

References $auto_hide.

◆ getCloseElementId()

ilOverlayGUI::getCloseElementId ( )

Get close element id.

Returns: string clos element id

Definition at line 135 of file class.ilOverlayGUI.php.

    {
        return $this->close_el;
    }

References $close_el.

◆ getOnLoadCode()

ilOverlayGUI::getOnLoadCode ( )

Makes an existing HTML element an overlay.

Definition at line 143 of file class.ilOverlayGUI.php.

    {
        // yui cfg string
        $yuicfg["visible"] = $this->visible ? true : false;
        
        if ($this->width != "") {
            $yuicfg["width"] = $this->width;
        }
        
        if ($this->height != "") {
            $yuicfg["height"] = $this->height;
        }
        $yuicfg["fixedcenter"] = $this->fixed_center ? true : false;
        if ($this->anchor_el_id != "") {
            $yuicfg["context"] = array($this->anchor_el_id, $this->anchor_ov_corner,
                    $this->anchor_anch_corner, array("beforeShow", "windowResize"));
        }
        // general cfg string
        $cfg["yuicfg"] = $yuicfg;
        $cfg["trigger"] = $this->trigger_el_id;
        $cfg["trigger_event"] = $this->trigger_event;
        $cfg["anchor_id"] = $this->trigger_anchor_el_id;
        $cfg["auto_hide"] = $this->auto_hide;
        $cfg["close_el"] = $this->close_el;
 
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
        //var_dump(ilJsonUtil::encode($cfg));
        return 'il.Overlay.add("' . $this->overlay_el_id . '", ' .
            ilJsonUtil::encode($cfg) . '); ';
    }

References $auto_hide, $cfg, $close_el, $height, $width, and ilJsonUtil\encode().

Referenced by add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTriggerOnLoadCode()

ilOverlayGUI::getTriggerOnLoadCode	(	$a_tr_id,
		$a_tr_event,
		$a_anchor_el_id,
		$a_center = `false`,
		$a_ov_corner = `"tl"`,
		$a_anch_corner = `"bl"`
	)

Get trigger onload code.

Parameters

return

Definition at line 210 of file class.ilOverlayGUI.php.

      {
        $center = ($a_center) ? "true" : "false";
        return 'il.Overlay.addTrigger("' . $a_tr_id . '","' . $a_tr_event . '","' . $this->overlay_el_id . '","' .
            $a_anchor_el_id . '", ' . $center . ',"' . $a_ov_corner . '","' . $a_anch_corner . '"); ';
    }

Referenced by addTrigger().

Here is the caller graph for this function:

◆ initJavascript()

static ilOverlayGUI::initJavascript ( )

static

Init javascript.

Parameters

return

Definition at line 192 of file class.ilOverlayGUI.php.

    {
        global $DIC;
 
        $tpl = $GLOBALS["tpl"];
        
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initOverlay($tpl);
        $tpl->addJavascript("./Services/UIComponent/Overlay/js/ilOverlay.js");
    }

References $DIC, $GLOBALS, $tpl, and ilYuiUtil\initOverlay().

Referenced by add(), addTrigger(), ilTestPlayerDynamicQuestionSetGUI\executeCommand(), ilSCORM2004ScoGUI\sco_preview(), ilPageObjectGUI\showPage(), ilSearchGUI\showSearch(), ilLuceneSearchGUI\showSearchForm(), and ilLuceneUserSearchGUI\showSearchForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAnchor()

ilOverlayGUI::setAnchor	(	$a_anchor_el_id,
		$a_ov_corner = `"tl"`,
		$a_anch_corner = `"bl"`
	)

Set anchor element.

Parameters

string	anchor element id
string	overlay corner ("tl", "tr", "bl", "br") aligned to...
string	anchor corner ("tl", "tr", "bl", "br")

Definition at line 48 of file class.ilOverlayGUI.php.

    {
        $this->anchor_el_id = $a_anchor_el_id;
        $this->anchor_ov_corner = $a_ov_corner;
        $this->anchor_anch_corner = $a_anch_corner;
    }

◆ setAutoHide()

ilOverlayGUI::setAutoHide ( $a_val )

Set auto hiding.

Parameters

boolean auto hide

Definition at line 105 of file class.ilOverlayGUI.php.

    {
        $this->auto_hide = $a_val;
    }

Referenced by ilAssLacLegendGUI\initOverlay().

Here is the caller graph for this function:

◆ setCloseElementId()

ilOverlayGUI::setCloseElementId ( $a_val )

Set close element id.

Parameters

string close element id

Definition at line 125 of file class.ilOverlayGUI.php.

    {
        $this->close_el = $a_val;
    }

◆ setFixedCenter()

ilOverlayGUI::setFixedCenter ( $a_fixed_center = true )

Set fixed center.

Parameters

boolean fixed center

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

    {
        $this->fixed_center = $a_fixed_center;
    }

◆ setSize()

ilOverlayGUI::setSize	(	$a_width = `""`,
		$a_height = `""`
	)

Set size.

Parameters

string	width, e.g. 300px
string	height, e.g. 300px

Definition at line 61 of file class.ilOverlayGUI.php.

    {
        $this->width = $a_width;
        $this->height = $a_height;
    }

◆ setTrigger()

ilOverlayGUI::setTrigger	(	$a_el_id,
		$a_event = `"click"`,
		$a_trigger_anchor_el_id = `null`
	)

Set trigger element.

Parameters

string	element id
string	event ("click" or "mouseover")

Definition at line 93 of file class.ilOverlayGUI.php.

    {
        $this->trigger_el_id = $a_el_id;
        $this->trigger_event = $a_event;
        $this->trigger_anchor_el_id = $a_trigger_anchor_el_id;
    }

◆ setVisible()

ilOverlayGUI::setVisible ( $a_visible = true )

Set visible.

Parameters

boolean visible

Definition at line 82 of file class.ilOverlayGUI.php.

    {
        $this->visible = $a_visible;
    }

Referenced by ilAssLacLegendGUI\initOverlay().

Here is the caller graph for this function:

Field Documentation

◆ $anchor_anch_corner

ilOverlayGUI::$anchor_anch_corner = ""

protected

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

◆ $anchor_el_id

ilOverlayGUI::$anchor_el_id = ""

protected

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

◆ $anchor_ov_corner

ilOverlayGUI::$anchor_ov_corner = ""

protected

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

◆ $auto_hide

ilOverlayGUI::$auto_hide = false

protected

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

Referenced by getAutoHide(), and getOnLoadCode().

◆ $close_el

ilOverlayGUI::$close_el = null

protected

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

Referenced by getCloseElementId(), and getOnLoadCode().

◆ $fixed_center

ilOverlayGUI::$fixed_center = false

protected

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

◆ $height

ilOverlayGUI::$height = ""

protected

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

Referenced by getOnLoadCode().

◆ $tpl

ilOverlayGUI::$tpl

protected

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

Referenced by add(), addTrigger(), and initJavascript().

◆ $visible

ilOverlayGUI::$visible = false

protected

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

◆ $width

ilOverlayGUI::$width = ""

protected

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

Referenced by getOnLoadCode().

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

Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addTrigger()

◆ getAutoHide()

◆ getCloseElementId()

◆ getOnLoadCode()

◆ getTriggerOnLoadCode()

◆ initJavascript()

◆ setAnchor()

◆ setAutoHide()

◆ setCloseElementId()

◆ setFixedCenter()

◆ setSize()

◆ setTrigger()

◆ setVisible()

Field Documentation

◆ $anchor_anch_corner

◆ $anchor_el_id

◆ $anchor_ov_corner

◆ $auto_hide

◆ $close_el

◆ $fixed_center

◆ $height

◆ $tpl

◆ $visible

◆ $width