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

Enum Class AutomaticWidgetType

java.lang.Object

java.lang.Enum<AutomaticWidgetType>

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

All Implemented Interfaces:

WidgetContentType, Serializable, Comparable<AutomaticWidgetType>, Constable

public enum AutomaticWidgetType
extends Enum<AutomaticWidgetType>
implements WidgetContentType

All types of sidebar widgets which are generated automatically if certain conditions are met, usually if certain CMS content exists Currently (22-01) only CMS-Geomaps provide automatic widgets

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_CMSGEOMAP	Widget displaying a geomap created in CMS

Method Summary

Modifier and Type	Method	Description
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 AutomaticWidgetType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AutomaticWidgetType[]	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_CMSGEOMAP

public static final AutomaticWidgetType WIDGET_CMSGEOMAP

Widget displaying a geomap created in CMS

Method Details

values

public static AutomaticWidgetType[] 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 AutomaticWidgetType 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

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