org.apache.pluto.internal.impl
Class PortletURLImpl
java.lang.Object
org.apache.pluto.internal.impl.BaseURLImpl
org.apache.pluto.internal.impl.PortletURLImpl
- All Implemented Interfaces:
- BaseURL, PortletURL
public class PortletURLImpl
- extends BaseURLImpl
- implements PortletURL
Refactoring where functionality was pushed into JSR-286 BaseURL
.
- Since:
- 2.0
Fields inherited from class org.apache.pluto.internal.impl.BaseURLImpl |
container, context, internalPortletWindow, isAction, isResourceServing, mode, parameters, publicRenderParameters, secure, servletRequest, servletResponse, state |
Methods inherited from class org.apache.pluto.internal.impl.BaseURLImpl |
addProperty, getParameter, getParameterMap, getParameters, getPortletMode, getWindowState, isPortletModeAllowed, isWindowStateAllowed, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write |
PortletURLImpl
public PortletURLImpl(PortletContainer container,
InternalPortletWindow internalPortletWindow,
javax.servlet.http.HttpServletRequest servletRequest,
javax.servlet.http.HttpServletResponse servletResponse,
boolean isAction)
setWindowState
public void setWindowState(WindowState windowState)
throws WindowStateException
- Description copied from interface:
PortletURL
- Indicates the window state the portlet should be in, if this
portlet URL triggers a request.
A URL can not have more than one window state attached to it.
If more than one window state is set only the last one set
is attached to the URL.
- Specified by:
setWindowState
in interface PortletURL
- Parameters:
windowState
- the portlet window state
- Throws:
WindowStateException
- if the portlet cannot switch to this state,
because the portal does not support this state, the portlet has not
declared in its deployment descriptor that it supports this state, or the current
user is not allowed to switch to this state.
The PortletRequest.isWindowStateAllowed()
method can be used
to check if the portlet can set a given window state.- See Also:
PortletRequest.isWindowStateAllowed(javax.portlet.WindowState)
setPortletMode
public void setPortletMode(PortletMode portletMode)
throws PortletModeException
- Description copied from interface:
PortletURL
- Indicates the portlet mode the portlet must be in, if this
portlet URL triggers a request.
A URL can not have more than one portlet mode attached to it.
If more than one portlet mode is set only the last one set
is attached to the URL.
- Specified by:
setPortletMode
in interface PortletURL
- Parameters:
portletMode
- the portlet mode
- Throws:
PortletModeException
- if the portlet cannot switch to this mode,
because the portal does not support this mode, the portlet has not
declared in its deployment descriptor that it supports this mode for the current markup,
or the current user is not allowed to switch to this mode.
The PortletRequest.isPortletModeAllowed()
method can be used
to check if the portlet can set a given portlet mode.- See Also:
PortletRequest.isPortletModeAllowed(javax.portlet.PortletMode)
removePublicRenderParameter
public void removePublicRenderParameter(String name)
- Description copied from interface:
PortletURL
- Removes the specified public render parameter.
The name must reference a public render parameter defined
in the portlet deployment descriptor under the
public-render-parameter
element with the
identifier
mapping to the parameter name.
- Specified by:
removePublicRenderParameter
in interface PortletURL
- Parameters:
name
- a String
specifying
the name of the public render parameter to be removed
Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.