|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.portlet.GenericURL com.bea.portlet.PostbackURL com.bea.portlet.WindowURL
public class WindowURL
The WindowURL
helps portal applications create URLs
to portlet windows, portal pages and books.
GenericURL
Field Summary |
---|
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 |
WindowURL(javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse)
Constructs a WindowURL. |
protected |
WindowURL(javax.servlet.http.HttpServletRequest httpRequest,
javax.servlet.http.HttpServletResponse httpResponse,
String windowLabel)
Constructs a WindowURL. |
Method Summary | |
---|---|
Object |
clone()
Returns a deep copy of this WindowURL. |
static WindowURL |
createWindowURL(javax.servlet.http.HttpServletRequest _httpRequest,
javax.servlet.http.HttpServletResponse _httpResponse)
Returns a WindowURL to the current portlet. |
static WindowURL |
createWindowURL(javax.servlet.http.HttpServletRequest _httpRequest,
javax.servlet.http.HttpServletResponse _httpResponse,
String windowLabel)
Returns a WindowURL to the specified portlet. |
String |
getWindowLabel()
Returns the window label this URL is currently targeting. |
String |
getWindowMode()
Returns a window mode for the portlet targeted by this URL, if a window mode has been set. |
String |
getWindowState()
Returns the window state for the portlet targeted by this URL, if a window state has been specified. |
void |
removeSharedParameter(String sharedParameterName)
Specifies a portlet shared parameter which should be removed if this URL is invoked. |
void |
setWindowLabel(String windowLabel)
Sets the window label this WindowURL targets. |
void |
setWindowMode(String windowMode)
Sets a portlet window mode for the portlet targeted by this URL. |
void |
setWindowState(String windowState)
Sets window state for the portlet targeted by this URL. |
Methods inherited from class com.bea.portlet.PostbackURL |
---|
createPostbackURL, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected WindowURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)
Constructs a WindowURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responseprotected WindowURL(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, String windowLabel)
Constructs a WindowURL.
httpRequest
- HTTP requesthttpResponse
- HTTP responsewindowLabel
- window labelMethod Detail |
---|
public static WindowURL createWindowURL(javax.servlet.http.HttpServletRequest _httpRequest, javax.servlet.http.HttpServletResponse _httpResponse)
Returns a WindowURL to the current portlet.
_httpRequest
- HTTP request_httpResponse
- HTTP response
public static WindowURL createWindowURL(javax.servlet.http.HttpServletRequest _httpRequest, javax.servlet.http.HttpServletResponse _httpResponse, String windowLabel)
Returns a WindowURL to the specified portlet.
_httpRequest
- HTTP request_httpResponse
- HTTP responsewindowLabel
- window label of the portlet, page or book to be targeted by this URL.
public void setWindowLabel(String windowLabel)
windowLabel
- the window label of the window this URL should target.public String getWindowLabel()
Returns the window label this URL is currently targeting.
public void setWindowMode(String windowMode)
Sets a portlet window mode for the portlet targeted by this URL.
windowMode
- the window mode to put the portlet targeted by this URL inpublic String getWindowMode()
Returns a window mode for the portlet targeted by this URL, if a window mode has been set.
null
if not set.public void setWindowState(String windowState)
Sets window state for the portlet targeted by this URL.
windowState
- the window state of the portlet targeted by this URLpublic String getWindowState()
Returns the window state for the portlet targeted by this URL, if a window state has been specified.
null
if not set.public void removeSharedParameter(String sharedParameterName)
sharedParameterName
- the name of the shared parameter to remove.
If this is not a valid shared parameter for the portlet targeted
by this URL, the parameter will not be removed when this URL is
invoked.public Object clone()
Returns a deep copy of this WindowURL.
clone
in class PostbackURL
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |