Package | Description |
---|---|
javax.portlet |
The javax.portlet package defines the API
for the Java Portlet Specification V3.0.
|
javax.portlet.filter |
The javax.portlet.filter package defines the filter APIs for the Java Portlet Specification.
|
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.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. |
Modifier and Type | Method and Description |
---|---|
PortletMode |
PortletModeException.getMode()
Returns the unsupported portlet mode causing this exception.
|
PortletMode |
ResourceRequest.getPortletMode()
Returns
the current portlet mode of the portlet.
|
PortletMode |
RenderState.getPortletMode()
Returns the current portlet mode of the portlet.
|
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> |
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. |
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 |
MutableRenderState.setPortletMode(PortletMode portletMode)
Sets the portlet mode of a portlet to the given portlet mode.
|
Modifier and Type | Method and 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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
PortletMode |
RenderStateWrapper.getPortletMode() |
PortletMode |
StateAwareResponseWrapper.getPortletMode() |
PortletMode |
PortletRequestWrapper.getPortletMode() |
Modifier and Type | Method and Description |
---|---|
Enumeration<PortletMode> |
PortletConfigWrapper.getPortletModes(String mimeType) |
Enumeration<PortletMode> |
PortalContextWrapper.getSupportedPortletModes() |
Modifier and Type | Method and Description |
---|---|
boolean |
PortletRequestWrapper.isPortletModeAllowed(PortletMode mode) |
void |
MutableRenderStateWrapper.setPortletMode(PortletMode portletMode) |
void |
PortletURLWrapper.setPortletMode(PortletMode portletMode) |
void |
StateAwareResponseWrapper.setPortletMode(PortletMode portletMode) |
Modifier and Type | Method and Description |
---|---|
void |
RenderResponseWrapper.setNextPossiblePortletModes(Collection<? extends PortletMode> portletModes) |
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.