Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2006 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.portlet
Class StandalonePortletURL

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

All Implemented Interfaces
  Cloneable

    public class StandalonePortletURL

extends WindowURL

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

See Also
  `GenericURL`

Nested Class Summary
`static class` | `StandalonePortletURL.ContentMode` Enumeration of valid values for the `KEY_CONTENT_MODE` parameter

Field Summary
`static String` | `KEY_ASYNC`
`static String` | `KEY_CONTENT_MODE`
`static String` | `KEY_CONTENT_ONLY`
`static String` | `KEY_DEFAULT_WINDOW_ICON`
`static String` | `KEY_DEFAULT_WINDOW_ICON_PATH`
`static String` | `KEY_LAF_UNIQUE_ID`
`static String` | `KEY_PORTAL_CONTENT_TYPE`
`static String` | `KEY_PORTAL_ID`
`static String` | `KEY_PORTAL_URL`
`static String` | `KEY_PORTLET_INSTANCE_LABEL`
`static String` | `KEY_SKELETON`
`static String` | `KEY_SKELETON_CHROMOSOME`
`static String` | `KEY_SKELETON_PATH`
`static String` | `KEY_SKIN`
`static String` | `KEY_SKIN_CHROMOSOME`
`static String` | `KEY_SKIN_PATH`
`static String` | `KEY_STREAMING` this attribute is true if the url is to a streamed portlet.
`static String` | `KEY_THEME_ALT_SKELETON`
`static String` | `KEY_THEME_ALT_SKIN`
`static String` | `KEY_THEME_NAME`
`static String` | `KEY_THEME_SKELETON_CHROMOSOME`
`static String` | `KEY_THEME_SKIN_CHROMOSOME`
`static String` | `KEY_TITLE`
`static String` | `STREAMING_PORTLET_URL_PATTERN` Deprecated

Fields inherited from class com.bea.portlet.GenericURL
`COMMUNITY_ADMIN_FLAG_PARAM, COMMUNITY_DESKTOP, CONTROL_STATE_PARAM, CURRENT_PAGE, domain, DOMAIN, EVENT_NAME_PARAM, httpRequest, httpResponse, httpsDomain, LOADSTATE_PARAM, MODE_PARAM, PAGE_LABEL_PARAM, params, PATH, PORT, PORTLET_SUB_INSTANCE_ID, POSTBACK_PARAM, PREFIX, QUERY_STRING, SCHEME, SECURE_PORT, STATE_PARAM, TREE_OPTIMIZATION_PARAM, URL_COMPRESSION, WINDOW_LABEL_PARAM`

Constructor Summary
`protected` | `StandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)` Constructs a StandalonePortletURL.
`protected` | `StandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)` Constructs a StandalonePortletURL.

Method Summary
`void` | `addParameter(String name, String value)` Add a parameter.
`void` | `addParameter(String name, String value, boolean encodeName, boolean encodeValue)` Add a parameter.
`protected StringBuffer` | `appendPathWhenNull(StringBuffer buf, HttpServletRequest httpRequest)` Deprecated As of 9.2 SP2, replaced by `appendPathWhenNull`
`Object` | `clone()` Returns a deep copy.
`static StandalonePortletURL` | `createStandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)` Returns a StandalonePortletURL.
`static StandalonePortletURL` | `createStandalonePortletURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String windowLabel)` Returns a StandalonePortletURL.
`String` | `getPortletServletName()` Deprecated
`void` | `setContentMode(StandalonePortletURL.ContentMode contentMode)` Sets the content mode used to render the portlet.
`void` | `setContentOnly(boolean contentOnly)` Set to true to render only the content of the portlet.
`void` | `setDesktopStateShared(boolean desktopStateShared)` Deprecated Provided only for backward compatibility
`void` | `setPortletServletName(String servletPortletName)` Deprecated
`void` | `setPortletUri(String portletUri)` Used to create a "detached" Portlet.
`void` | `setWindowLabel(String windowLabel)` Equivalent to using the three-argument factory method to create a URL.

Methods inherited from class com.bea.portlet.WindowURL
`createWindowURL, createWindowURL, getWindowLabel, getWindowMode, getWindowState, setWindowMode, setWindowState`

Methods inherited from class com.bea.portlet.PostbackURL
`createPostbackURL`

Methods inherited from class com.bea.portlet.GenericURL
`addParameter, appendEnsureSeparator, appendEnsureSeparator, createGenericURL, createQueryString, createQueryStringBuilder, getContextualPath, getDomain, getEncodeSession, getParameter, getParameters, getPathPrefix, getPort, getResolvedTemplate, getScheme, getSecurePort, getTemplate, getUrlType, removeParameter, setContextualPath, setDomain, setEncodeSession, setForcedAmpForm, setPath, setPathPrefix, setPort, setScheme, setSecurePort, setTemplate, toString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### KEY_STREAMING

    public static final String KEY_STREAMING

  this attribute is true if the url is to a streamed portlet.

  See Also
    Constants Summary

### KEY_LAF_UNIQUE_ID

    public static final String KEY_LAF_UNIQUE_ID

See Also
  Constants Summary

### KEY_TITLE

    public static final String KEY_TITLE

See Also
  Constants Summary

### KEY_SKELETON

    public static final String KEY_SKELETON

See Also
  Constants Summary

### KEY_SKELETON_PATH

    public static final String KEY_SKELETON_PATH

See Also
  Constants Summary

### KEY_SKELETON_CHROMOSOME

    public static final String KEY_SKELETON_CHROMOSOME

See Also
  Constants Summary

### KEY_SKIN

    public static final String KEY_SKIN

See Also
  Constants Summary

### KEY_SKIN_PATH

    public static final String KEY_SKIN_PATH

See Also
  Constants Summary

### KEY_SKIN_CHROMOSOME

    public static final String KEY_SKIN_CHROMOSOME

See Also
  Constants Summary

### KEY_DEFAULT_WINDOW_ICON

    public static final String KEY_DEFAULT_WINDOW_ICON

See Also
  Constants Summary

### KEY_DEFAULT_WINDOW_ICON_PATH

    public static final String KEY_DEFAULT_WINDOW_ICON_PATH

See Also
  Constants Summary

### KEY_THEME_NAME

    public static final String KEY_THEME_NAME

See Also
  Constants Summary

### KEY_THEME_ALT_SKELETON

    public static final String KEY_THEME_ALT_SKELETON

See Also
  Constants Summary

### KEY_THEME_ALT_SKIN

    public static final String KEY_THEME_ALT_SKIN

See Also
  Constants Summary

### KEY_THEME_SKELETON_CHROMOSOME

    public static final String KEY_THEME_SKELETON_CHROMOSOME

See Also
  Constants Summary

### KEY_THEME_SKIN_CHROMOSOME

    public static final String KEY_THEME_SKIN_CHROMOSOME

See Also
  Constants Summary

### KEY_PORTAL_URL

    public static final String KEY_PORTAL_URL

See Also
  Constants Summary

### KEY_PORTAL_ID

    public static final String KEY_PORTAL_ID

See Also
  Constants Summary

### KEY_PORTAL_CONTENT_TYPE

    public static final String KEY_PORTAL_CONTENT_TYPE

See Also
  Constants Summary

### KEY_PORTLET_INSTANCE_LABEL

    public static final String KEY_PORTLET_INSTANCE_LABEL

See Also
  Constants Summary

### KEY_CONTENT_ONLY

    public static final String KEY_CONTENT_ONLY

See Also
  Constants Summary

### KEY_CONTENT_MODE

    public static final String KEY_CONTENT_MODE

See Also
  Constants Summary

### KEY_ASYNC

    public static final String KEY_ASYNC

See Also
  Constants Summary

### STREAMING_PORTLET_URL_PATTERN

    public static final String STREAMING_PORTLET_URL_PATTERN

  Deprecated
  See Also
    Constants Summary

Constructor Detail

### StandalonePortletURL

    protected StandalonePortletURL(HttpServletRequest httpRequest,
                                   HttpServletResponse httpResponse)

  Constructs a StandalonePortletURL.

  Parameters
    `httpRequest` - HTTP request
    `httpResponse` - HTTP response

### StandalonePortletURL

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

  Constructs a StandalonePortletURL.

  Parameters
    `httpRequest` - HTTP request
    `httpResponse` - HTTP response
    `windowLabel` - window label

Method Detail

### createStandalonePortletURL

    public static StandalonePortletURL createStandalonePortletURL(HttpServletRequest httpRequest,
                                                                  HttpServletResponse httpResponse)

  Returns a StandalonePortletURL.

  Parameters
    `httpRequest` - HTTP request
    `httpResponse` - HTTP response
  Returns
    StandalonePortletURL

### createStandalonePortletURL

    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

### setPortletServletName

    @Deprecated
    public void setPortletServletName(String servletPortletName)

  Deprecated

### getPortletServletName

    @Deprecated
    public String getPortletServletName()

  Deprecated

### setContentOnly

    public void setContentOnly(boolean contentOnly)

  Set to true to render only the content of the portlet.

### setContentMode

    public void setContentMode(StandalonePortletURL.ContentMode contentMode)

  Sets the content mode used to render the portlet. Only used if "contentOnly" is set to true. Defaults to `StandalonePortletURL.ContentMode.FRAGMENT` if not specified.

  See Also
    `setContentOnly(boolean)`

### setDesktopStateShared

    @Deprecated
    public void setDesktopStateShared(boolean desktopStateShared)

  Deprecated Provided only for backward compatibility

  Set to false to prevent the Portlet from sharing state with it's originating desktop. WARNING: This is provided for backward compatibility with existing applications; all other uses are unsupported.

### setWindowLabel

    public void setWindowLabel(String windowLabel)

  Equivalent to using the three-argument factory method to create a URL. Will cause the Portlet with the specified window label to be the target of this URL.

  This method and the `setPortletUri(String)` method are mutually exclusive

  Overrides:
    `setWindowLabel` in class `WindowURL`
  See Also
    `createStandalonePortletURL(HttpServletRequest, HttpServletResponse, String)`

### setPortletUri

    public void setPortletUri(String portletUri)

  Used to create a "detached" Portlet. A detached portlet is not associated with a Portal and is typically used to provide shared "popup" type application components.

  This method and the `setWindowLabel(String)` method are mutually exclusive

  Parameters
    `portletUri` - Webapp-relative path to the .portlet file

### clone

    public Object clone()

  Returns a deep copy.

  Overrides:
    `clone` in class `WindowURL`
  Returns
    clone

### appendPathWhenNull

    protected StringBuffer appendPathWhenNull(StringBuffer buf,
                                              HttpServletRequest httpRequest)

  Deprecated As of 9.2 SP2, replaced by `appendPathWhenNull`

### addParameter

    public void addParameter(String name,
                             String value)

  Description copied from class: `GenericURL`

  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:
    `addParameter` in class `GenericURL`
  Parameters
    `name` - name
    `value` - value

### addParameter

    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:
    `addParameter` in class `GenericURL`
  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

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 BEA Systems, Inc. All Rights Reserved