public interface IPortletURL extends IPortletURL
Modifier and Type | Field and Description |
---|---|
static int |
TOSTRINGTYPE_GET_URL |
static int |
TOSTRINGTYPE_HTML_FORM_ACTION |
static int |
TOSTRINGTYPE_HTML_FORM_INPUTS |
static IURI |
UNPREFIXED_PARAMETERS_URI |
GLOBAL_PARAMETER_KEEP_STATE, GLOBAL_PARAMETER_RESET_STATE
Modifier and Type | Method and Description |
---|---|
IPortletURL |
addPortletURL(IURI anotherPortlet)
Creates portlet URL for another portlet on the the same target
page.
|
void |
clearParameters()
Removs all portlet parameters from the URL
|
String |
getBaseURL()
Returns base url for this portlet url.
|
void |
removeParameter(String name)
Removes a portlet paremeter from the URL
|
void |
setBaseURL(String url)
Sets base url for this portlet url.
|
void |
setParameter(String name,
String[] value,
boolean encodeValue)
Sets portlet parameter String[] value..
|
void |
setParameter(String name,
String value,
boolean encodeValue)
Sets portlet parameter String value.
|
void |
setPortletLayout(String pcaLayout)
Sets PCA layout to display
|
void |
setPortletMethod(String pcaMethod)
Sets PCA method name to invoke on the portlet
|
void |
setTargetAction(String targetAction)
Sets PCA method name to invoke on the portlet
|
void |
setTargetView(String targetView)
Sets target view to display on the portlet
|
String |
toString(int type)
Returns either full GET url or HTML form action plus set of hidden fields
|
addPortletURL, clearState, getPortletNamespace, removeGlobalParameter, removeParameter, setAXSRFT, setGlobalParameter, setParameter, setParameter, setPortlet
static final IURI UNPREFIXED_PARAMETERS_URI
static final int TOSTRINGTYPE_GET_URL
static final int TOSTRINGTYPE_HTML_FORM_ACTION
static final int TOSTRINGTYPE_HTML_FORM_INPUTS
void setBaseURL(String url) throws PortalException
setBaseURL
in interface IPortletURL
url
- PortalException
String getBaseURL()
getBaseURL
in interface IPortletURL
setBaseURL(String)
void setPortletMethod(String pcaMethod) throws PortalException
setPortletMethod
in interface IPortletURL
pcaMethod
- name of the methodPortalException
void setTargetAction(String targetAction) throws PortalException
setTargetAction
in interface IPortletURL
pcaMethod
- name of the methodPortalException
void setTargetView(String targetView) throws PortalException
setTargetView
in interface IPortletURL
targetView
- PortalException
void setPortletLayout(String pcaLayout) throws PortalException
setPortletLayout
in interface IPortletURL
pcaLayout
- the layout to displayPortalException
void clearParameters()
clearParameters
in interface IPortletURL
void removeParameter(String name)
removeParameter
in interface IPortletURL
name
- the name of the parameter to removevoid setParameter(String name, String value, boolean encodeValue)
setParameter
in interface IPortletURL
name
- the portlet parameter namevalue
- the parameter valueencodeValue
- false to not encode the value.void setParameter(String name, String[] value, boolean encodeValue)
setParameter
in interface IPortletURL
name
- the portlet parameter namevalue
- the parameter valueencodeValue
- false to not encode the valuesetParameter(String, String, boolean)
IPortletURL addPortletURL(IURI anotherPortlet) throws PortalException
anotherPortlet
- PortalException
String toString(int type)
type
- is TOSTRINGTYPE_HTML_FORM_ACTION
and
TOSTRINGTYPE_HTML_FORM_INPUTS
or TOSTRINGTYPE_GET_URL