WindowURL Class

com.bea.portlet
WindowURL Class

public class WindowURL

    extends PostbackURL

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

Related Topics

GenericURL

Hierarchy
Object
  GenericURL
    PostbackURL
      WindowURL
All Implemented Interfaces

Cloneable
Direct Known Subclasses

JspContentURL, StandalonePortletURL

Field Summary
   
Fields from  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
WindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)

Constructs a WindowURL.
WindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)

Constructs a WindowURL.
 

Method Summary
public Object
clone()

Returns a deep copy.
public static WindowURL
createWindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)

Returns a WindowURL from the current portlet.
public static WindowURL
createWindowURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)

Returns a WindowURL from the specified portlet.
public String
getWindowLabel()

Returns the window label.
public String
getWindowMode()

Returns a window mode.
public String
getWindowState()

Returns the window state.
public void
setWindowLabel(String windowLabel)
public void
setWindowMode(String windowMode)

Sets a portlet window mode.
public void
setWindowState(String windowState)

Sets window state.
 
Methods from  com.bea.portlet.PostbackURL
createPostbackURL, toString
 
Methods from  com.bea.portlet.GenericURL
addParameter, addParameter, addParameter, appendEnsureSeparator, clone, createQueryString, getContextualPath, getDomain, getEncodeSession, getParameter, getParameters, getPathPrefix, getPort, getResolvedTemplate, getScheme, getSecurePort, getTemplate, getUrlType, removeParameter, setContextualPath, setDomain, setEncodeSession, setPath, setPathPrefix, setPort, setScheme, setSecurePort, setTemplate, toString, toString
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

WindowURL

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

Constructs a WindowURL.

WindowURL

protected WindowURL(HttpServletRequest httpRequest, 
                    HttpServletResponse httpResponse)

Constructs a WindowURL.

 

Method Detail

clone() Method

public Object clone()

Returns a deep copy.

Overrides
PostbackURL.clone()

Returns

clone

createWindowURL(HttpServletRequest, HttpServletResponse) Method

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(HttpServletRequest, HttpServletResponse, String) Method

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() Method

public String getWindowLabel()

Returns the window label.

Returns

Value of window label, null if not set

getWindowMode() Method

public String getWindowMode()

Returns a window mode.

Returns

mode

getWindowState() Method

public String getWindowState()

Returns the window state.

Returns

window state

setWindowLabel(String) Method

public void setWindowLabel(String windowLabel)

setWindowMode(String) Method

public void setWindowMode(String windowMode)

Sets a portlet window mode.

Parameters

windowMode
window mode

setWindowState(String) Method

public void setWindowState(String windowState)

Sets window state.

Parameters

windowState
window state