Annotation Type CustomPortletMode


  • @Retention(RUNTIME)
    @Target(ANNOTATION_TYPE)
    public @interface CustomPortletMode
    This annotation is used within composite portlet configuration annotations to represent a custom portlet mode. 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 name
      The custom portlet mode name.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      LocaleString[] description
      Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
      boolean portalManaged
      The portal managed flag.
    • Element Detail

      • name

        String name
        The custom portlet mode name.

        The name by which the portlet mode is identified.

        Returns:
        The custom portlet mode name
      • description

        LocaleString[] description
        Provides locale-specific text describing the custom portlet mode for use by the portal application or by tools.
        Returns:
        The custom portlet mode description
        Default:
        {}
      • portalManaged

        boolean portalManaged
        The portal managed flag.

        If set to true, the custom portlet mode will be managed by the portal. If set to false, the custom portlet mode will be managed by the portlet.

        Returns:
        The portal managed flag setting
        Default:
        true