ilLightboxGUI Class Reference

Lighbox handling. More...

Collaboration diagram for ilLightboxGUI:

Public Member Functions
	__construct ($a_id)
	Constructor. More...
	setId ($a_val)
	Set Id. More...
	getId ()
	Get Id. More...
	setWidth ($a_val)
	Set width. More...
	getWidth ()
	Get width. More...
	addLightbox ($a_tpl=null)
	Init lightbox. More...
	getHTML ()
	Get HTML. More...

Static Public Member Functions
static	getLocalLightboxJsPath ()
	Get local path of jQuery file. More...

Protected Attributes
	$tpl
	$id = ""

Detailed Description

Lighbox handling.

Author

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

Version

$Id$

Definition at line 12 of file class.ilLightboxGUI.php.

Constructor & Destructor Documentation

__construct()

ilLightboxGUI::__construct

(

$a_id

)

Constructor.

Parameters

return

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

    {
        global $DIC;
 
        $this->tpl = $DIC["tpl"];
        $this->setId($a_id);
    }

References $DIC, and setId().

Here is the call graph for this function:

Member Function Documentation

addLightbox()

ilLightboxGUI::addLightbox

(

$a_tpl = null

)

Init lightbox.

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

    {
        $tpl = $this->tpl;
        
        if ($a_tpl == null) {
            $a_tpl = $tpl;
        }
 
        $a_tpl->addJavaScript(self::getLocalLightboxJsPath());
        $a_tpl->addLightbox($this->getHTML(), $this->getId());
    }

References $tpl, getHTML(), and getId().

Here is the call graph for this function:

getHTML()

ilLightboxGUI::getHTML

(

)

Get HTML.

Parameters

return

Definition at line 104 of file class.ilLightboxGUI.php.

    {
        $tpl = new ilTemplate("tpl.lightbox.html", true, true, "Services/UIComponent/Lightbox");
        $tpl->setVariable("LIGHTBOX_CONTENT", "");
        $tpl->setVariable("ID", $this->getId());
        if ($this->getWidth() != "") {
            $tpl->setVariable("WIDTH", "width: " . $this->getWidth() . ";");
        }
        return $tpl->get();
    }

References $tpl, getId(), and getWidth().

Referenced by addLightbox().

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilLightboxGUI::getId

(

)

Get Id.

Returns

string id

Definition at line 50 of file class.ilLightboxGUI.php.

    {
        return $this->id;
    }

References $id.

Referenced by addLightbox(), and getHTML().

Here is the caller graph for this function:

getLocalLightboxJsPath()

static ilLightboxGUI::getLocalLightboxJsPath ( )

static

Get local path of jQuery file.

Definition at line 78 of file class.ilLightboxGUI.php.

    {
        return "./Services/UIComponent/Lightbox/js/Lightbox.js";
    }

getWidth()

ilLightboxGUI::getWidth

(

)

Get width.

Returns

string width

Definition at line 70 of file class.ilLightboxGUI.php.

    {
        return $this->width;
    }

Referenced by getHTML().

Here is the caller graph for this function:

setId()

ilLightboxGUI::setId

(

$a_val

)

Set Id.

Parameters

string

$a_val

id

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

    {
        $this->id = $a_val;
    }

Referenced by __construct().

Here is the caller graph for this function:

setWidth()

ilLightboxGUI::setWidth

(

$a_val

)

Set width.

Parameters

string

$a_val

width

Definition at line 60 of file class.ilLightboxGUI.php.

    {
        $this->width = $a_val;
    }

Field Documentation

$id

ilLightboxGUI::$id = ""

protected

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

Referenced by getId().

$tpl

ilLightboxGUI::$tpl

protected

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

Referenced by addLightbox(), and getHTML().

---

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

• Services/UIComponent/Lightbox/classes/class.ilLightboxGUI.php