Package jakarta.portlet

Interface MutableRenderState

All Superinterfaces:

Mutable, RenderState

All Known Subinterfaces:

ActionResponse, ActionURL, EventResponse, PortletURL, RenderURL, StateAwareResponse

All Known Implementing Classes:

ActionResponseWrapper, ActionURLWrapper, EventResponseWrapper, MutableRenderStateWrapper, PortletURLWrapper, RenderURLWrapper, StateAwareResponseWrapper

public interface MutableRenderState
extends RenderState, Mutable

Provides read-write access to the render state. The render state is represented by the render parameters, portlet mode and window state.

The mutable render state is available through certain portlet response and portlet URL interfaces.

When changed on one of these interfaces, the modified render state becomes active according to the rules of the originating object. If the render state is modified on a response, it becomes active for subsequent portlet render phases. If the render state is modified on a URL, it becomes active when the URL containing the modified state is activated.

For example, the methods defined here can be used to set a new portlet mode and render parameters on a PortletURL object. When the portlet URL containing this modified render state is activated, the portlet will have the portlet mode and render parameter values set as they were applied to the portlet URL.

Since:

3.0

See Also:

RenderState, MutablePortletParameters

Method Summary

Modifier and Type	Method	Description
MutableRenderParameters	getRenderParameters()	Gets the mutable render parameters.
void	setPortletMode(PortletMode portletMode)	Sets the portlet mode of a portlet to the given portlet mode.
void	setWindowState(WindowState windowState)	Sets the window state of a portlet to the given window state.

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getWindowState

Method Detail

getRenderParameters

MutableRenderParameters getRenderParameters()

Gets the mutable render parameters.

Specified by:

getRenderParameters in interface RenderState

Returns:

a MutableRenderParameters object representing the private and public render parameters

See Also:

PortletParameters, RenderParameters, MutablePortletParameters, MutableRenderParameters

setPortletMode

void setPortletMode(PortletMode portletMode)
             throws PortletModeException

Sets the portlet mode of a portlet to the given portlet mode.

Possible values are the standard portlet modes and any custom portlet modes supported by the portal and the portlet. Portlets must declare in the deployment descriptor the portlet modes they support for each markup type. Standard portlet modes are:

• EDIT
• HELP
• VIEW

Not more than one portlet mode can be set. If more than one portlet mode is set, only the last one set is valid.

Note: The portlet may still be called in a different portlet mode in the next render call, depending on the portlet container / portal.

Parameters:

portletMode - the new portlet mode

Throws:

PortletModeException - if the portlet cannot switch to this mode, because the portal does not support this mode, the portlet has not declared in its deployment descriptor that it supports this mode for the current markup, or the current user is not allowed to switch to this mode. The PortletRequest.isPortletModeAllowed() method can be used to check if the portlet can set a given portlet mode.

IllegalStateException - if the method is invoked after sendRedirect has been called.

IllegalArgumentException - if the input parameter is null.

setWindowState

void setWindowState(WindowState windowState)
             throws WindowStateException

Sets the window state of a portlet to the given window state.

Possible values are the standard window states and any custom window states supported by the portal and the portlet. Standard window states are:

• MINIMIZED
• NORMAL
• MAXIMIZED

Not more than one window state can be set. If more than one window state is set, only the last one set is valid.

Parameters:

windowState - the new portlet window state

Throws:

WindowStateException - if the portlet cannot switch to this state, because the portal does not support this state, the portlet has not declared in its deployment descriptor that it supports this state, or the current user is not allowed to switch to this state. The PortletRequest.isWindowStateAllowed() method can be used to check if the portlet can set a given window state.

IllegalStateException - if the method is invoked after sendRedirect has been called.

IllegalArgumentException - if the input parameter is null.