Simple panel class. More...

Collaboration diagram for ilPanelGUI:

Public Member Functions
	setHeading ($a_val)
	Set heading. More...

	getHeading ()
	Get heading. More...

	setBody ($a_val)
	Set body. More...

	getBody ()
	Get body. More...

	setFooter ($a_val)
	Set footer. More...

	getFooter ()
	Get body. More...

	setPanelStyle ($a_val)
	Set panel style. More...

	getPanelStyle ()
	Get panel style. More...

	setHeadingStyle ($a_val)
	Set heading style. More...

	getHeadingStyle ()
	Get heading style. More...

	setFooterStyle ($a_val)
	Set footer style. More...

	getFooterStyle ()
	Get footer style. More...

	getHTML ()
	Get HTML. More...

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Data Fields
const	PANEL_STYLE_PRIMARY = 0

const	PANEL_STYLE_SECONDARY = 1

const	HEADING_STYLE_SUBHEADING = 0

const	HEADING_STYLE_BLOCK = 1

const	FOOTER_STYLE_BLOCK = 0

Protected Member Functions
	__construct ()
	Constructor. More...

Protected Attributes
	$heading = ""

	$body = ""

	$footer = ""

	$panel_style = 0

	$heading_style = 0

	$footer_style = 0

Detailed Description

Simple panel class.

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

Constructor & Destructor Documentation

◆ __construct()

ilPanelGUI::__construct ( )

protected

Constructor.

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

         {
 
         }

Member Function Documentation

◆ getBody()

ilPanelGUI::getBody ( )

Get body.

Returns: string body

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

References $body.

Referenced by getHTML().

         {
                 return $this->body;
         }

Here is the caller graph for this function:

◆ getFooter()

ilPanelGUI::getFooter ( )

Get body.

Returns: string body

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

References $footer.

Referenced by getHTML().

         {
                 return $this->footer;
         }

Here is the caller graph for this function:

◆ getFooterStyle()

ilPanelGUI::getFooterStyle ( )

Get footer style.

Returns: int footer style

Definition at line 162 of file class.ilPanelGUI.php.

References $footer_style.

Referenced by getHTML().

         {
                 return $this->footer_style;
         }

Here is the caller graph for this function:

◆ getHeading()

ilPanelGUI::getHeading ( )

Get heading.

Returns: string heading

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

References $heading.

Referenced by getHTML().

         {
                 return $this->heading;
         }

Here is the caller graph for this function:

◆ getHeadingStyle()

ilPanelGUI::getHeadingStyle ( )

Get heading style.

Returns: int heading style

Definition at line 142 of file class.ilPanelGUI.php.

References $heading_style.

Referenced by getHTML().

         {
                 return $this->heading_style;
         }

Here is the caller graph for this function:

◆ getHTML()

ilPanelGUI::getHTML ( )

Get HTML.

Returns: string html

Definition at line 172 of file class.ilPanelGUI.php.

References $tpl, getBody(), getFooter(), getFooterStyle(), getHeading(), getHeadingStyle(), and getPanelStyle().

         {
                 $tpl = new ilTemplate("tpl.panel.html", true, true, "Services/UIComponent/Panel");
 
                 $head_outer_div_style = "";
                 if ($this->getHeading() != "")
                 {
                         $tpl->setCurrentBlock("heading");
                         $tpl->setVariable("HEADING", $this->getHeading());
 
                         switch ($this->getHeadingStyle())
                         {
                                 case self::HEADING_STYLE_BLOCK:
                                         $tpl->setVariable("HEAD_DIV_STYLE", "panel-heading ilBlockHeader");
                                         $tpl->setVariable("HEAD_H3_STYLE", "ilBlockHeader");
                                         $head_outer_div_style = "il_Block";
                                         break;
 
                                 case self::HEADING_STYLE_SUBHEADING:
                                         $tpl->setVariable("HEAD_DIV_STYLE", "panel-heading ilHeader");
                                         $tpl->setVariable("HEAD_H3_STYLE", "ilHeader");
                                         break;
                         }
 
                         $tpl->parseCurrentBlock();
                 }
 
                 $tpl->setVariable("BODY", $this->getBody());
                 
                 if ($this->getFooter() != "")
                 {
                         $tpl->setCurrentBlock("footer");
                         $tpl->setVariable("FOOTER", $this->getFooter());
                         
                         switch ($this->getFooterStyle())
                         {
                                 case self::FOOTER_STYLE_BLOCK:
                                         $tpl->setVariable("FOOT_DIV_STYLE", "panel-footer ilBlockInfo");                                        
                                         break;
                         }
                                                 
                         $tpl->parseCurrentBlock();
                 }
 
                 switch ($this->getPanelStyle())
                 {
                         case self::PANEL_STYLE_SECONDARY:
                                 $tpl->setVariable("PANEL_STYLE", "panel panel-default ".$head_outer_div_style);
                                 break;
 
                         default:
                                 $tpl->setVariable("PANEL_STYLE", "panel panel-primary ".$head_outer_div_style);
                                 break;
                 }                               
 
                 return $tpl->get();
         }

Here is the call graph for this function:

◆ getInstance()

static ilPanelGUI::getInstance ( )

static

Get instance.

Returns: ilPanelGUI panel instance

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

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), SurveyQuestionGUI\addMaterial(), ilTestQuestionSideListGUI\buildPanel(), ilChatroomViewTask\cancelJoin(), ilObjFileAccessSettingsGUI\editDiskQuotaMailTemplate(), ilPersonalSkillsGUI\getGapAnalysisHTML(), ilChecklistGUI\getHTML(), ilLPListOfSettingsGUI\handleLPUsageInfo(), SurveyQuestionGUI\preview(), ilUsersGalleryGUI\renderLinkButton(), ilObjBlogGUI\renderNavigation(), ilExSubmissionObjectGUI\renderResourceSelection(), ilSurveyExecutionGUI\runShowFinishedPage(), ilSystemSupportContactsGUI\showContacts(), ilLicenseOverviewGUI\showLicenses(), ilExPeerReviewGUI\showPeerReviewOverviewObject(), and ilWikiStatGUI\view().

         {
                 return new ilPanelGUI();
         }

Here is the caller graph for this function:

◆ getPanelStyle()

ilPanelGUI::getPanelStyle ( )

Get panel style.

Returns: int panel_style

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

References $panel_style.

Referenced by getHTML().

         {
                 return $this->panel_style;
         }

Here is the caller graph for this function:

◆ setBody()

ilPanelGUI::setBody ( $a_val )

Set body.

Parameters

string $a_val body

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

         {
                 $this->body = $a_val;
         }

◆ setFooter()

ilPanelGUI::setFooter ( $a_val )

Set footer.

Parameters

string $a_val footer

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

         {
                 $this->footer = $a_val;
         }

◆ setFooterStyle()

ilPanelGUI::setFooterStyle ( $a_val )

Set footer style.

Parameters

int $a_val footer style

Definition at line 152 of file class.ilPanelGUI.php.

         {
                 $this->footer_style = $a_val;
         }

◆ setHeading()

ilPanelGUI::setHeading ( $a_val )

Set heading.

Parameters

string $a_val heading

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

         {
                 $this->heading = $a_val;
         }

◆ setHeadingStyle()

ilPanelGUI::setHeadingStyle ( $a_val )

Set heading style.

Parameters

int $a_val heading style

Definition at line 132 of file class.ilPanelGUI.php.

         {
                 $this->heading_style = $a_val;
         }

◆ setPanelStyle()

ilPanelGUI::setPanelStyle ( $a_val )

Set panel style.

Parameters

int $a_val panel_style

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

         {
                 $this->panel_style = $a_val;
         }

Field Documentation

◆ $body

ilPanelGUI::$body = ""

protected

Definition at line 23 of file class.ilPanelGUI.php.

Referenced by getBody().

◆ $footer

ilPanelGUI::$footer = ""

protected

Definition at line 24 of file class.ilPanelGUI.php.

Referenced by getFooter().

◆ $footer_style

ilPanelGUI::$footer_style = 0

protected

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

Referenced by getFooterStyle().

◆ $heading

ilPanelGUI::$heading = ""

protected

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

Referenced by getHeading().

◆ $heading_style

ilPanelGUI::$heading_style = 0

protected

Definition at line 26 of file class.ilPanelGUI.php.

Referenced by getHeadingStyle().

◆ $panel_style

ilPanelGUI::$panel_style = 0

protected

Definition at line 25 of file class.ilPanelGUI.php.

Referenced by getPanelStyle().

◆ FOOTER_STYLE_BLOCK

const ilPanelGUI::FOOTER_STYLE_BLOCK = 0

Definition at line 20 of file class.ilPanelGUI.php.

◆ HEADING_STYLE_BLOCK

const ilPanelGUI::HEADING_STYLE_BLOCK = 1

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

Referenced by ilChatroomViewTask\cancelJoin(), ilObjFileAccessSettingsGUI\editDiskQuotaMailTemplate(), ilChecklistGUI\getHTML(), and ilObjBlogGUI\renderNavigation().

◆ HEADING_STYLE_SUBHEADING

const ilPanelGUI::HEADING_STYLE_SUBHEADING = 0

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

Referenced by ilTestQuestionSideListGUI\buildPanel(), and ilWikiStatGUI\view().

◆ PANEL_STYLE_PRIMARY

const ilPanelGUI::PANEL_STYLE_PRIMARY = 0

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

Referenced by ilPersonalSkillsGUI\getGapAnalysisHTML(), and ilSystemSupportContactsGUI\showContacts().

◆ PANEL_STYLE_SECONDARY

const ilPanelGUI::PANEL_STYLE_SECONDARY = 1

Definition at line 15 of file class.ilPanelGUI.php.

Referenced by ilLearningProgressBaseGUI\__getLegendHTML(), ilTestQuestionSideListGUI\buildPanel(), ilChatroomViewTask\cancelJoin(), ilChecklistGUI\getHTML(), ilLPListOfSettingsGUI\handleLPUsageInfo(), ilObjBlogGUI\renderNavigation(), and ilLicenseOverviewGUI\showLicenses().

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

Services/UIComponent/Panel/classes/class.ilPanelGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getBody()

◆ getFooter()

◆ getFooterStyle()

◆ getHeading()

◆ getHeadingStyle()

◆ getHTML()

◆ getInstance()

◆ getPanelStyle()

◆ setBody()

◆ setFooter()

◆ setFooterStyle()

◆ setHeading()

◆ setHeadingStyle()

◆ setPanelStyle()

Field Documentation

◆ $body

◆ $footer

◆ $footer_style

◆ $heading

◆ $heading_style

◆ $panel_style

◆ FOOTER_STYLE_BLOCK

◆ HEADING_STYLE_BLOCK

◆ HEADING_STYLE_SUBHEADING

◆ PANEL_STYLE_PRIMARY

◆ PANEL_STYLE_SECONDARY