ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilFramesetGUI Class Reference

Class ilFramesetGUI. More...

+ Collaboration diagram for ilFramesetGUI:

Public Member Functions

 __construct ()
 Constructor @access 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...
 

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 @access public.

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

19 {
20 global $lng;
21
22 $this->setMainWidth("*");
23 $this->setSideWidth("25%");
24
25 // default titles (accessibility revision)
26 // should not been overwritten, if no good reason is given
27 $this->setSideFrameTitle($lng->txt("side_frame"));
28 $this->setMainFrameTitle($lng->txt("content_frame"));
29 }
setSideWidth($a_sidewidth)
Set Side Width.
setMainWidth($a_mainwidth)
Set Main Width.
setSideFrameTitle($a_side_title)
title for side frame
setMainFrameTitle($a_main_title)
title for main frame
global $lng
Definition: privfeed.php:40

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

+ Here is the call graph for this function:

Member Function Documentation

◆ get()

ilFramesetGUI::get ( )

Get.

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

131 {
132 return $this->show(true);
133 }
show($a_get_only=false)
Show frameset.

References show().

+ Here is the call graph for this function:

◆ getMainWidth()

ilFramesetGUI::getMainWidth ( )

Get Main Width.

Returns
string Main Width

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

103 {
104 return $this->mainwidth;
105 }

Referenced by show().

+ Here is the caller graph for this function:

◆ getSideWidth()

ilFramesetGUI::getSideWidth ( )

Get Side Width.

Returns
string Side Width

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

123 {
124 return $this->sidewidth;
125 }

Referenced by show().

+ 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 34 of file class.ilFramesetGUI.php.

35 {
36 $this->frameset_title = $a_fs_title;
37 }

◆ setMainFrameName()

ilFramesetGUI::setMainFrameName (   $a_main_name)

name for main frame

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

59 {
60 $this->main_frame_name = $a_main_name;
61 }

◆ setMainFrameSource()

ilFramesetGUI::setMainFrameSource (   $a_main_source)

source url for main frame

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

43 {
44 $this->main_frame_source = $a_main_source;
45 }

◆ setMainFrameTitle()

ilFramesetGUI::setMainFrameTitle (   $a_main_title)

title for main frame

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

51 {
52 $this->main_frame_title = $a_main_title;
53 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setMainWidth()

ilFramesetGUI::setMainWidth (   $a_mainwidth)

Set Main Width.

Parameters
string$a_mainwidthMain Width

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

93 {
94 $this->mainwidth = $a_mainwidth;
95 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setSideFrameName()

ilFramesetGUI::setSideFrameName (   $a_side_name)

name for main frame

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

83 {
84 $this->side_frame_name = $a_side_name;
85 }

◆ setSideFrameSource()

ilFramesetGUI::setSideFrameSource (   $a_side_source)

source url for side frame

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

67 {
68 $this->side_frame_source = $a_side_source;
69 }

◆ setSideFrameTitle()

ilFramesetGUI::setSideFrameTitle (   $a_side_title)

title for side frame

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

75 {
76 $this->side_frame_title = $a_side_title;
77 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setSideWidth()

ilFramesetGUI::setSideWidth (   $a_sidewidth)

Set Side Width.

Parameters
string$a_sidewidthSide Width

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

113 {
114 $this->sidewidth = $a_sidewidth;
115 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ show()

ilFramesetGUI::show (   $a_get_only = false)

Show frameset.

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

140 {
141 global $ilSetting;
142
143 if ($ilSetting->get("tree_frame") == "right")
144 {
145 $main = "LEFT";
146 $side = "RIGHT";
147 }
148 else
149 {
150 $main = "RIGHT";
151 $side = "LEFT";
152 }
153
154 $tpl = new ilTemplate("tpl.frameset.html", true, false);
155 $tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
156
157 $tpl->setVariable("PAGETITLE", "- ".ilUtil::stripScriptHTML($this->frameset_title));
158 $tpl->setVariable("SRC_".$main, $this->main_frame_source);
159 $tpl->setVariable("SRC_".$side, $this->side_frame_source);
160 $tpl->setVariable("TITLE_".$main, $this->main_frame_title);
161 $tpl->setVariable("TITLE_".$side, $this->side_frame_title);
162 $tpl->setVariable("NAME_".$main, $this->main_frame_name);
163 $tpl->setVariable("NAME_".$side, $this->side_frame_name);
164 $tpl->setVariable("WIDTH_".$main, $this->getMainWidth());
165 $tpl->setVariable("WIDTH_".$side, $this->getSideWidth());
166 if ($ilSetting->get('short_inst_name') != "")
167 {
168 $tpl->setVariable("WINDOW_TITLE",
169 $ilSetting->get('short_inst_name'));
170 }
171 else
172 {
173 $tpl->setVariable("WINDOW_TITLE",
174 "ILIAS");
175 }
176
177 if ($a_get_only)
178 {
179 return $tpl->get();
180 }
181 else
182 {
183 $tpl->show("DEFAULT", false);
184 }
185 }
global $tpl
Definition: ilias.php:8
getSideWidth()
Get Side Width.
getMainWidth()
Get Main Width.
special template class to simplify handling of ITX/PEAR
static getStyleSheetLocation($mode="output", $a_css_name="", $a_css_location="")
get full style sheet file name (path inclusive) of current user
static stripScriptHTML($a_str, $a_allow="", $a_rm_js=true)
strip only html tags (4.0) from text $allowed contains tags to be allowed, in format tags a and b ar...
global $ilSetting
Definition: privfeed.php:40

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

Referenced by get().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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