org.olat.core.gui.control.navigation
Interface NavElement

All Known Implementing Classes:

DefaultNavElement

public interface NavElement

Description:
TODO: Felix Jost Class Description for TopNavElem

Initial Date: 12.07.2005

Author:

Felix Jost

Method Summary

java.lang.Character	getAccessKey()
java.lang.String	getDescription() [used by velocity]
java.lang.String	getIconCSSClass() [used by velocity]
java.lang.String	getTitle() [used by velocity]
void	setAccessKey(java.lang.Character accessKey) Define an access key if this site is an important site for the user.

Method Detail

getTitle

java.lang.String getTitle()

[used by velocity]

Returns:

getDescription

java.lang.String getDescription()

[used by velocity]

Returns:

getIconCSSClass

java.lang.String getIconCSSClass()

[used by velocity]

Returns:

getAccessKey

java.lang.Character getAccessKey()

Returns:

The access key as string or NULL if no access key is used.

setAccessKey

void setAccessKey(java.lang.Character accessKey)

Define an access key if this site is an important site for the user. Be very carefull and see first which access keys are already used by the application.

• Don't use 0-1, those numbers are reserved for the dynamic sites
• Don't use n, o, m, c, t, d, b; those are used for the general navigation
• Check what the other sites already use

Parameters:

accessKey - One character or NULL