Uses of Class
jakarta.portlet.PortletMode

Packages that use PortletMode

Package	Description
jakarta.portlet	The jakarta.portlet package defines the API for the Jakarta Portlet Specification V4.0.
jakarta.portlet.filter	The jakarta.portlet.filter package defines the filter APIs for the Jakarta Portlet Specification.

Uses of PortletMode in jakarta.portlet

Fields in jakarta.portlet declared as PortletMode

Modifier and Type	Field	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.UNDEFINED	The portlet mode UNDEFINED is returned by the getPortletMode method when the portlet mode is not available.
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 jakarta.portlet that return PortletMode

Modifier and Type	Method	Description
PortletMode	PortletModeException.getMode()	Returns the unsupported portlet mode causing this exception.
PortletMode	RenderState.getPortletMode()	Returns the current portlet mode of the portlet.
PortletMode	ResourceRequest.getPortletMode()	Returns the current portlet mode of the portlet.

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

Modifier and Type	Method	Description
protected Collection<PortletMode>	GenericPortlet.getNextPossiblePortletModes(RenderRequest request)	Used by the render method to set the next possible portlet modes.
Enumeration<PortletMode>	GenericPortlet.getPortletModes(String mimeType)	Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
Enumeration<PortletMode>	PortletConfig.getPortletModes(String mimeType)	Returns an Enumeration of PortletMode objects that are defined for the portlet for the given MIME type.
Enumeration<PortletMode>	PortalContext.getSupportedPortletModes()	Returns all supported portlet modes by the portal as an enumeration of PortletMode objects.

Methods in jakarta.portlet with parameters of type PortletMode

Modifier and Type	Method	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	MutableRenderState.setPortletMode(PortletMode portletMode)	Sets the portlet mode of a portlet to the given portlet mode.

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

Modifier and Type	Method	Description
void	RenderResponse.setNextPossiblePortletModes(Collection<? extends 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 jakarta.portlet with parameters of type PortletMode

Constructor	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 jakarta.portlet.filter

Methods in jakarta.portlet.filter that return PortletMode

Modifier and Type	Method	Description
PortletMode	PortletRequestWrapper.getPortletMode()
PortletMode	RenderStateWrapper.getPortletMode()
PortletMode	StateAwareResponseWrapper.getPortletMode()

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

Modifier and Type	Method	Description
Enumeration<PortletMode>	PortletConfigWrapper.getPortletModes(String mimeType)
Enumeration<PortletMode>	PortalContextWrapper.getSupportedPortletModes()

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

Modifier and Type	Method	Description
boolean	PortletRequestWrapper.isPortletModeAllowed(PortletMode mode)
void	MutableRenderStateWrapper.setPortletMode(PortletMode portletMode)
void	PortletURLWrapper.setPortletMode(PortletMode portletMode)
void	StateAwareResponseWrapper.setPortletMode(PortletMode portletMode)

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

Modifier and Type	Method	Description
void	RenderResponseWrapper.setNextPossiblePortletModes(Collection<? extends PortletMode> portletModes)