public interface RenderURL extends PortletURL
A render URL is created with MimeResponse.createRenderURL()
.
Modifier and Type | Method and Description |
---|---|
String |
getFragmentIdentifier()
Gets the fragment identifier previously set on the URL.
|
void |
setFragmentIdentifier(String fragment)
Sets a fragment identifier on the URL.
|
removePublicRenderParameter, setBeanParameter
addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write
getRenderParameters, setPortletMode, setWindowState
getPortletMode, getWindowState
void setFragmentIdentifier(String fragment)
Any previously set fragment identifier will be replaced.
The fragment identifier consists of additional information appended to the URL after a '#' character. A URL can have only a single fragment identifier. The fragment identifier must be formed according to rfc3986.
The fragment identifier is often used to address a named anchor such as
<a name="#fragmentIdentifier">
, but it can also be
used for other purposes such as to pass information to a JavaScript routine.
The fragment identifier will not be namespaced. The portlet is responsible for performing any required namespacing. However, the fragment identifier string will be escaped as required.
Setting the fragment identifier to null
will remove a
fragment identifier previously set through this method. Setting the
empty string as the fragment identifier will create an empty fragment
identifier.
fragment
- The fragment identifier to be added to the URLgetFragmentIdentifier()
String getFragmentIdentifier()
A fragment identifier may have been set by the portlet
using the setFragmentIdentifier(java.lang.String)
method, or it may
be a value set by the portal if the portlet had not previously set a
fragment identifier.
null
if no fragment identifier has been set.setFragmentIdentifier(java.lang.String)
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.