PageURL Class

com.bea.portlet
PageURL Class

public class PageURL

    extends PostbackURL

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

Related Topics

GenericURL

Hierarchy
Object
  GenericURL
    PostbackURL
      PageURL
All Implemented Interfaces

Cloneable

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

Constructs a PageURL.
PageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse, String pageLabel)

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

Constructs a PageURL.
 

Method Summary
public Object
clone()

Returns a deep copy.
public static PageURL
createPageURL(HttpServletRequest httpRequest, HttpServletResponse httpResponse)

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

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

Returns a PageURL.
public void
setPageLabel(String pageLabel, boolean encodeLabel)

Sets page label.
public void
setPageLabel(String pageLabel)

Sets page label.
 
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

PageURL

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

Constructs a PageURL.

PageURL

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

Constructs a PageURL.

PageURL

protected PageURL(HttpServletRequest httpRequest, 
                  HttpServletResponse httpResponse)

Constructs a PageURL.

 

Method Detail

clone() Method

public Object clone()

Returns a deep copy.

Overrides
PostbackURL.clone()

Returns

clone

createPageURL(HttpServletRequest, HttpServletResponse) Method

public static PageURL createPageURL(HttpServletRequest httpRequest, 
                                    HttpServletResponse httpResponse)

Returns a PageURL.

Parameters

httpRequest
HTTP request
httpResponse
HTTP response

Returns

PageURL

createPageURL(HttpServletRequest, HttpServletResponse, String) Method

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

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

public void setPageLabel(String pageLabel, 
                         boolean encodeLabel)

Sets page label.

Parameters

pageLabel
page label
encodeLabel
true if the page label should be encoded

setPageLabel(String) Method

public void setPageLabel(String pageLabel)

Sets page label.

Parameters

pageLabel
page label