Package jakarta.portlet

Interface RenderState

All Known Subinterfaces:

ActionRequest, ActionResponse, ActionURL, BaseURL, ClientDataRequest, EventRequest, EventResponse, HeaderRequest, MutableRenderState, PortletRequest, PortletURL, RenderRequest, RenderURL, ResourceRequest, ResourceURL, StateAwareResponse

All Known Implementing Classes:

ActionRequestWrapper, ActionResponseWrapper, ActionURLWrapper, BaseURLWrapper, ClientDataRequestWrapper, EventRequestWrapper, EventResponseWrapper, HeaderRequestWrapper, MutableRenderStateWrapper, PortletRequestWrapper, PortletURLWrapper, RenderRequestWrapper, RenderStateWrapper, RenderURLWrapper, ResourceRequestWrapper, ResourceURLWrapper, StateAwareResponseWrapper

public interface RenderState

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

During render or resource request processing, the render state is constant and can be accessed through methods provided by this interface.

During portlet action or event request ptocessing, the render state can be modified for subsequent render phase processing. During the portlet render or resource phases, URLs containing modified render state can be created. When a portlet URL containing modified render state is triggered, the corresponding portlet phase is executed with the modified render state.

The render state is modified through MutableRenderState.

Since:

3.0

See Also:

MutableRenderState, PortletParameters

Method Summary

Modifier and Type	Method	Description
PortletMode	getPortletMode()	Returns the current portlet mode of the portlet.
RenderParameters	getRenderParameters()	Gets the render parameters.
WindowState	getWindowState()	Returns the current window state of the portlet.

Method Detail

getRenderParameters

RenderParameters getRenderParameters()

Gets the render parameters.

Returns:

an immutable RenderParameters object representing the private and public render parameters

See Also:

PortletParameters, RenderParameters

getPortletMode

PortletMode getPortletMode()

Returns the current portlet mode of the portlet.

Returns:

the portlet mode. If the portlet mode is not available, PortletMode.UNDEFINED is returned.

See Also:

PortletMode

getWindowState

WindowState getWindowState()

Returns the current window state of the portlet.

Returns:

the window state. If the window state is not available, WindowState.UNDEFINED is returned.

See Also:

WindowState