Package io.goobi.viewer.model.cms.widgets.type

Enum Class CustomWidgetType

java.lang.Object
java.lang.Enum<CustomWidgetType>
io.goobi.viewer.model.cms.widgets.type.CustomWidgetType
All Implemented Interfaces:
WidgetContentType, Serializable, Comparable<CustomWidgetType>, Constable
public enum CustomWidgetType extends Enum<CustomWidgetType> implements WidgetContentType
Types of sidebar widgets that contain individual configuration and must be created by a user
Author:
florian

  • Enum Constant Details

    • WIDGET_RSSFEED

      public static final CustomWidgetType WIDGET_RSSFEED
      Displays an RSS feed. Number and sorting of feed item may be configured, as well as a search query to filter the feed items

    • WIDGET_FIELDFACETS

      public static final CustomWidgetType WIDGET_FIELDFACETS
      Display facets for a search field of type 'FACET_'. A filter query for facet results may be configured, as well as the order of facets

    • WIDGET_CMSPAGES

      public static final CustomWidgetType WIDGET_CMSPAGES
      Displays links to CMS pages. The linked pages can be selected when creating the widget

    • WIDGET_HTML

      public static final CustomWidgetType WIDGET_HTML
      Display an html text

  • Method Details

    • values

      public static CustomWidgetType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CustomWidgetType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getIconClass

      public String getIconClass()
      Specified by:
      getIconClass in interface WidgetContentType

    • getLabel

      public String getLabel()
      Description copied from interface: WidgetContentType
      Get a message key providing a label for this widget
      Specified by:
      getLabel in interface WidgetContentType
      Returns:
      String

    • getDescription

      public String getDescription()
      A message key for a description of ths widget type
      Returns:
      the description

    • getFilename

      public String getFilename()
      Description copied from interface: WidgetContentType
      The filename of the xhtml component for this widget
      Specified by:
      getFilename in interface WidgetContentType
      Returns:
      String

    • getName

      public String getName()
      Description copied from interface: WidgetContentType
      The enum value of this type, taken from the classes implementing this interface
      Specified by:
      getName in interface WidgetContentType
      Returns:
      String

    • isAllowedForPage

      public boolean isAllowedForPage(CMSPage page)
      Specified by:
      isAllowedForPage in interface WidgetContentType

    • isAllowedForPage

      public boolean isAllowedForPage(CMSPageTemplate template)
      Specified by:
      isAllowedForPage in interface WidgetContentType