Top Description Methods
javax.portlet

public Interface RenderState

Known Direct Subinterfaces
javax.portlet.BaseURL, javax.portlet.MutableRenderState, javax.portlet.PortletRequest
Known Direct Implementers
javax.portlet.filter.RenderStateWrapper

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 TypeMethod and Description
public PortletMode

Returns:

the portlet mode. If the portlet mode is not available, PortletMode#UNDEFINED is returned.
getPortletMode
()

Returns the current portlet mode of the portlet.
public RenderParameters

Returns:

an immutable RenderParameters object representing the private and public render parameters
getRenderParameters
()

Gets the render parameters.
public WindowState

Returns:

the window state. If the window state is not available, WindowState#UNDEFINED is returned.
getWindowState
()

Returns the current window state of the portlet.

Method Detail

getPortletModeback to summary
public PortletMode getPortletMode()

Returns the current portlet mode of the portlet.
Returns:PortletMode

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

See Also
PortletMode
getRenderParametersback to summary
public RenderParameters getRenderParameters()

Gets the render parameters.
Returns:RenderParameters

an immutable RenderParameters object representing the private and public render parameters

See Also
PortletParameters, RenderParameters
getWindowStateback to summary
public WindowState getWindowState()

Returns the current window state of the portlet.
Returns:WindowState

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

See Also
WindowState