org.apache.wsrp4j.consumer.app
Interface Page

All Known Implementing Classes:

PageImpl

public interface Page

Interface defines a page with portlets.

Version:

$Id: Page.java,v 1.5 2005/08/10 14:42:36 cziegeler Exp $

Author:

Stephan Laertz

Method Summary

void	addPortlet(PortletKey portletKey) Add an portlet to the page.
void	addPortlet(PortletKey portletKey, java.lang.String instanceKey) Add an portlet to the page and set the ID of this portlet on the page to the given value.
java.lang.String	getMaximizedPortletInstanceKey() Get the instance key of the portlet on this page which is in maximized window state or null if no portlet is in that state.
java.lang.String	getPageID() Get the ID of this page
java.util.Iterator	getPortletInstanceKeys() Get the keys of all portlet instances on the page.
PortletKey	getPortletKey(java.lang.String portletInstanceKey) Get the portlet key to the given portlet instance key.
java.util.Map	getPortlets() Get map with portlet instance keys map to portlet keys with all portlet instances on this page.
java.lang.String	getTitle() Get the title of the page
void	removePortlet(java.lang.String portletInstanceKey) Remove an portlet instance from the page
void	setMaximizedPortletInstanceKey(java.lang.String portletInstanceKey) Set the portlet which is currently in maximized window state
void	setPageID(java.lang.String pageID) Set the page ID
void	setPortlets(java.util.Map map) Set the portlets which should appear on the page.
void	setTitle(java.lang.String title) Set the title of the page

Method Detail

getPortletInstanceKeys

public java.util.Iterator getPortletInstanceKeys()

Get the keys of all portlet instances on the page.

Returns:

Iterator with the instance keys of all portlets on the page

getPortletKey

public PortletKey getPortletKey(java.lang.String portletInstanceKey)

Get the portlet key to the given portlet instance key.

Parameters:

portletInstanceKey - Key of a portlet instance on the page

Returns:

The portlet key

getPageID

public java.lang.String getPageID()

Get the ID of this page

Returns:

The page ID

addPortlet

public void addPortlet(PortletKey portletKey)

Add an portlet to the page. The ID of this portlet on the page is generated.

Parameters:

portletKey - The portlet key

addPortlet

public void addPortlet(PortletKey portletKey,
                       java.lang.String instanceKey)

Add an portlet to the page and set the ID of this portlet on the page to the given value. If any other portlet exists on the page with the same ID the old portlet is removed.

Parameters:

portletKey - The portlet key

instanceKey - ID of the portlet on the page

removePortlet

public void removePortlet(java.lang.String portletInstanceKey)

Remove an portlet instance from the page

Parameters:

portletInstanceKey - The instance key of the portlet instance to be removed

setPageID

public void setPageID(java.lang.String pageID)

Set the page ID

Parameters:

pageID - ID of this page

getTitle

public java.lang.String getTitle()

Get the title of the page

Returns:

Title of this page

setTitle

public void setTitle(java.lang.String title)

Set the title of the page

Parameters:

title - Page title

getMaximizedPortletInstanceKey

public java.lang.String getMaximizedPortletInstanceKey()

Get the instance key of the portlet on this page which is in maximized window state or null if no portlet is in that state.

Returns:

portlet instance key of the portlet or null if no portlet is in max window state

setMaximizedPortletInstanceKey

public void setMaximizedPortletInstanceKey(java.lang.String portletInstanceKey)

Set the portlet which is currently in maximized window state

Parameters:

portletInstanceKey - instance ID

setPortlets

public void setPortlets(java.util.Map map)

Set the portlets which should appear on the page. The map must contain mappings of portlet instance keys to portlet keys.

getPortlets

public java.util.Map getPortlets()

Get map with portlet instance keys map to portlet keys with all portlet instances on this page.