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 WindowState |
WindowState.MAXIMIZED
The
MAXIMIZED window state is an indication that a portlet may be the only portlet being rendered in
the portal page, or that the portlet has more space compared to other portlets in the portal page. |
static WindowState |
WindowState.MINIMIZED
When a portlet is in
MINIMIZED window state, the portlet should only render minimal output or no
output at all. |
static WindowState |
WindowState.NORMAL
The
NORMAL window state indicates that a portlet may be sharing the page with other portlets. |
static WindowState |
WindowState.UNDEFINED
The window state
UNDEFINED is returned by the
getWindowState method when the window state is not available. |
Modifier and Type | Method and Description |
---|---|
WindowState |
WindowStateException.getState()
Returns the window state causing this exception.
|
WindowState |
ResourceRequest.getWindowState()
Returns
the current window state of the portlet.
|
WindowState |
RenderState.getWindowState()
Returns the current window state of the portlet.
|
Modifier and Type | Method and Description |
---|---|
Enumeration<WindowState> |
PortalContext.getSupportedWindowStates()
Returns all supported window states by the portal
as an enumeration of
WindowState objects. |
Enumeration<WindowState> |
GenericPortlet.getWindowStates(String mimeType)
Returns an
Enumeration of WindowState objects that are defined
for the portlet for the given MIME type. |
Enumeration<WindowState> |
PortletConfig.getWindowStates(String mimeType)
Returns an
Enumeration of WindowState objects that are defined
for the portlet for the given MIME type. |
Modifier and Type | Method and Description |
---|---|
boolean |
PortletRequest.isWindowStateAllowed(WindowState state)
Returns true, if the given window state is valid
to be set for this portlet in the context
of the current request.
|
void |
MutableRenderState.setWindowState(WindowState windowState)
Sets the window state of a portlet to the given window state.
|
Constructor and Description |
---|
WindowStateException(String text,
Throwable cause,
WindowState state)
Constructs a new window state exception when the portlet needs to do
the following:
|
WindowStateException(String text,
WindowState state)
Constructs a new window state exception with the given text.
|
WindowStateException(Throwable cause,
WindowState state)
Constructs a new window state exception when the portlet needs to throw an
exception.
|
Modifier and Type | Method and Description |
---|---|
WindowState |
RenderStateWrapper.getWindowState() |
WindowState |
StateAwareResponseWrapper.getWindowState() |
WindowState |
PortletRequestWrapper.getWindowState() |
Modifier and Type | Method and Description |
---|---|
Enumeration<WindowState> |
PortalContextWrapper.getSupportedWindowStates() |
Enumeration<WindowState> |
PortletConfigWrapper.getWindowStates(String mimeType) |
Modifier and Type | Method and Description |
---|---|
boolean |
PortletRequestWrapper.isWindowStateAllowed(WindowState state) |
void |
MutableRenderStateWrapper.setWindowState(WindowState windowState) |
void |
PortletURLWrapper.setWindowState(WindowState windowState) |
void |
StateAwareResponseWrapper.setWindowState(WindowState windowState) |
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.