org.olat.core.gui.control.generic.portal
Class AbstractPortlet

java.lang.Object
  org.olat.core.gui.control.generic.portal.AbstractPortlet

All Implemented Interfaces:

Disposable, Portlet

Direct Known Subclasses:

BookmarksPortlet, CalendarPortlet, DidYouKnowPortlet, EfficiencyStatementsPortlet, GroupsPortlet, IframePortlet, InfoMsgPortlet, InstitutionPortlet, LinksPortlet, MacartneyPortlet, NotesPortlet, NotificationsPortlet, QuickstartPortlet, RepositoryPortlet, ShibLoginPortlet, ZentralstellePortlet

public abstract class AbstractPortlet
extends java.lang.Object
implements Portlet

Description:
Abstract class that must be implemented by all portlets.

Initial Date: 08.07.2005

Author:

gnaegi

Constructor Summary

AbstractPortlet()

Method Summary

java.util.Map	getConfiguration()
java.lang.String	getName()
PortletToolController	getTools(UserRequest ureq, WindowControl wControl) This must be overriden if there are any tools to be exposed.
Translator	getTranslator()
void	setConfiguration(java.util.Map configuration)
void	setName(java.lang.String name) Bean method used by spring to load value from configuration
void	setTranslator(Translator translator)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.olat.core.gui.control.generic.portal.Portlet

createInstance, disposeRunComponent, getCssClass, getDescription, getInitialRunComponent, getTitle

Methods inherited from interface org.olat.core.gui.control.Disposable

dispose

Constructor Detail

AbstractPortlet

public AbstractPortlet()

Method Detail

getConfiguration

public java.util.Map getConfiguration()

Specified by:

getConfiguration in interface Portlet

Returns:

The configuration map

setConfiguration

public void setConfiguration(java.util.Map configuration)

Specified by:

setConfiguration in interface Portlet

Parameters:

configuration - The configuration map

getName

public java.lang.String getName()

Specified by:

getName in interface Portlet

Returns:

The unique name of this portlet.

See Also:

Portlet.getName()

setName

public void setName(java.lang.String name)

Bean method used by spring to load value from configuration

Specified by:

setName in interface Portlet

Parameters:

name - The unique name of this portlet

setTranslator

public void setTranslator(Translator translator)

Specified by:

setTranslator in interface Portlet

Parameters:

translator - to be used in this portlet

See Also:

Portlet.setTranslator(org.olat.core.gui.translator.Translator)

getTranslator

public Translator getTranslator()

Specified by:

getTranslator in interface Portlet

Returns:

translator used in this portlet

See Also:

Portlet.getTranslator()

getTools

public PortletToolController getTools(UserRequest ureq,
                                      WindowControl wControl)

This must be overriden if there are any tools to be exposed.

Specified by:

getTools in interface Portlet

Returns:

a tools controller for this Portlet. It could be null if the Portlet does't want to provide any additional tools. If you provide tools make sure have a working controller when you switch into the edit mode.

See Also:

org.olat.core.gui.control.generic.portal.Portlet#getTools()