Top Description Methods
javax.portlet

public Interface RenderURL

extends PortletURL
Known Direct Implementers
javax.portlet.filter.RenderURLWrapper

This is a marker interface for a render URL.

A render URL is created with MimeResponse#createRenderURL().

Since
3.0

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The fragment identifier set on the URL, or null if no fragment identifier has been set.
getFragmentIdentifier
()

Gets the fragment identifier previously set on the URL.
public void
setFragmentIdentifier(String
The fragment identifier to be added to the URL
fragment
)

Sets a fragment identifier on the URL.
Inherited from javax.portlet.PortletURL:
removePublicRenderParametersetBeanParameter

Method Detail

getFragmentIdentifierback to summary
public String getFragmentIdentifier()

Gets the fragment identifier previously set on the URL.

A fragment identifier may have been set by the portlet using the setFragmentIdentifier method, or it may be a value set by the portal if the portlet had not previously set a fragment identifier.

Returns:String

The fragment identifier set on the URL, or null if no fragment identifier has been set.

See Also
setFragmentIdentifier
setFragmentIdentifierback to summary
public void setFragmentIdentifier(String fragment)

Sets a fragment identifier on the URL.

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.

Parameters
fragment:String

The fragment identifier to be added to the URL

See Also
getFragmentIdentifier