Annotation Type PublicRenderParameterDefinition


  • @Retention(RUNTIME)
    @Target(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 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 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

        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

        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

        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

        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:
        {}