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

Enum Class DefaultWidgetType

java.lang.Object

java.lang.Enum<DefaultWidgetType>

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

All Implemented Interfaces:

WidgetContentType, Serializable, Comparable<DefaultWidgetType>, Constable

public enum DefaultWidgetType
extends Enum<DefaultWidgetType>
implements WidgetContentType

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 Constants

Enum Constant	Description
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.
WIDGET_HIGHLIGHT
WIDGET_SEARCH	Displays a search input field and link to advanced search
WIDGET_WORKCOUNT	Display the total number of records available in the viewer

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A message key for a description of this widget type
String	getFilename()	The filename of the xhtml component for this widget.
String	getIconClass()
String	getLabel()	Get a message key providing a label for this widget.
String	getName()	The enum value of this type, taken from the classes implementing this interface.
boolean	isAllowedForPage(CMSPage page)
boolean	isAllowedForPage(CMSPageTemplate template)
static DefaultWidgetType	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WIDGET_BROWSING

public static final DefaultWidgetType WIDGET_BROWSING

Browsing or "Stöbern" widget, containing all browse terms which are configured in the viewer-config

WIDGET_FACETTING

public static final DefaultWidgetType 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

public static final DefaultWidgetType WIDGET_SEARCH

Displays a search input field and link to advanced search

WIDGET_WORKCOUNT

public static final DefaultWidgetType WIDGET_WORKCOUNT

Display the total number of records available in the viewer

WIDGET_HIGHLIGHT

public static final DefaultWidgetType WIDGET_HIGHLIGHT

Method Details

values

public static DefaultWidgetType[] 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 DefaultWidgetType 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 this widget type

Specified by:

getDescription in interface WidgetContentType

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