ilLightboxGUI Class Reference

Lighbox handling. More...

Collaboration diagram for ilLightboxGUI:

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

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

Protected Attributes
	$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

ilLightboxGUI::__construct

(

$a_id

)

Constructor.

Parameters

@return

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

References setId().

        {
                $this->setId($a_id);
        }

Here is the call graph for this function:

Member Function Documentation

ilLightboxGUI::addLightbox

(

$a_tpl = null

)

Init lightbox.

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

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

        {
                global $tpl;
                
                if ($a_tpl == null)
                {
                        $a_tpl = $tpl;
                }

                $a_tpl->addJavaScript(self::getLocalLightboxJsPath());
                $a_tpl->addLightbox($this->getHTML(), $this->getId());
        }

Here is the call graph for this function:

ilLightboxGUI::getHTML

(

)

Get HTML.

Parameters

@return

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

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

Referenced by addLightbox().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilLightboxGUI::getId

(

)

Get Id.

Returns

string id

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

References $id.

Referenced by addLightbox(), and getHTML().

        {
                return $this->id;
        }

Here is the caller graph for this function:

static ilLightboxGUI::getLocalLightboxJsPath ( )

static

Get local path of jQuery file.

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

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

ilLightboxGUI::getWidth

(

)

Get width.

Returns

string width

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

Referenced by getHTML().

        {
                return $this->width;
        }

Here is the caller graph for this function:

ilLightboxGUI::setId

(

$a_val

)

Set Id.

Parameters

string

$a_val

id

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

Referenced by __construct().

        {
                $this->id = $a_val;
        }

Here is the caller graph for this function:

ilLightboxGUI::setWidth

(

$a_val

)

Set width.

Parameters

string

$a_val

width

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

        {
                $this->width = $a_val;
        }

Field Documentation

ilLightboxGUI::$id = ""

protected

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

Referenced by getId().

---

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

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