org.apache.jetspeed.portal.portlets
Class ContainerTestPortlet

java.lang.Object
  org.apache.jetspeed.portal.portlets.ContainerTestPortlet

All Implemented Interfaces:

Portlet, java.io.Serializable

public class ContainerTestPortlet

extends java.lang.Object

implements Portlet

Aggregate Portlet aggregates the content of other portlets. This portlet is a test for an alternate aggregation algorithm UNDER CONSTRUCTION

Version:

$Id: ContainerTestPortlet.java,v 1.10 2005/04/02 17:31:08 jford Exp $

Author:

David Sean Taylor

See Also:

Serialized Form

Field Summary

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

PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL

Constructor Summary

ContainerTestPortlet()

Method Summary

boolean	getAllowEdit(org.apache.turbine.util.RunData rundata) Return true if this portlet is allowed to be edited in the rundata's context .
boolean	getAllowMaximize(org.apache.turbine.util.RunData rundata) Return true if this portlets is allowed to be maximized.
boolean	getAllowView(org.apache.turbine.util.RunData rundata) Is the portled viewable.
java.lang.String	getAttribute(java.lang.String attrName, java.lang.String attrDefValue, org.apache.turbine.util.RunData rundata) Retrieve a portlet attribute from persistent storage
org.apache.ecs.ConcreteElement	getContent(org.apache.turbine.util.RunData rundata) Returns an HTML representation of this portlet.
long	getCreationTime() Get the creation time for this Portlet
java.lang.String	getDescription() Returns a description of this portlet.
java.lang.String	getDescription(java.lang.String instanceDescription) Provide a Description within PML if the user has specified one.
java.lang.String	getID() Retrieve a unique portlet id
java.lang.String	getImage() Getter for property image.
java.lang.String	getImage(java.lang.String instanceImage) Getter for property image.
PortletInstance	getInstance(org.apache.turbine.util.RunData rundata) Gets the portlet instance associated with this portlet.
java.lang.String	getName() Returns a name for this portlet.
PortletConfig	getPortletConfig() Get the config of this servlet.
java.lang.String	getTitle() Allows a Portlet to define its title.
java.lang.String	getTitle(java.lang.String instanceTitle) t a title for this instance of the portlet.
void	init() All initialization should be performed here.
boolean	isShowTitleBar(org.apache.turbine.util.RunData rundata) Returns TRUE if the title bar in should be displayed.
boolean	providesCustomization()
void	setAttribute(java.lang.String attrName, java.lang.String attrValue, org.apache.turbine.util.RunData rundata) Stores a portlet attribute in persistent storage
void	setCreationTime(long creationTime) Set the creation time for this Portlet
void	setDescription(java.lang.String description) Set the description for this Portlet
void	setID(java.lang.String id)
void	setImage(java.lang.String image) Setter for property image.
void	setName(java.lang.String name) Sets the name on this Portlet.
void	setPortletConfig(PortletConfig pc) Set's the configuration of this servlet.
void	setTitle(java.lang.String title) Set the title for this Portlet
void	setTitle(java.lang.String title, org.apache.turbine.util.RunData runData)
boolean	supportsType(MimeType mimeType) Returns true portlet is able to output content for given mimetype

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerTestPortlet

public ContainerTestPortlet()

Method Detail

getName

public java.lang.String getName()

Returns a name for this portlet. This is used by PSML to identify a Portlet within the PortletRegistry

Specified by:

getName in interface Portlet

setName

public void setName(java.lang.String name)

Sets the name on this Portlet.

Specified by:

setName in interface Portlet

See Also:

getName()

getTitle

public java.lang.String getTitle()

Allows a Portlet to define its title. This can be used by a PortletControl for rendering its content.

In order to define a default title you should not override this but should call setTitle() within your init() method

This should return null if not specified.

Specified by:

getTitle in interface Portlet

getTitle

public java.lang.String getTitle(java.lang.String instanceTitle)

t a title for this instance of the portlet. This method is called from the context variable portlet_instance and from PortletInstance If you wish to append to the title, then you code should look like getTitle( String instanceTitle) { return super.getTitle( instanceTitle) + " - Appened title text"; }

Specified by:

getTitle in interface Portlet

Parameters:

instanceTitle - Title from PSML

setTitle

public void setTitle(java.lang.String title)

Set the title for this Portlet

Specified by:

setTitle in interface Portlet

getDescription

public java.lang.String getDescription()

Returns a description of this portlet. This should describe what the capabilities of the portlet and how it can help the user.

In order to define a default title you should not override (in the AbstractPortlet implementation) this but should call setDescription() within your init() method

This should return null if not specified.

Specified by:

getDescription in interface Portlet

getDescription

public java.lang.String getDescription(java.lang.String instanceDescription)

Provide a Description within PML if the user has specified one.

Specified by:

getDescription in interface Portlet

Parameters:

instanceDescription - Description from PSML

Returns:

a null entry if the user hasn't defined anything

setDescription

public void setDescription(java.lang.String description)

Set the description for this Portlet

Specified by:

setDescription in interface Portlet

getImage

public java.lang.String getImage()

Getter for property image.

Returns:

Name of portlet image, icon. The name is expected to be in the form of a URL.

getImage

public java.lang.String getImage(java.lang.String instanceImage)

Getter for property image.

Specified by:

getImage in interface Portlet

Returns:

Name of portlet image, icon. The name is expected to be in the form of a URL.

setImage

public void setImage(java.lang.String image)

Description copied from interface: Portlet

Setter for property image.

Specified by:

setImage in interface Portlet

getContent

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

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

init

public void init()
          throws PortletException

All initialization should be performed here. If your Portlet wants to do any work it should be done here. You are not guaranteed that any particular order of method call will happen just that init() will happen first. Therefore if you have to calculate things like a title, a description, etc it should happen here.

Specified by:

init in interface Portlet

Throws:

PortletException

setPortletConfig

public void setPortletConfig(PortletConfig pc)

Set's the configuration of this servlet.

Specified by:

setPortletConfig in interface Portlet

getPortletConfig

public PortletConfig getPortletConfig()

Get the config of this servlet.

Specified by:

getPortletConfig in interface Portlet

getAllowEdit

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

Return true if this portlet is allowed to be edited in the rundata's context .

Note: PortletControl implementations should pay attention to this so that they don't allow this option if it returns false.

Specified by:

getAllowEdit in interface Portlet

getAllowMaximize

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

Return true if this portlets is allowed to be maximized.

Note: PortletControl implementations should pay attention to this so that they don't allow this option if it returns false.

Specified by:

getAllowMaximize in interface Portlet

getCreationTime

public long getCreationTime()

Get the creation time for this Portlet

Specified by:

getCreationTime in interface Portlet

setCreationTime

public void setCreationTime(long creationTime)

Set the creation time for this Portlet

Specified by:

setCreationTime in interface Portlet

supportsType

public boolean supportsType(MimeType mimeType)

Returns true portlet is able to output content for given mimetype

Specified by:

supportsType in interface Portlet

getAttribute

public java.lang.String getAttribute(java.lang.String attrName,
                                     java.lang.String attrDefValue,
                                     org.apache.turbine.util.RunData rundata)

Retrieve a portlet attribute from persistent storage

Specified by:

getAttribute in interface Portlet

Parameters:

attrName - The attribute to retrieve

attrDefValue - The value if the attr doesn't exists

rundata - The RunData object for the current request

Returns:

The attribute value

setAttribute

public void setAttribute(java.lang.String attrName,
                         java.lang.String attrValue,
                         org.apache.turbine.util.RunData rundata)

Stores a portlet attribute in persistent storage

Specified by:

setAttribute in interface Portlet

Parameters:

attrName - The attribute to retrieve

rundata - The RunData object for the current request

getInstance

public PortletInstance getInstance(org.apache.turbine.util.RunData rundata)

Gets the portlet instance associated with this portlet.

Specified by:

getInstance in interface Portlet

Returns:

PortletInstance

getID

public java.lang.String getID()

Retrieve a unique portlet id

Specified by:

getID in interface Portlet

setID

public void setID(java.lang.String id)

Specified by:

setID in interface Portlet

providesCustomization

public boolean providesCustomization()

Specified by:

providesCustomization in interface Portlet

Returns:

true if the portlet does its own customization

isShowTitleBar

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

Returns TRUE if the title bar in should be displayed. The title bar includes the portlet title and action buttons. This

Specified by:

isShowTitleBar in interface Portlet

Parameters:

rundata - The RunData object for the current request

getAllowView

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

Is the portled viewable.

Specified by:

getAllowView in interface Portlet

Parameters:

rundata - The RunData object for the current request

Returns:

true Viewing is allow false Viewing is NOT alowed Override this method to control your own View behavior

setTitle

public void setTitle(java.lang.String title,
                     org.apache.turbine.util.RunData runData)

Specified by:

setTitle in interface Portlet

See Also:

Portlet.setTitle(java.lang.String, org.apache.turbine.util.RunData)