com.bea.portlet
Class WindowURL

java.lang.Object
  com.bea.portlet.GenericURL
      com.bea.portlet.PostbackURL
          com.bea.portlet.WindowURL

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

JspContentURL, StandalonePortletURL

public class WindowURL

extends PostbackURL

The WindowURL helps portal applications create URLs to portlet windows, portal pages and books.

See Also:

GenericURL

Field Summary

Fields inherited from class com.bea.portlet.GenericURL

CONTROL_STATE_PARAM, CURRENT_PAGE, DOMAIN, httpRequest, httpResponse, LOADSTATE_PARAM, MODE_PARAM, PAGE_LABEL_PARAM, params, PATH, PORT, POSTBACK_PARAM, PREFIX, QUERY_STRING, SCHEME, SECURE_PORT, STATE_PARAM, TREE_OPTIMIZATION_PARAM, WINDOW_LABEL_PARAM

Constructor Summary

protected	WindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse) Constructs a WindowURL.
protected	WindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel) Constructs a WindowURL.

Method Summary

Object	clone() Returns a deep copy.
static WindowURL	createWindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse) Returns a WindowURL from the current portlet.
static WindowURL	createWindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel) Returns a WindowURL from the specified portlet.
String	getWindowLabel() Returns the window label.
String	getWindowMode() Returns a window mode.
String	getWindowState() Returns the window state.
void	setWindowLabel(String windowLabel)
void	setWindowMode(String windowMode) Sets a portlet window mode.
void	setWindowState(String windowState) Sets window state.

Methods inherited from class com.bea.portlet.PostbackURL

createPostbackURL, toString

Methods inherited from class com.bea.portlet.GenericURL

addParameter, addParameter, addParameter, appendEnsureSeparator, createQueryString, getContextualPath, getDomain, getEncodeSession, getParameter, getParameters, getPathPrefix, getPort, getResolvedTemplate, getScheme, getSecurePort, getTemplate, getUrlType, removeParameter, setContextualPath, setDomain, setEncodeSession, setPath, setPathPrefix, setPort, setScheme, setSecurePort, setTemplate, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WindowURL

protected WindowURL(HttpServletRequest httpRequest,
                    HttpServletResponse httpResponse)

Constructs a WindowURL.

WindowURL

protected WindowURL(HttpServletRequest httpRequest,
                    HttpServletResponse httpResponse,
                    String windowLabel)

Constructs a WindowURL.

Method Detail

clone

public Object clone()

Returns a deep copy.

Overrides:

clone in class PostbackURL

Returns:

clone

createWindowURL

public static WindowURL createWindowURL(HttpServletRequest httpRequest,
                                        HttpServletResponse httpResponse)

Returns a WindowURL from the current portlet.

Parameters:

httpRequest - HTTP request

httpResponse - HTTP response

Returns:

WindowURL

createWindowURL

public static WindowURL createWindowURL(HttpServletRequest httpRequest,
                                        HttpServletResponse httpResponse,
                                        String windowLabel)

Returns a WindowURL from the specified portlet.

Parameters:

httpRequest - HTTP request

httpResponse - HTTP response

windowLabel - window label

Returns:

WindowURL

getWindowLabel

public String getWindowLabel()

Returns the window label.

Returns:

Value of window label, null if not set

getWindowMode

public String getWindowMode()

Returns a window mode.

Returns:

mode

getWindowState

public String getWindowState()

Returns the window state.

Returns:

window state

setWindowLabel

public void setWindowLabel(String windowLabel)

setWindowMode

public void setWindowMode(String windowMode)

Sets a portlet window mode.

Parameters:

windowMode - window mode

setWindowState

public void setWindowState(String windowState)

Sets window state.

Parameters:

windowState - window state