org.olat.core.gui.control.generic.portal
Interface Portlet

All Superinterfaces:

Disposable

All Known Implementing Classes:

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

public interface Portlet
extends Disposable

Description:
TODO: guido Class Description for Portlet

Method Summary

Portlet	createInstance(WindowControl wControl, UserRequest ureq, java.util.Map portletConfig) Factory method to create a portlet of the current type using the given configuration
void	disposeRunComponent() Dispose the run component and all its resources without disposing the portlet.
java.util.Map	getConfiguration()
java.lang.String	getCssClass()
java.lang.String	getDescription()
Component	getInitialRunComponent(WindowControl wControl, UserRequest ureq) Get the run component of this portlet
java.lang.String	getName()
java.lang.String	getTitle()
PortletToolController	getTools(UserRequest ureq, WindowControl wControl)
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 interface org.olat.core.gui.control.Disposable

dispose

Method Detail

getTitle

java.lang.String getTitle()

Returns:

The (translated) title for the portlet

getDescription

java.lang.String getDescription()

Returns:

The (translated) description for the portlet

createInstance

Portlet createInstance(WindowControl wControl,
                       UserRequest ureq,
                       java.util.Map portletConfig)

Factory method to create a portlet of the current type using the given configuration

Parameters:

wControl -

ureq -

configuration -

Returns:

AbstractPortlet

getInitialRunComponent

Component getInitialRunComponent(WindowControl wControl,
                                 UserRequest ureq)

Get the run component of this portlet

Parameters:

wControl -

ureq -

Returns:

Component

disposeRunComponent

void disposeRunComponent()

Dispose the run component and all its resources without disposing the portlet.

getConfiguration

java.util.Map getConfiguration()

Returns:

The configuration map

setConfiguration

void setConfiguration(java.util.Map configuration)

Parameters:

configuration - The configuration map

getName

java.lang.String getName()

Returns:

The unique name of this portlet.

setName

void setName(java.lang.String name)

Bean method used by spring to load value from configuration

Parameters:

name - The unique name of this portlet

getCssClass

java.lang.String getCssClass()

Returns:

String name of wrapper css class that provides the portlet icon and other styles

setTranslator

void setTranslator(Translator translator)

Parameters:

translator - to be used in this portlet

getTranslator

Translator getTranslator()

Returns:

translator used in this portlet

getTools

PortletToolController getTools(UserRequest ureq,
                               WindowControl wControl)

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.