Package jakarta.portlet.annotations

Annotation Type Supports

  • @Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface Supports
    This annotation is used within composite portlet configuration annotations to specify the supported portlet modes and window states for a given content type. It cannot be used as a stand-alone portlet annotation.
    Since:
    3.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      String mimeType
      The MIME type for the supported portlet modes and window states listed in this annotation, for example "text/html".
      String[] portletModes
      Defines the portlet modes supported by this portlet.
      String[] windowStates
      Defines the window states supported by this portlet.

    • Element Detail

      • mimeType

        String mimeType
        The MIME type for the supported portlet modes and window states listed in this annotation, for example "text/html".

        The MIME type may also contain the wildcard character '*', for example "text/*" or "*/*".

        Returns:
        The MIME type
        Default:
        "text/html"

      • portletModes

        String[] portletModes
        Defines the portlet modes supported by this portlet.

        The following names represent the standard portlet modes: "edit", "help", "view". Custom portlet modes may also be defined.

        Portlet mode names are not case sensitive.

        Returns:
        The supported portlet modes
        Default:
        {"view"}

      • windowStates

        String[] windowStates
        Defines the window states supported by this portlet.

        The following names represent the standard window states: "normal", "minimized", "maximized". Custom window states may also be defined.

        Window state names are not case sensitive.

        Returns:
        The supported window states
        Default:
        {"normal", "minimized", "maximized"}