org.apache.jetspeed.portal
Interface PortletControl

All Superinterfaces:

Portlet, PortletSet, java.io.Serializable

All Known Implementing Classes:

AbstractPortletControl

public interface PortletControl

extends Portlet, PortletSet

The PortletControl acts both as a decoration around a Portlet or PortletSet and also as the window manager for the enclosed Portlet(Set). As such it controls the operation that may be performed on this portlet and whether the portlet content should be displayed or not. PortletControl also delegates all Portlet and PortletSet methods to its inner object and can thus be transparently cascaded or substituted to a simple portlet wherever in a PSML object tree.

Version:

$Id: PortletControl.java,v 1.25 2005/03/21 18:21:41 sgala Exp $

Author:

Raphaël Luta

Nested Class Summary

Nested classes inherited from class org.apache.jetspeed.portal.PortletSet

PortletSet.Constraints

Field Summary

static java.lang.String	BACKGROUND_COLOR
static java.lang.String	COLOR
static java.lang.String	TITLE_COLOR
static java.lang.String	WIDTH

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

PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL

Method Summary

java.lang.String	getBackgroundColor() Deprecated.
java.lang.String	getColor() Deprecated.
PortletControlConfig	getConfig()
Portlet	getPortlet() Retrieves the portlet managed by this control
java.lang.String	getTitleColor() Deprecated.
java.lang.String	getWidth() Deprecated.
void	init(Portlet portlet) Initializes the control and associates it with a portlet
void	setBackgroundColor(java.lang.String backgroundColor) Deprecated.
void	setColor(java.lang.String color) Deprecated.
void	setConfig(PortletControlConfig conf) Sets the PortletControl specific configuration
void	setPortlet(Portlet portlet) Sets the portlet to be managed by this control
void	setTitleColor(java.lang.String titleColor) Deprecated.
void	setWidth(int width) Deprecated.
void	setWidth(java.lang.String width) Deprecated.

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

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

addPortlet, addPortlet, addPortlet, addPortlet, getController, getPortletAt, getPortletByID, getPortletByName, getPortlets, setController, size, toArray

Field Detail

COLOR

public static final java.lang.String COLOR

See Also:

Constant Field Values

BACKGROUND_COLOR

public static final java.lang.String BACKGROUND_COLOR

See Also:

Constant Field Values

TITLE_COLOR

public static final java.lang.String TITLE_COLOR

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

See Also:

Constant Field Values

Method Detail

getConfig

public PortletControlConfig getConfig()

Returns:

the PortletControl specific configuration

setConfig

public void setConfig(PortletControlConfig conf)

Sets the PortletControl specific configuration

Parameters:

conf - the new PortletControl configuration

setPortlet

public void setPortlet(Portlet portlet)

Sets the portlet to be managed by this control

Parameters:

portlet - the new portlet to be managed by the control

getPortlet

public Portlet getPortlet()

Retrieves the portlet managed by this control

Returns:

the portlet object managed or null

init

public void init(Portlet portlet)

Initializes the control and associates it with a portlet

Parameters:

portlet - the portlet to be managed by this control

getColor

public java.lang.String getColor()

Deprecated.

Returns the color to use for displaying the portlet text This method is deprecated and is only useful for ECS based Control implementation

Returns:

the text color value in HTML format (#RRGGBB)

setColor

public void setColor(java.lang.String color)

Deprecated.

Sets the color to use for displaying the portlet text This method is deprecated and is only useful for ECS based Control implementation

Parameters:

color - the text color value in HTML format (#RRGGBB)

getBackgroundColor

public java.lang.String getBackgroundColor()

Deprecated.

Returns the color to use for displaying the portlet background This method is deprecated and is only useful for ECS based Control implementation

Returns:

the text color value in HTML format (#RRGGBB)

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

Deprecated.

Sets the color to use for displaying the portlet background This method is deprecated and is only useful for ECS based Control implementation

Parameters:

backgroundColor - the background color value in HTML format (#RRGGBB)

getTitleColor

public java.lang.String getTitleColor()

Deprecated.

Returns the color to use for displaying the portlet title This method is deprecated and is only useful for ECS based Control implementation

Returns:

the text color value in HTML format (#RRGGBB)

setTitleColor

public void setTitleColor(java.lang.String titleColor)

Deprecated.

Sets the color to use for displaying the portlet title This method is deprecated and is only useful for ECS based Control implementation

Parameters:

titleColor - the title color value in HTML format (#RRGGBB)

getWidth

public java.lang.String getWidth()

Deprecated.

Returns the width of the managed portlet relative to the size of portlet control. This method is deprecated and is only useful for ECS based Control implementation

Returns:

the size value. May be expressed in percentages (eg, "80%")

setWidth

public void setWidth(int width)

Deprecated.

Sets the width of the managed portlet relative to the size of portlet control. This method is deprecated and is only useful for ECS based Control implementation

Parameters:

width - the width of portlet. Must be a positive, non nul integer

setWidth

public void setWidth(java.lang.String width)

Deprecated.

Sets the width of the managed portlet relative to the size of portlet control. This method is deprecated and is only useful for ECS based Control implementation

Parameters:

width - the width of portlet. Must be parseable as a positive, non nul integer or a percentage