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.
|
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. |
Modifier and Type | Method and Description |
---|---|
WindowState |
WindowStateException.getState()
Returns the portlet state causing this exception.
|
WindowState |
StateAwareResponse.getWindowState()
Returns the currently set window state on this response.
|
WindowState |
PortletURL.getWindowState()
Returns the currently set window state on this PortletURL.
|
WindowState |
PortletRequest.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. |
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 |
StateAwareResponse.setWindowState(WindowState windowState)
Sets the window state of a portlet to the given window state.
|
void |
PortletURL.setWindowState(WindowState windowState)
Indicates the window state the portlet should be in, if this
portlet URL triggers a request.
|
Constructor and Description |
---|
WindowStateException(String text,
Throwable cause,
WindowState state)
Constructs a new portlet state exception when the portlet needs to do
the following:
|
WindowStateException(String text,
WindowState state)
Constructs a new portlet state exception with the given text.
|
WindowStateException(Throwable cause,
WindowState state)
Constructs a new portlet state exception when the portlet needs to throw an
exception.
|
Modifier and Type | Method and Description |
---|---|
WindowState |
PortletRequestWrapper.getWindowState()
The default behavior of this method is to call
getWindowState() on the wrapped request object. |
WindowState |
EventResponseWrapper.getWindowState()
The default behavior of this method is to call
getWindowState() on the wrapped response object. |
WindowState |
ActionResponseWrapper.getWindowState()
The default behavior of this method is to call
getWindowState() on the wrapped response object. |
Modifier and Type | Method and Description |
---|---|
boolean |
PortletRequestWrapper.isWindowStateAllowed(WindowState state)
The default behavior of this method is to call
isWindowStateAllowed(state) on the wrapped request object. |
void |
EventResponseWrapper.setWindowState(WindowState windowState)
The default behavior of this method is to call
setWindowState(windowState) on the wrapped response object. |
void |
ActionResponseWrapper.setWindowState(WindowState windowState)
The default behavior of this method is to call
setWindowState(windowState) on the wrapped response object. |
Copyright © 2004–2015 The Apache Software Foundation. All rights reserved.