StandalonePortletURL Class

com.bea.portlet
StandalonePortletURL Class

public class StandalonePortletURL

    extends WindowURL

The StandalonePortletURL helps create links to render portlets in a separate window (such as a popup window).

Related Topics

GenericURL


Hierarchy
Object
  GenericURL
    PostbackURL
      WindowURL
        StandalonePortletURL
All Implemented Interfaces

Cloneable

Field Summary

public static final String
STREAMING_PORTLET_URL_PATTERN
String
   
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

StandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)

Constructs a StandalonePortletURL.

StandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)

Constructs a StandalonePortletURL.

 

Method Summary

public void
addParameter(String name, String value)

Add a parameter.

public void
addParameter(String name, String value, boolean encodeName, boolean encodeValue)

Add a parameter.

protected StringBuffer
appendPathWhenNull(StringBuffer buf, HttpServletRequest httpRequest)
public Object
clone()

Returns a deep copy.

public static StandalonePortletURL
createStandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)

Returns a StandalonePortletURL.

public static StandalonePortletURL
createStandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)

Returns a StandalonePortletURL.

public String
getPortletServletName()
public void
setPortletServletName(String servletPortletName)
 
Methods from  com.bea.portlet.WindowURL
createWindowURL, createWindowURL, getWindowLabel, getWindowMode, getWindowState, setWindowLabel, setWindowMode, setWindowState
 
Methods from  com.bea.portlet.PostbackURL
clone, createPostbackURL, toString
 
Methods from  com.bea.portlet.GenericURL
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
   

Field Detail

STREAMING_PORTLET_URL_PATTERN

public static final String STREAMING_PORTLET_URL_PATTERN

 

Constructor Detail

StandalonePortletURL

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

Constructs a StandalonePortletURL.


StandalonePortletURL

protected StandalonePortletURL(HttpServletRequest httpRequest, 
                               HttpServletResponse httpResponse)

Constructs a StandalonePortletURL.

 

Method Detail

addParameter(String, String) Method

public void addParameter(String name, 
                         String value)
Description copied from GenericURL.addParameter(String, String)

Add a parameter. Multiple values for the same parameter can be set by calling this method multiple times with the same name.

This method URL encodes the parameter name and value value.

Overrides
GenericURL.addParameter(String, String)

Parameters

name
name
value
value

addParameter(String, String, boolean, boolean) Method

public void addParameter(String name, 
                         String value, 
                         boolean encodeName, 
                         boolean encodeValue)

Add a parameter. Multiple values for the same parameter can be set by calling this method multiple times with the same name.

If the encodeName boolean argument is true, this method URL encodes the parameter name. If the encodeValue boolean argument is true, this method URL encodes the parameter value.

Overrides
GenericURL.addParameter(String, String, boolean, boolean)

Parameters

name
parameter's name
value
parameter's value
encodeName
true if the parameter's name should be encoded
encodeValue
true if the parameter's value should be encoded

appendPathWhenNull(StringBuffer, HttpServletRequest) Method

protected StringBuffer appendPathWhenNull(StringBuffer buf, 
                                          HttpServletRequest httpRequest)
Overrides
GenericURL.appendPathWhenNull(StringBuffer, HttpServletRequest)

clone() Method

public Object clone()

Returns a deep copy.

Overrides
WindowURL.clone()

Returns

clone

createStandalonePortletURL(HttpServletRequest, HttpServletResponse) Method

public static StandalonePortletURL createStandalonePortletURL(HttpServletRequest httpRequest, 
                                                              HttpServletResponse httpResponse)

Returns a StandalonePortletURL.

Parameters

httpRequest
HTTP request
httpResponse
HTTP response

Returns

StandalonePortletURL

createStandalonePortletURL(HttpServletRequest, HttpServletResponse, String) Method

public static StandalonePortletURL createStandalonePortletURL(HttpServletRequest httpRequest, 
                                                              HttpServletResponse httpResponse, 
                                                              String windowLabel)

Returns a StandalonePortletURL.

Parameters

httpRequest
HTTP request
httpResponse
HTTP response
windowLabel
window label

Returns

StandalonePortletURL

getPortletServletName() Method

public String getPortletServletName()

setPortletServletName(String) Method

public void setPortletServletName(String servletPortletName)