org.apache.jetspeed.portal
Interface PortletSet

All Superinterfaces:

Portlet, java.io.Serializable

All Known Subinterfaces:

PortletControl

All Known Implementing Classes:

AbstractPortletControl, BasePortletSet

public interface PortletSet

extends Portlet

The PortletSet is basically a wrapper around an array of portlets. It provides runtime context for a set of portlets. A portlet can get its current set by calling via its PortletConfig

Version:

$Id: PortletSet.java,v 1.27 2005/03/21 18:21:41 sgala Exp $

Author:

Raphaël Luta, Kevin A. Burton

Nested Class Summary

static interface

PortletSet.Constraints The PortletSetConstraints is used to associate layout constraints with a Portlet within a Set.

Field Summary

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

PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL

Method Summary

void	addPortlet(Portlet portlet) Add a portlet to this set.It updates its config to modify the current set
void	addPortlet(Portlet portlet, int position) Add a portlet to this set.It updates its config to modify the current set
void	addPortlet(Portlet portlet, PortletSet.Constraints constraints) Add a portlet to this set.It updates its config to modify the current set
void	addPortlet(Portlet portlet, PortletSet.Constraints constraints, int position) Add a portlet to this set.It updates its config to modify the current set
PortletController	getController() Return the current controller for this set
Portlet	getPortletAt(int pos) Returns the Portlet at position pos
Portlet	getPortletByID(java.lang.String id) Returns the Portlet with the given id
Portlet	getPortletByName(java.lang.String name) Returns the Portlet with the given name
java.util.Enumeration	getPortlets() Returns the portlet set as an Enumeration
void	setController(PortletController controller) Set the controller for this set
int	size() Returns the number of portlets currently stored in this set
Portlet[]	toArray() Returns the portlet set as an array.

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

getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getContent, getCreationTime, getDescription, getDescription, getID, getImage, getInstance, getName, getPortletConfig, getTitle, getTitle, init, isShowTitleBar, providesCustomization, setAttribute, setCreationTime, setDescription, setID, setImage, setName, setPortletConfig, setTitle, setTitle, supportsType

Method Detail

getController

public PortletController getController()

Return the current controller for this set

setController

public void setController(PortletController controller)

Set the controller for this set

size

public int size()

Returns the number of portlets currently stored in this set

toArray

public Portlet[] toArray()

Returns the portlet set as an array.

getPortletAt

public Portlet getPortletAt(int pos)

Returns the Portlet at position pos

getPortletByID

public Portlet getPortletByID(java.lang.String id)

Returns the Portlet with the given id

getPortletByName

public Portlet getPortletByName(java.lang.String name)

Returns the Portlet with the given name

getPortlets

public java.util.Enumeration getPortlets()

Returns the portlet set as an Enumeration

addPortlet

public void addPortlet(Portlet portlet)

Add a portlet to this set.It updates its config to modify the current set

addPortlet

public void addPortlet(Portlet portlet,
                       int position)

Add a portlet to this set.It updates its config to modify the current set

addPortlet

public void addPortlet(Portlet portlet,
                       PortletSet.Constraints constraints)

Add a portlet to this set.It updates its config to modify the current set

addPortlet

public void addPortlet(Portlet portlet,
                       PortletSet.Constraints constraints,
                       int position)

Add a portlet to this set.It updates its config to modify the current set