org.olat.core.commons.portlets.iframe
Class IframePortlet

java.lang.Object
  org.olat.core.gui.control.generic.portal.AbstractPortlet
      org.olat.core.commons.portlets.iframe.IframePortlet

All Implemented Interfaces:

Disposable, Portlet

public class IframePortlet
extends AbstractPortlet

Description:
Iframe portlet to embedd content from another server in the portal. The configuration must have an element uri and height. Title and description are optional elements. They use the locale code for each language (eg. title_de, description_en)

Initial Date: 08.07.2005

Author:

gnaegi

Constructor Summary

IframePortlet()

Method Summary

Portlet	createInstance(WindowControl wControl, UserRequest ureq, java.util.Map configuration) Factory method to create a portlet of the current type using the given configuration
void	dispose() disposes the disposable
void	disposeRunComponent() Dispose the run component and all its resources without disposing the portlet.
java.lang.String	getCssClass()
java.lang.String	getDescription()
Component	getInitialRunComponent(WindowControl wControl, UserRequest ureq) Get the run component of this portlet
java.lang.String	getTitle()

Methods inherited from class org.olat.core.gui.control.generic.portal.AbstractPortlet

getConfiguration, getName, getTools, getTranslator, setConfiguration, setName, setTranslator

Methods inherited from class java.lang.Object

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

Constructor Detail

IframePortlet

public IframePortlet()

Method Detail

getTitle

public java.lang.String getTitle()

Returns:

The (translated) title for the portlet

See Also:

org.olat.gui.control.generic.portal.Portlet#getTitle()

getDescription

public java.lang.String getDescription()

Returns:

The (translated) description for the portlet

See Also:

org.olat.gui.control.generic.portal.Portlet#getDescription()

createInstance

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

Description copied from interface: Portlet

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

Returns:

AbstractPortlet

See Also:

org.olat.gui.control.generic.portal.AbstractPortlet#createInstance(org.olat.core.gui.control.WindowControl, org.olat.core.gui.UserRequest, java.util.Map)

getInitialRunComponent

public Component getInitialRunComponent(WindowControl wControl,
                                        UserRequest ureq)

Description copied from interface: Portlet

Get the run component of this portlet

Returns:

Component

See Also:

org.olat.gui.control.generic.portal.Portlet#getInitialRunComponent(org.olat.core.gui.control.WindowControl, org.olat.core.gui.UserRequest)

dispose

public void dispose()

Description copied from interface: Disposable

disposes the disposable

See Also:

org.olat.core.gui.control.Disposable#dispose(boolean)

getCssClass

public java.lang.String getCssClass()

Returns:

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

See Also:

org.olat.gui.control.generic.portal.Portlet#getCssClass()

disposeRunComponent

public void disposeRunComponent()

Description copied from interface: Portlet

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

See Also:

org.olat.gui.control.generic.portal.Portlet#disposeRunComponent(boolean)