com.bea.portlet
Class PageURL

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

All Implemented Interfaces:

Cloneable

public class PageURL

extends PostbackURL

The PageURL helps portal applications create URLs to books and pages.

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	PageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse) Constructs a PageURL.
protected	PageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String pageLabel) Constructs a PageURL.
protected	PageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String pageLabel, boolean encodeLabel) Constructs a PageURL.

Method Summary

Object	clone() Returns a deep copy.
static PageURL	createPageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse) Returns a PageURL.
static PageURL	createPageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String pageLabel) Returns a PageURL.
static PageURL	createPageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String pageLabel, boolean encodeLabel) Returns a PageURL.
void	setPageLabel(String pageLabel) Sets page label.
void	setPageLabel(String pageLabel, boolean encodeLabel) Sets page label.

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

PageURL

protected PageURL(HttpServletRequest httpRequest,
                  HttpServletResponse httpResponse)

Constructs a PageURL.

PageURL

protected PageURL(HttpServletRequest httpRequest,
                  HttpServletResponse httpResponse,
                  String pageLabel)

Constructs a PageURL.

PageURL

protected PageURL(HttpServletRequest httpRequest,
                  HttpServletResponse httpResponse,
                  String pageLabel,
                  boolean encodeLabel)

Constructs a PageURL.

Method Detail

clone

public Object clone()

Returns a deep copy.

Overrides:

clone in class PostbackURL

Returns:

clone

createPageURL

public static PageURL createPageURL(HttpServletRequest httpRequest,
                                    HttpServletResponse httpResponse)

Returns a PageURL.

Parameters:

httpRequest - HTTP request

httpResponse - HTTP response

Returns:

PageURL

createPageURL

public static PageURL createPageURL(HttpServletRequest httpRequest,
                                    HttpServletResponse httpResponse,
                                    String pageLabel)

Returns a PageURL.

Parameters:

httpRequest - HTTP request

httpResponse - HTTP response

pageLabel - page label

Returns:

PageURL

createPageURL

public static PageURL createPageURL(HttpServletRequest httpRequest,
                                    HttpServletResponse httpResponse,
                                    String pageLabel,
                                    boolean encodeLabel)

Returns a PageURL.

Parameters:

httpRequest - HTTP request

httpResponse - HTTP response

pageLabel - page label

encodeLabel - true if the page label should be encoded

Returns:

PageURL

setPageLabel

public void setPageLabel(String pageLabel)

Sets page label.

Parameters:

pageLabel - page label

setPageLabel

public void setPageLabel(String pageLabel,
                         boolean encodeLabel)

Sets page label.

Parameters:

pageLabel - page label

encodeLabel - true if the page label should be encoded