Java Portlet API V3.0 3.0.1 · javax.portlet.filter.RenderURLWrapper

Access	Constructor and Description
public	RenderURLWrapper(RenderURL the wrapped object to set. wrapped)

Method Summary

Modifier and Type	Method and Description
public String	getFragmentIdentifier() Implements javax.portlet.RenderURL.getFragmentIdentifier. Gets the fragment identifier previously set on the URL.
public RenderURL	Returns: the wrapped object. getWrapped() Overrides javax.portlet.filter.PortletURLWrapper.getWrapped. Gets the wrapped object.
public void	setFragmentIdentifier(String The fragment identifier to be added to the URL fragment) Implements javax.portlet.RenderURL.setFragmentIdentifier. Sets a fragment identifier on the URL.
public void	setWrapped(RenderURL the wrapped object to set. wrapped) Sets the wrapped object.

Inherited from javax.portlet.filter.PortletURLWrapper:: getRenderParameters removePublicRenderParameter setBeanParameter setPortletMode setWindowState setWrapped

RenderURLWrapper	back to summary
public RenderURLWrapper(RenderURL wrapped) Parameters wrapped:RenderURL the wrapped object to set. Exceptions IllegalArgumentException: if the RenderURL is null.

Method Detail

getFragmentIdentifier back to summary

getFragmentIdentifier	back to summary
public String getFragmentIdentifier() Implements javax.portlet.RenderURL.getFragmentIdentifier. Doc from javax.portlet.RenderURL.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. Annotations @Override

public String getFragmentIdentifier()

Implements javax.portlet.RenderURL.getFragmentIdentifier.

Doc from javax.portlet.RenderURL.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.

Annotations

@Override

getWrapped	back to summary
public RenderURL getWrapped() Overrides javax.portlet.filter.PortletURLWrapper.getWrapped. Gets the wrapped object. Returns:RenderURL the wrapped object.

getWrapped

back to summary

public RenderURL getWrapped()

Overrides javax.portlet.filter.PortletURLWrapper.getWrapped.

Gets the wrapped object.

Returns:RenderURL: the wrapped object.

setFragmentIdentifier back to summary

setFragmentIdentifier	back to summary
public void setFragmentIdentifier(String fragment) Implements javax.portlet.RenderURL.setFragmentIdentifier. Doc from javax.portlet.RenderURL.setFragmentIdentifier. 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 Annotations @Override

public void setFragmentIdentifier(String fragment)

Implements javax.portlet.RenderURL.setFragmentIdentifier.

Doc from javax.portlet.RenderURL.setFragmentIdentifier.

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

Annotations

@Override

setWrapped	back to summary
public void setWrapped(RenderURL wrapped) Sets the wrapped object. Parameters wrapped:RenderURL the wrapped object to set. Exceptions IllegalArgumentException: if the RenderURL is null.

setWrapped

back to summary

public void setWrapped(RenderURL wrapped)

Sets the wrapped object.

Parameters

wrapped:RenderURL: the wrapped object to set.

Exceptions

IllegalArgumentException:: if the RenderURL is null.

public Class RenderURLWrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail