Docs For Class ModulSelect

Description

This class defines a HTML Select Box for all installed Moduls.

You can choose whether deactivated Moduls should be shown. You can choose which Language is used to fetch Moduls information. You can choose which Modul is preselected. You can choose if Modul are sorted in alphabetical order.

Set all values and call

getHtml()

.

version: $Id: ModulSelect.php,v 1.1 2007/01/08 23:40:03 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

HtmlElement
   |
   --Select
      |
      --ModulSelect

Method Summary

ModulSelect ModulSelect ()

void setModulLanguage (String $modulLanguage)

void setPreSelectedID (String $id)

void setShowDeactivated (boolean $showDeactivated)

void setShowPreselectedIfDeactivated (boolean $show)

void setSortAlphabetical (boolean $sortAlphabetical)

Methods

Constructor ModulSelect (line 68)

ModulSelect ModulSelect ()

setModulLanguage (line 106)

Sets the language the Moduls information will be shown with.

Default is the User environment language _ULC_.

void setModulLanguage (String $modulLanguage)

String $modulLanguage: modulLanguage the Locale to use

setPreSelectedID (line 79)

Sets the ID of the Modul that should be preselected.

If this Modul is deactivated, it will be rendered nevertheless. This behaviour can be changed by calling setShowPreselectedIfDeactivated($show).

void setPreSelectedID (String $id)

String $id: id the Modul ID

setShowDeactivated (line 97)

Sets whether deactivated Moduls are rendered or not.

Default is FALSE.

void setShowDeactivated (boolean $showDeactivated)

boolean $showDeactivated: showDeactivated whether deactivated Moduls will be rendered

setShowPreselectedIfDeactivated (line 116)

Sets whether the Preselected Modul will be rendered if it is deactivated or not.

Default is TRUE. Set FALSE if you do not want to display the preselected and deactivated Modul.

void setShowPreselectedIfDeactivated (boolean $show)

boolean $show: show whether deactivated and preselected Modul will be rendered

setSortAlphabetical (line 88)

Sets if the list will be sorted alphabetical.

Default id TRUE.

void setSortAlphabetical (boolean $sortAlphabetical)

boolean $sortAlphabetical: sortAlphabetical if the list will be sorted or not

Inherited Methods

Inherited From Select

Select::Select()
Select::addOption()
Select::addOptionTags()
Select::getOptions()
Select::setIsMultiple()
Select::setOnChange()
Select::setSize()

Inherited From HtmlElement

HtmlElement::HtmlElement()
HtmlElement::addChildElement()
HtmlElement::getChildElements()
HtmlElement::getClass()
HtmlElement::getHtml()
HtmlElement::getID()
HtmlElement::getName()
HtmlElement::getTagAttribute()
HtmlElement::isSimpleTag()
HtmlElement::setClass()
HtmlElement::setID()
HtmlElement::setIsSimpleTag()
HtmlElement::setName()
HtmlElement::setTagAttribute()
HtmlElement::setTagName()