Top Description Methods
javax.portlet.annotations

public @Interface PublicRenderParameterDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:ANNOTATION_TYPE
Imports
java.lang.annotation.Retention, .Target

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

Method Summary

Modifier and TypeMethod and Description
public LocaleString[]

Returns:

The public render parameter description
description
()

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

Returns:

The display name
displayName
()

The display-name type contains a locale-specific short name that is intended to be displayed by tools.
public String

Returns:

The public render parameter identifier
identifier
()

The public render parameter identifier.
public PortletQName

Returns:

The qname
qname
()

The public render parameter Qname.
Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public LocaleString[] description()

Provides locale-specific text describing the public render parameter for use by the portal application or by tools.
Returns:LocaleString[]

The public render parameter description

displayNameback to summary
public 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:LocaleString[]

The display name

identifierback to summary
public 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:String

The public render parameter identifier

See Also
PortletConfig#getPublicRenderParameterNames
qnameback to summary
public PortletQName qname()

The public render parameter Qname.

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

Returns:PortletQName

The qname

See Also
javax.xml.namespace.QName, Qname definition