javax.portlet.annotations

Annotation Type PublicRenderParameterDefinition

@Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface PublicRenderParameterDefinition

This annotation is used within composite portlet configuration annotations to represent a single public render parameter. It cannot be used as a stand-alone portlet annotation.

Since:

3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	identifier The public render parameter identifier.
PortletQName	qname The public render parameter Qname.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
LocaleString[]	description Provides locale-specific text describing the public render parameter for use by the portal application or by tools.
LocaleString[]	displayName The display-name type contains a locale-specific short name that is intended to be displayed by tools.

Element Detail

identifier

public abstract String identifier

The public render parameter identifier.

This identifier is used as the public render parameter name in the portlet parameter handling interfaces.

The public render parameter identifier must be unique within the portlet application.

Returns:

The public render parameter identifier

See Also:

PortletConfig#getPublicRenderParameterNames

qname

public abstract PortletQName qname

The public render parameter Qname.

The public render parameter qname must be unique within the portlet application.

Returns:

The qname

See Also:

QName, Qname definition

description

public abstract LocaleString[] description

Provides locale-specific text describing the public render parameter for use by the portal application or by tools.

Returns:

The public render parameter description

Default:

{}

displayName

public abstract LocaleString[] displayName

The display-name type contains a locale-specific short name that is intended to be displayed by tools. It is used by display-name elements. The display name need not be unique.

Returns:

The display name

Default:

{}