Top Description Fields Constructors Methods
javax.portlet.filter

public Class MutableRenderStateWrapper

extends RenderStateWrapper
implements MutableRenderState, Mutable
Class Inheritance
All Implemented Interfaces
javax.portlet.Mutable, javax.portlet.MutableRenderState, javax.portlet.RenderState
Imports
javax.portlet.Mutable, .MutableRenderState, .MutableRenderParameters, .PortletMode, .PortletModeException, .WindowState, .WindowStateException
The MutableRenderStateWrapper provides a convenient implementation of the MutableRenderState interface that can be subclassed by developers. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.
Since
3.0

Field Summary

Inherited from javax.portlet.filter.RenderStateWrapper:
wrapped

Constructor Summary

AccessConstructor and Description
public
MutableRenderStateWrapper(MutableRenderState
the wrapped object to set.
wrapped)

Method Summary

Modifier and TypeMethod and Description
public MutableRenderParameters
getRenderParameters()

Overrides javax.portlet.filter.RenderStateWrapper.getRenderParameters.

Implements javax.portlet.MutableRenderState.getRenderParameters, javax.portlet.RenderState.getRenderParameters.

Gets the mutable render parameters.
public MutableRenderState

Returns:

the wrapped object.
getWrapped()

Overrides javax.portlet.filter.RenderStateWrapper.getWrapped.

Gets the wrapped object.
public void
setPortletMode(PortletMode
the new portlet mode
portletMode)

Implements javax.portlet.MutableRenderState.setPortletMode.

Sets the portlet mode of a portlet to the given portlet mode.
public void
setWindowState(WindowState
the new portlet window state
windowState)

Implements javax.portlet.MutableRenderState.setWindowState.

Sets the window state of a portlet to the given window state.
public void
setWrapped(MutableRenderState
the wrapped object to set.
wrapped)

Sets the wrapped object.

Inherited from javax.portlet.filter.RenderStateWrapper:
getPortletModegetWindowStatesetWrapped

Constructor Detail

MutableRenderStateWrapperback to summary
public MutableRenderStateWrapper(MutableRenderState wrapped)
Parameters
wrapped:MutableRenderState

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the MutableRenderState is null.

Method Detail

getRenderParametersback to summary
public MutableRenderParameters getRenderParameters()

Overrides javax.portlet.filter.RenderStateWrapper.getRenderParameters.

Implements javax.portlet.MutableRenderState.getRenderParameters, javax.portlet.RenderState.getRenderParameters.

Doc from javax.portlet.MutableRenderState.getRenderParameters.

Gets the mutable render parameters.
Returns:MutableRenderParameters

a MutableRenderParameters object representing the private and public render parameters

Annotations
@Override
getWrappedback to summary
public MutableRenderState getWrapped()

Overrides javax.portlet.filter.RenderStateWrapper.getWrapped.

Gets the wrapped object.

Returns:MutableRenderState

the wrapped object.

setPortletModeback to summary
public void setPortletMode(PortletMode portletMode) throws PortletModeException

Implements javax.portlet.MutableRenderState.setPortletMode.

Doc from javax.portlet.MutableRenderState.setPortletMode.

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:PortletMode

the new portlet mode

Annotations
@Override
Exceptions
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.
setWindowStateback to summary
public void setWindowState(WindowState windowState) throws WindowStateException

Implements javax.portlet.MutableRenderState.setWindowState.

Doc from javax.portlet.MutableRenderState.setWindowState.

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:WindowState

the new portlet window state

Annotations
@Override
Exceptions
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.
setWrappedback to summary
public void setWrapped(MutableRenderState wrapped)

Sets the wrapped object.

Parameters
wrapped:MutableRenderState

the wrapped object to set.

Exceptions
IllegalArgumentException:
if the MutableRenderState is null.