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

Interface WidgetContentType

All Known Implementing Classes:

AutomaticWidgetType, CustomWidgetType, DefaultWidgetType

public interface WidgetContentType

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getFilename()	The filename of the xhtml component for this widget.
static WidgetGenerationType	getGenerationType(WidgetContentType type)	Get the corresponding generation type.
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 WidgetContentType	valueOf(String name)	Get the WidgetContentType for which getName() method matches the given name.

Method Details

getIconClass

String getIconClass()

getLabel

String getLabel()

Get a message key providing a label for this widget.

Returns:

String

getFilename

String getFilename()

The filename of the xhtml component for this widget.

Returns:

String

getName

String getName()

The enum value of this type, taken from the classes implementing this interface.

Returns:

String

valueOf

static WidgetContentType valueOf(String name)

Get the WidgetContentType for which getName() method matches the given name.

Parameters:

name -

Returns:

null if no matching type exists

getGenerationType

static WidgetGenerationType getGenerationType(WidgetContentType type)

Get the corresponding generation type. Widgets of class DefaultWidgetType have the generation type WidgetGenerationType.DEFAULT Widgets of class AutomaticWidgetType have the generation type WidgetGenerationType.AUTOMATIC Widgets of class CustomWidgetType have the generation type WidgetGenerationType.CUSTOM

Parameters:

type -

Returns:

WidgetGenerationType

isAllowedForPage

boolean isAllowedForPage(CMSPage page)

getDescription

String getDescription()

isAllowedForPage

boolean isAllowedForPage(CMSPageTemplate template)