Uses of Class
javax.portlet.PortletMode

Packages that use PortletMode

Package	Description
javax.portlet	The javax.portlet package defines the API for Java Portlet Specification V2.0.
javax.portlet.filter	The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.

Uses of PortletMode in javax.portlet

Fields in javax.portlet declared as PortletMode

Modifier and Type	Field and Description
static PortletMode	PortletMode.EDIT Within the EDIT portlet mode, a portlet should provide content and logic that lets a user customize the behavior of the portlet.
static PortletMode	PortletMode.HELP When in HELP portlet mode, a portlet should provide help information about the portlet.
static PortletMode	PortletMode.VIEW The expected functionality for a portlet in VIEW portlet mode is to generate markup reflecting the current state of the portlet.

Methods in javax.portlet that return PortletMode

Modifier and Type	Method and Description
PortletMode	PortletModeException.getMode() Returns the unsupported portlet mode causing this exception.
PortletMode	PortletURL.getPortletMode() Returns the currently set portlet mode on this PortletURL.
PortletMode	PortletRequest.getPortletMode() Returns the current portlet mode of the portlet.
PortletMode	StateAwareResponse.getPortletMode() Returns the currently set portlet mode on this reponse.

Methods in javax.portlet that return types with arguments of type PortletMode

Modifier and Type	Method and Description
protected Collection<PortletMode>	GenericPortlet.getNextPossiblePortletModes(RenderRequest request) Used by the render method to set the next possible portlet modes.
Enumeration<PortletMode>	PortalContext.getSupportedPortletModes() Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.

Methods in javax.portlet with parameters of type PortletMode

Modifier and Type	Method and Description
boolean	PortletRequest.isPortletModeAllowed(PortletMode mode) Returns true, if the given portlet mode is a valid one to set for this portlet in the context of the current request.
void	PortletURL.setPortletMode(PortletMode portletMode) Indicates the portlet mode the portlet must be in, if this portlet URL triggers a request.
void	StateAwareResponse.setPortletMode(PortletMode portletMode) Sets the portlet mode of a portlet to the given portlet mode.

Method parameters in javax.portlet with type arguments of type PortletMode

Modifier and Type	Method and Description
void	RenderResponse.setNextPossiblePortletModes(Collection<PortletMode> portletModes) This method allows the portlet to tell the portal the next possible portlet modes that the make sense from the portlet point of view.

Constructors in javax.portlet with parameters of type PortletMode

Constructor and Description
PortletModeException(String text, PortletMode mode) Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
PortletModeException(String text, Throwable cause, PortletMode mode) Constructs a new portlet mode exception when the portlet needs to do the following: throw an exception include a message about the "root cause" that interfered with its normal operation include a description message include the portlet mode that caused this exception
PortletModeException(Throwable cause, PortletMode mode) Constructs a new portlet mode exception when the portlet needs to throw an exception.

Uses of PortletMode in javax.portlet.filter

Methods in javax.portlet.filter that return PortletMode

Modifier and Type	Method and Description
PortletMode	PortletRequestWrapper.getPortletMode() The default behavior of this method is to call getPortletMode() on the wrapped request object.
PortletMode	EventResponseWrapper.getPortletMode() The default behavior of this method is to call getPortletMode() on the wrapped response object.
PortletMode	ActionResponseWrapper.getPortletMode() The default behavior of this method is to call getPortletMode() on the wrapped response object.

Methods in javax.portlet.filter with parameters of type PortletMode

Modifier and Type	Method and Description
boolean	PortletRequestWrapper.isPortletModeAllowed(PortletMode mode) The default behavior of this method is to call isPortletModeAllowed(mode) on the wrapped request object.
void	EventResponseWrapper.setPortletMode(PortletMode portletMode) The default behavior of this method is to call setPortletMode(portletMode) on the wrapped response object.
void	ActionResponseWrapper.setPortletMode(PortletMode portletMode) The default behavior of this method is to call setPortletMode(portletMode) on the wrapped response object.

Method parameters in javax.portlet.filter with type arguments of type PortletMode

Modifier and Type	Method and Description
void	RenderResponseWrapper.setNextPossiblePortletModes(Collection<PortletMode> portletModes) The default behavior of this method is to call setNextPossiblePortletModes() on the wrapped response object.