org.apache.jetspeed.portal.portlets
Class TurbineScreenPortlet

java.lang.Object
  org.apache.jetspeed.portal.portlets.AbstractPortlet
      org.apache.jetspeed.portal.portlets.TurbineScreenPortlet

All Implemented Interfaces:

Cacheable, Portlet, PortletState, org.apache.turbine.services.cache.Refreshable, java.io.Serializable

public class TurbineScreenPortlet

extends AbstractPortlet

This portlet will attempt to render the Turbine Screen within a portlet. Parameters are passed to the screen via portlet config information:

 
     portlets.TurbineScreenPortlet
 

 
     
     
     
          
          Place description here
     
 

 

In the above example, the parameter MYPARAM=MYVALUE will be set in the rundata that calls the screen.

Version:

$Id: TurbineScreenPortlet.java,v 1.13 2004/02/23 04:03:34 jford Exp $

Author:

Jeff Breckke

See Also:

Serialized Form

Field Summary

static java.lang.String	BGCOLOR
static java.lang.String	CLASSES
static java.lang.String	SCREEN

Fields inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet

content

Fields inherited from interface org.apache.jetspeed.portal.Portlet

PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL

Constructor Summary

TurbineScreenPortlet()

Method Summary

boolean	getAllowEdit(org.apache.turbine.util.RunData rundata) Is the portled editable/customizeable.
boolean	getAllowMaximize(org.apache.turbine.util.RunData rundata) Can this portlet be maximized
org.apache.ecs.ConcreteElement	getContent(org.apache.turbine.util.RunData rundata) Returns an HTML representation of this portlet.
void	init() By default don't provide any initialization

Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet

allowClose, allowCustomize, allowInfo, allowMaximize, allowMinimize, allowPrintFriendly, allowView, clearContent, getAllowView, getAttribute, getContent, getContent, getCreationTime, getDescription, getDescription, getExpirationMillis, getExpire, getHandle, getHandle, getID, getImage, getImage, getInstance, getName, getPortletConfig, getTitle, getTitle, isCacheable, isClosed, isMinimized, isShowTitleBar, providesCustomization, refresh, setAttribute, setCacheable, setCachedObject, setClosed, setContent, setContent, setContent, setCreationTime, setDescription, setExpirationMillis, setHandle, setID, setImage, setMinimized, setName, setPortletConfig, setTitle, setTitle, supportsType

Methods inherited from class java.lang.Object

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

Field Detail

BGCOLOR

public static final java.lang.String BGCOLOR

See Also:

Constant Field Values

CLASSES

public static final java.lang.String CLASSES

See Also:

Constant Field Values

SCREEN

public static final java.lang.String SCREEN

See Also:

Constant Field Values

Constructor Detail

TurbineScreenPortlet

public TurbineScreenPortlet()

Method Detail

getContent

public org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData rundata)

Description copied from interface: Portlet

Returns an HTML representation of this portlet. Usually a Portlet would initialized itself within init() and then when getContent is called it would return its presentation.

Specified by:

getContent in interface Portlet

Overrides:

getContent in class AbstractPortlet

Parameters:

rundata - The RunData object for the current request

init

public void init()
          throws PortletException

Description copied from class: AbstractPortlet

By default don't provide any initialization

Specified by:

init in interface Portlet

Overrides:

init in class AbstractPortlet

Throws:

PortletException

getAllowEdit

public boolean getAllowEdit(org.apache.turbine.util.RunData rundata)

Description copied from class: AbstractPortlet

Is the portled editable/customizeable.

Specified by:

getAllowEdit in interface Portlet

Overrides:

getAllowEdit in class AbstractPortlet

Parameters:

rundata - The RunData object for the current request

Returns:

true Editing is allow false Editing is NOT alowed

getAllowMaximize

public boolean getAllowMaximize(org.apache.turbine.util.RunData rundata)

Description copied from class: AbstractPortlet

Can this portlet be maximized

Specified by:

getAllowMaximize in interface Portlet

Overrides:

getAllowMaximize in class AbstractPortlet

Parameters:

rundata - The RunData object for the current request

Returns:

true Portlet can be maximized
false Portlet can NOT be maximized