Enum Class DefaultWidgetType
- All Implemented Interfaces:
WidgetContentType
,Serializable
,Comparable<DefaultWidgetType>
,Constable
Types of widgets that are always available for CMS pages and cannot be configured
- Author:
- florian
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionBrowsing or "Stöbern" widget, containing all browse terms which are configured in the viewer-configDisplays search facetting for a page with search functionality.Displays a search input field and link to advanced searchDisplay the total number of records available in the viewer -
Method Summary
Modifier and TypeMethodDescriptionA message key for a description of this widget typeThe filename of the xhtml component for this widgetgetLabel()
Get a message key providing a label for this widgetgetName()
The enum value of this type, taken from the classes implementing this interfaceboolean
isAllowedForPage
(CMSPage page) boolean
isAllowedForPage
(CMSPageTemplate template) static DefaultWidgetType
Returns the enum constant of this class with the specified name.static DefaultWidgetType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
WIDGET_BROWSING
Browsing or "Stöbern" widget, containing all browse terms which are configured in the viewer-config -
WIDGET_FACETTING
Displays search facetting for a page with search functionality. Always displays the facet fields configured in viewer-config Also includes chronology-facetting (by year) and geospatial facetting (on a map) which are displayed as independent widgets in the GUI -
WIDGET_SEARCH
Displays a search input field and link to advanced search -
WIDGET_WORKCOUNT
Display the total number of records available in the viewer -
WIDGET_HIGHLIGHT
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getIconClass
- Specified by:
getIconClass
in interfaceWidgetContentType
-
getLabel
Description copied from interface:WidgetContentType
Get a message key providing a label for this widget- Specified by:
getLabel
in interfaceWidgetContentType
- Returns:
String
-
getDescription
A message key for a description of this widget type- Returns:
- the description
-
getFilename
Description copied from interface:WidgetContentType
The filename of the xhtml component for this widget- Specified by:
getFilename
in interfaceWidgetContentType
- Returns:
String
-
getName
Description copied from interface:WidgetContentType
The enum value of this type, taken from the classes implementing this interface- Specified by:
getName
in interfaceWidgetContentType
- Returns:
String
-
isAllowedForPage
- Specified by:
isAllowedForPage
in interfaceWidgetContentType
-
isAllowedForPage
- Specified by:
isAllowedForPage
in interfaceWidgetContentType
-