org.apache.jetspeed.portal
Interface PortletState

All Known Implementing Classes:

AbstractPortlet, BasePortletSet, StatefulPortletWrapper

public interface PortletState

This interface allows implementing portlets to modify the behavior of their PortletControl manager by specifically allowing or refusing window manipulation actions. If the given PortletControl implements these actions, it must use this information.

Author:

Raphaël Luta, Roberto Carrasco, Mark Orciuch

Method Summary

boolean	allowClose(org.apache.turbine.util.RunData rundata) Returns true if the portlet allows the use to remove it from its portlat page
boolean	allowCustomize(org.apache.turbine.util.RunData rundata) Returns true if the portlet supports customization of its options
boolean	allowInfo(org.apache.turbine.util.RunData rundata) Returns true if the portlet allows the manager to link to a information page about this portlet
boolean	allowMaximize(org.apache.turbine.util.RunData rundata) Returns true if the portlet allows the user to maximize it, ie use all the display space allowed to portlets in the given pane
boolean	allowMinimize(org.apache.turbine.util.RunData rundata) Returns true if the portlet allows the user to minimize it.
boolean	allowPrintFriendly(org.apache.turbine.util.RunData rundata) Returns true if the portlet allows the user to display it in print friendly format.
boolean	isClosed(org.apache.turbine.util.RunData data) Returns true if this portlet is currently closed
boolean	isMinimized(org.apache.turbine.util.RunData data) Returns true if this portlet is currently minimized
void	setClosed(boolean closed, org.apache.turbine.util.RunData data) Toggles the portlet state between closed and normal
void	setMinimized(boolean minimized, org.apache.turbine.util.RunData data) Toggles the portlet state between minimized and normal

Method Detail

allowClose

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

Returns true if the portlet allows the use to remove it from its portlat page

Parameters:

rundata - the RunData object for the current request

isClosed

public boolean isClosed(org.apache.turbine.util.RunData data)

Returns true if this portlet is currently closed

setClosed

public void setClosed(boolean closed,
                      org.apache.turbine.util.RunData data)

Toggles the portlet state between closed and normal

Parameters:

data - the RunData for this request

allowInfo

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

Returns true if the portlet allows the manager to link to a information page about this portlet

Parameters:

rundata - the RunData object for the current request

allowCustomize

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

Returns true if the portlet supports customization of its options

Parameters:

rundata - the RunData object for the current request

allowMaximize

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

Returns true if the portlet allows the user to maximize it, ie use all the display space allowed to portlets in the given pane

Parameters:

rundata - the RunData object for the current request

allowMinimize

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

Returns true if the portlet allows the user to minimize it. The portlet content is not displayed when minimized

Parameters:

rundata - the RunData object for the current request

isMinimized

public boolean isMinimized(org.apache.turbine.util.RunData data)

Returns true if this portlet is currently minimized

setMinimized

public void setMinimized(boolean minimized,
                         org.apache.turbine.util.RunData data)

Toggles the portlet state between minimized and normal

Parameters:

minimized - the new portlet state

data - the RunData for this request

allowPrintFriendly

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

Returns true if the portlet allows the user to display it in print friendly format.

Parameters:

rundata - the RunData object for the current request