ilFramesetGUI Class Reference

Class ilFramesetGUI. More...

Collaboration diagram for ilFramesetGUI:

Public Member Functions
	__construct ()
	Constructor public. More...
	setFramesetTitle ($a_fs_title)
	set title for frameset (is normally shown by browser) More...
	setMainFrameSource ($a_main_source)
	source url for main frame More...
	setMainFrameTitle ($a_main_title)
	title for main frame More...
	setMainFrameName ($a_main_name)
	name for main frame More...
	setSideFrameSource ($a_side_source)
	source url for side frame More...
	setSideFrameTitle ($a_side_title)
	title for side frame More...
	setSideFrameName ($a_side_name)
	name for main frame More...
	setMainWidth ($a_mainwidth)
	Set Main Width. More...
	getMainWidth ()
	Get Main Width. More...
	setSideWidth ($a_sidewidth)
	Set Side Width. More...
	getSideWidth ()
	Get Side Width. More...
	get ()
	Get. More...
	show ($a_get_only=false)
	Show frameset. More...

Protected Attributes
	$lng
	$settings

Detailed Description

Class ilFramesetGUI.

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.ilFramesetGUI.php.

Constructor & Destructor Documentation

__construct()

ilFramesetGUI::__construct

(

)

Constructor public.

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

References $DIC, $lng, setMainFrameTitle(), setMainWidth(), setSideFrameTitle(), setSideWidth(), and settings().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();
        
        $this->setMainWidth("*");
        $this->setSideWidth("25%");
        
        // default titles (accessibility revision)
        // should not been overwritten, if no good reason is given
        $this->setSideFrameTitle($lng->txt("side_frame"));
        $this->setMainFrameTitle($lng->txt("content_frame"));
    }

Here is the call graph for this function:

Member Function Documentation

get()

ilFramesetGUI::get

(

)

Get.

Definition at line 144 of file class.ilFramesetGUI.php.

References show().

    {
        return $this->show(true);
    }

Here is the call graph for this function:

getMainWidth()

ilFramesetGUI::getMainWidth

(

)

Get Main Width.

Returns

string Main Width

Definition at line 116 of file class.ilFramesetGUI.php.

Referenced by show().

    {
        return $this->mainwidth;
    }

Here is the caller graph for this function:

getSideWidth()

ilFramesetGUI::getSideWidth

(

)

Get Side Width.

Returns

string Side Width

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

Referenced by show().

    {
        return $this->sidewidth;
    }

Here is the caller graph for this function:

setFramesetTitle()

ilFramesetGUI::setFramesetTitle

(

$a_fs_title

)

set title for frameset (is normally shown by browser)

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

    {
        $this->frameset_title = $a_fs_title;
    }

setMainFrameName()

ilFramesetGUI::setMainFrameName

(

$a_main_name

)

name for main frame

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

    {
        $this->main_frame_name = $a_main_name;
    }

setMainFrameSource()

ilFramesetGUI::setMainFrameSource

(

$a_main_source

)

source url for main frame

Definition at line 56 of file class.ilFramesetGUI.php.

    {
        $this->main_frame_source = $a_main_source;
    }

setMainFrameTitle()

ilFramesetGUI::setMainFrameTitle

(

$a_main_title

)

title for main frame

Definition at line 64 of file class.ilFramesetGUI.php.

Referenced by __construct().

    {
        $this->main_frame_title = $a_main_title;
    }

Here is the caller graph for this function:

setMainWidth()

ilFramesetGUI::setMainWidth

(

$a_mainwidth

)

Set Main Width.

Parameters

string

$a_mainwidth

Main Width

Definition at line 106 of file class.ilFramesetGUI.php.

Referenced by __construct().

    {
        $this->mainwidth = $a_mainwidth;
    }

Here is the caller graph for this function:

setSideFrameName()

ilFramesetGUI::setSideFrameName

(

$a_side_name

)

name for main frame

Definition at line 96 of file class.ilFramesetGUI.php.

    {
        $this->side_frame_name = $a_side_name;
    }

setSideFrameSource()

ilFramesetGUI::setSideFrameSource

(

$a_side_source

)

source url for side frame

Definition at line 80 of file class.ilFramesetGUI.php.

    {
        $this->side_frame_source = $a_side_source;
    }

setSideFrameTitle()

ilFramesetGUI::setSideFrameTitle

(

$a_side_title

)

title for side frame

Definition at line 88 of file class.ilFramesetGUI.php.

Referenced by __construct().

    {
        $this->side_frame_title = $a_side_title;
    }

Here is the caller graph for this function:

setSideWidth()

ilFramesetGUI::setSideWidth

(

$a_sidewidth

)

Set Side Width.

Parameters

string

$a_sidewidth

Side Width

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

Referenced by __construct().

    {
        $this->sidewidth = $a_sidewidth;
    }

Here is the caller graph for this function:

show()

ilFramesetGUI::show

(

$a_get_only = false

)

Show frameset.

Definition at line 153 of file class.ilFramesetGUI.php.

References $ilSetting, $settings, $tpl, getMainWidth(), getSideWidth(), ilUtil\getStyleSheetLocation(), and ilUtil\stripScriptHTML().

Referenced by get().

    {
        $ilSetting = $this->settings;
        
        if ($ilSetting->get("tree_frame") == "right") {
            $main = "LEFT";
            $side = "RIGHT";
        } else {
            $main = "RIGHT";
            $side = "LEFT";
        }

        $tpl = new ilTemplate("tpl.frameset.html", true, false);
        $tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());

        $tpl->setVariable("PAGETITLE", "- " . ilUtil::stripScriptHTML($this->frameset_title));
        $tpl->setVariable("SRC_" . $main, $this->main_frame_source);
        $tpl->setVariable("SRC_" . $side, $this->side_frame_source);
        $tpl->setVariable("TITLE_" . $main, $this->main_frame_title);
        $tpl->setVariable("TITLE_" . $side, $this->side_frame_title);
        $tpl->setVariable("NAME_" . $main, $this->main_frame_name);
        $tpl->setVariable("NAME_" . $side, $this->side_frame_name);
        $tpl->setVariable("WIDTH_" . $main, $this->getMainWidth());
        $tpl->setVariable("WIDTH_" . $side, $this->getSideWidth());
        if ($ilSetting->get('short_inst_name') != "") {
            $tpl->setVariable(
                "WINDOW_TITLE",
                $ilSetting->get('short_inst_name')
            );
        } else {
            $tpl->setVariable(
                "WINDOW_TITLE",
                "ILIAS"
            );
        }

        if ($a_get_only) {
            return $tpl->get();
        } else {
            $tpl->show("DEFAULT", false);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

ilFramesetGUI::$lng

protected

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

Referenced by __construct().

$settings

ilFramesetGUI::$settings

protected

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

Referenced by show().

---

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

• Services/Frameset/classes/class.ilFramesetGUI.php