Package jakarta.portlet

Interface RenderURL

All Superinterfaces:

BaseURL, Mutable, MutableRenderState, PortletURL, RenderState

All Known Implementing Classes:

RenderURLWrapper

public interface RenderURL
extends PortletURL

This is a marker interface for a render URL.

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

Since:

3.0

Method Summary

Modifier and Type	Method	Description
String	getFragmentIdentifier()	Gets the fragment identifier previously set on the URL.
void	setFragmentIdentifier(String fragment)	Sets a fragment identifier on the URL.

Methods inherited from interface jakarta.portlet.BaseURL

addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write

Methods inherited from interface jakarta.portlet.MutableRenderState

getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface jakarta.portlet.PortletURL

removePublicRenderParameter, setBeanParameter

Methods inherited from interface jakarta.portlet.RenderState

getPortletMode, getWindowState

Method Detail

setFragmentIdentifier

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 - The fragment identifier to be added to the URL

See Also:

getFragmentIdentifier()

getFragmentIdentifier

String getFragmentIdentifier()

Gets the fragment identifier previously set on the URL.

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.

Returns:

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

See Also:

setFragmentIdentifier(java.lang.String)