[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: ModulSelect

Source Location: /CORE/system/classes/util/formular/ModulSelect.php

Class ModulSelect

Class Overview

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()

Located in /CORE/system/classes/util/formular/ModulSelect.php [line 44]

HtmlElement
   |
   --Select
      |
      --ModulSelect

Author(s):

Kevin Papst

Information Tags:

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

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Select

Select::Select()

Select::addOption()

Select::addOptionTags()

Adds a bunch of Option Tags to the Select Box by iterating above the passed key-value mapped Array.

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::setAllowEmptyAttributes()

HtmlElement::setClass()

HtmlElement::setID()

HtmlElement::setIsSimpleTag()

HtmlElement::setName()

HtmlElement::setTagAttribute()

HtmlElement::setTagName()

[ Top ]

Method Summary

ModulSelect	ModulSelect()
void	setModulLanguage()	Sets the language the Moduls information will be shown with.
void	setPreSelectedID()	Sets the ID of the Modul that should be preselected.
void	setShowDeactivated()	Sets whether deactivated Moduls are rendered or not.
void	setShowPreselectedIfDeactivated()	Sets whether the Preselected Modul will be rendered if it is deactivated or not.
void	setSortAlphabetical()	Sets if the list will be sorted alphabetical.

[ Top ]

Methods

Constructor ModulSelect [line 68]

ModulSelect ModulSelect(
)

[ Top ]

setModulLanguage [line 106]

void setModulLanguage(
String
$modulLanguage 
)

Sets the language the Moduls information will be shown with.

Default is the User environment language _ULC_.

Parameters:

String

$modulLanguage:

modulLanguage the Locale to use

[ Top ]

setPreSelectedID [line 79]

void setPreSelectedID(
String
$id 
)

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).

Parameters:

String

$id:

id the Modul ID

[ Top ]

setShowDeactivated [line 97]

void setShowDeactivated(
boolean
$showDeactivated 
)

Sets whether deactivated Moduls are rendered or not.

Default is FALSE.

Parameters:

boolean

$showDeactivated:

showDeactivated whether deactivated Moduls will be rendered

[ Top ]

setShowPreselectedIfDeactivated [line 116]

void setShowPreselectedIfDeactivated(
boolean
$show 
)

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.

Parameters:

boolean

$show:

show whether deactivated and preselected Modul will be rendered

[ Top ]

setSortAlphabetical [line 88]

void setSortAlphabetical(
boolean
$sortAlphabetical 
)

Sets if the list will be sorted alphabetical.

Default id TRUE.

Parameters:

boolean

$sortAlphabetical:

sortAlphabetical if the list will be sorted or not

[ Top ]