class.ilOverlayGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilOverlayGUI
{
        protected $width = "";
        protected $height = "";
        protected $fixed_center = false;
        protected $visible = false;
        protected $anchor_el_id = "";
        protected $anchor_ov_corner = "";
        protected $anchor_anch_corner = "";
        protected $auto_hide = true;
        protected $close_el = null;
        
        function __construct($a_overlay_el_id)
        {
                $this->overlay_el_id = $a_overlay_el_id;
        }

        function setAnchor($a_anchor_el_id, $a_ov_corner = "tl", $a_anch_corner = "bl")
        {
                $this->anchor_el_id = $a_anchor_el_id;
                $this->anchor_ov_corner = $a_ov_corner;
                $this->anchor_anch_corner = $a_anch_corner;
        }

        function setSize($a_width = "", $a_height = "")
        {
                $this->width = $a_width;
                $this->height = $a_height;
        }
        
        function setFixedCenter($a_fixed_center = true)
        {
                $this->fixed_center = $a_fixed_center;
        }

        function setVisible($a_visible = true)
        {
                $this->visible = $a_visible;    
        }
        
        function setTrigger($a_el_id, $a_event = "onclick", $a_trigger_anchor_el_id = null)
        {
                $this->trigger_el_id = $a_el_id;
                $this->trigger_event = $a_event;
                $this->trigger_anchor_el_id = $a_trigger_anchor_el_id;
        }
        
        function setAutoHide($a_val)
        {
                $this->auto_hide = $a_val;
        }
        
        function getAutoHide()
        {
                return $this->auto_hide;
        }
        
        function setCloseElementId($a_val)
        {
                $this->close_el = $a_val;
        }
        
        function getCloseElementId()
        {
                return $this->close_el;
        }
        
        function getOnLoadCode()
        {
                // 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 'ilOverlay.add("'.$this->overlay_el_id.'", '.
                        ilJsonUtil::encode($cfg).'); ';
        }
        
        function add()
        {
                global $tpl;
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                
                ilYuiUtil::initOverlay();
                $tpl->addJavascript("./Services/UIComponent/Overlay/js/ilOverlay.js");
                $tpl->addOnLoadCode($this->getOnLoadCode()); 
        }
        
        function getTriggerOnLoadCode($a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center = false,
                                                                  $a_ov_corner = "tl", $a_anch_corner = "bl")
        {
                $center = ($a_center) ? "true" : "false";
                return 'ilOverlay.addTrigger("'.$a_tr_id.'","'.$a_tr_event.'","'.$this->overlay_el_id.'","'.
                        $a_anchor_el_id.'", '.$center.',"'.$a_ov_corner.'","'.$a_anch_corner.'"); ';
        }
        
        function addTrigger($a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center = false,
                                                $a_ov_corner = "tl", $a_anch_corner = "bl")
        {
                global $tpl;
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
//echo "-".$a_tr_id."-".$a_tr_event."-".$a_anchor_el_id."-";
                ilYuiUtil::initOverlay();
                $tpl->addJavascript("./Services/UIComponent/Overlay/js/ilOverlay.js");
                $tpl->addOnLoadCode($this->getTriggerOnLoadCode($a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center,
                                $a_ov_corner, $a_anch_corner)); 
        }
        
        
        
}
?>