ilFormSectionHeaderGUI Class Reference [Services/Form]

This class represents a section header in a property form. More...

Public Member Functions
	__construct ()
	Constructor.
	checkInput ()
	setType ($a_type)
	Set Type.
	getType ()
	Get Type.
	setSectionIcon ($a_file, $a_alt)
	Set section icon.
	getSectionIcon ()
	Get section icon.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	insert (&$a_tpl)
	Insert property html.
Protected Attributes
	$type
	$title
	$info
	$section_icon

---

Detailed Description

This class represents a section header in a property form.

Author:

Alex Killing <alex.killing@gmx.de>

Version:

$Id$

Definition at line 31 of file class.ilFormSectionHeaderGUI.php.

---

Constructor & Destructor Documentation

ilFormSectionHeaderGUI::__construct

(

)

Constructor.

Parameters:

Definition at line 43 of file class.ilFormSectionHeaderGUI.php.

References setType().

        {
                $this->setType("section_header");
        }

Here is the call graph for this function:

---

Member Function Documentation

ilFormSectionHeaderGUI::checkInput

(

)

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

        {
                return true;
        }

ilFormSectionHeaderGUI::getInfo

(

)

Get Information Text.

Returns:

string Information Text

Definition at line 133 of file class.ilFormSectionHeaderGUI.php.

        {
                return $this->info;
        }

ilFormSectionHeaderGUI::getSectionIcon

(

)

Get section icon.

public

Definition at line 93 of file class.ilFormSectionHeaderGUI.php.

Referenced by insert().

        {
                return $this->section_icon ? $this->section_icon : array();
        }

Here is the caller graph for this function:

ilFormSectionHeaderGUI::getTitle

(

)

Get Title.

Returns:

string Title

Definition at line 113 of file class.ilFormSectionHeaderGUI.php.

Referenced by insert().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilFormSectionHeaderGUI::getType

(

)

Get Type.

Returns:

string Type

Definition at line 68 of file class.ilFormSectionHeaderGUI.php.

        {
                return $this->type;
        }

ilFormSectionHeaderGUI::insert

(

&$

a_tpl

)

Insert property html.

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

References $section_icon, getSectionIcon(), and getTitle().

        {
                $section_icon = $this->getSectionIcon();
                
                if(isset($section_icon['file']) && is_file($section_icon['file']))
                {
                        $a_tpl->setCurrentBlock("title_icon");
                        $a_tpl->setVariable("IMG_ICON",$section_icon['file']);
                        $a_tpl->setVariable('IMG_ALT',$section_icon['alt']);
                        $a_tpl->parseCurrentBlock();
                }
                
                $a_tpl->setCurrentBlock("header");
                $a_tpl->setVariable("TXT_TITLE", $this->getTitle());
                $a_tpl->setVariable('HEAD_COLSPAN',2);
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilFormSectionHeaderGUI::setInfo

(

$

a_info

)

Set Information Text.

Parameters:

string

$a_info Information Text

Definition at line 123 of file class.ilFormSectionHeaderGUI.php.

        {
                $this->info = $a_info;
        }

ilFormSectionHeaderGUI::setSectionIcon	(	$	a_file,
		$	a_alt
	)

Set section icon.

public

Parameters:

	string	path to icon
	string	alternative text

Definition at line 81 of file class.ilFormSectionHeaderGUI.php.

        {
                $this->section_icon['file'] = $a_file;
                $this->section_icon['alt'] = $a_alt;
        }

ilFormSectionHeaderGUI::setTitle

(

$

a_title

)

Set Title.

Parameters:

string

$a_title Title

Definition at line 103 of file class.ilFormSectionHeaderGUI.php.

        {
                $this->title = $a_title;
        }

ilFormSectionHeaderGUI::setType

(

$

a_type

)

Set Type.

Parameters:

string

$a_type Type

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

Referenced by __construct().

        {
                $this->type = $a_type;
        }

Here is the caller graph for this function:

---

Field Documentation

ilFormSectionHeaderGUI::$info [protected]

Definition at line 35 of file class.ilFormSectionHeaderGUI.php.

ilFormSectionHeaderGUI::$section_icon [protected]

Definition at line 36 of file class.ilFormSectionHeaderGUI.php.

Referenced by insert().

ilFormSectionHeaderGUI::$title [protected]

Definition at line 34 of file class.ilFormSectionHeaderGUI.php.

ilFormSectionHeaderGUI::$type [protected]

Definition at line 33 of file class.ilFormSectionHeaderGUI.php.

---

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

• Services/Form/classes/class.ilFormSectionHeaderGUI.php