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

Class CMSSidebarElementCustom

java.lang.Object

io.goobi.viewer.model.cms.widgets.embed.CMSSidebarElement

io.goobi.viewer.model.cms.widgets.embed.CMSSidebarElementCustom

All Implemented Interfaces:

Serializable

@Entity
public class CMSSidebarElementCustom
extends CMSSidebarElement

Wrapper element for custom (user created) sidebar widgets. Linked to an instance of CustomSidebarWidget providing the data to display

Author:

Florian Alpers

See Also:

• Serialized Form

Field Summary

Fields inherited from class io.goobi.viewer.model.cms.widgets.embed.CMSSidebarElement

HASH_MULTIPLIER, WIDGET_TYPE_AUTOMATIC, WIDGET_TYPE_CUSTOM, WIDGET_TYPE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
CMSSidebarElementCustom()	Empty contructor for the DAO.
CMSSidebarElementCustom(CustomSidebarWidget widget, CMSPage owner)	Default constructor for a CustomSidebarWidget providing the data and an owning CMSPage.
CMSSidebarElementCustom(CustomSidebarWidget widget, CMSPageTemplate owner)
CMSSidebarElementCustom(CMSSidebarElementCustom orig, CMSPage owner)	Cloning constructor with a CMSPage to set as owner.
CMSSidebarElementCustom(CMSSidebarElementCustom orig, CMSPageTemplate owner)

Method Summary

Modifier and Type	Method	Description
boolean	canEdit()
String	getAdminBackendUrl()
TranslatedText	getDescription()
TranslatedText	getTitle()	Gets the title of the underlying widget.
CustomSidebarWidget	getWidget()	Gets the CustomSidebarWidget providing the data.
void	setWidget(CustomSidebarWidget widget)

Methods inherited from class io.goobi.viewer.model.cms.widgets.embed.CMSSidebarElement

copy, copy, getContentType, getGenerationType, getId, getOrder, getOwnerPage, getOwnerTemplate, setContentType, setGenerationType, setId, setOrder, setOwnerPage, setOwnerTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CMSSidebarElementCustom

public CMSSidebarElementCustom()

Empty contructor for the DAO.

CMSSidebarElementCustom

public CMSSidebarElementCustom(CustomSidebarWidget widget,
 CMSPage owner)

Default constructor for a CustomSidebarWidget providing the data and an owning CMSPage.

Parameters:

widget - the custom sidebar widget providing the data

owner - the owning CMS page

CMSSidebarElementCustom

public CMSSidebarElementCustom(CustomSidebarWidget widget,
 CMSPageTemplate owner)

CMSSidebarElementCustom

public CMSSidebarElementCustom(CMSSidebarElementCustom orig,
 CMSPage owner)

Cloning constructor with a CMSPage to set as owner.

Parameters:

orig - original sidebar element to clone

owner - the owning CMS page

CMSSidebarElementCustom

public CMSSidebarElementCustom(CMSSidebarElementCustom orig,
 CMSPageTemplate owner)

Method Details

getWidget

public CustomSidebarWidget getWidget()

Gets the CustomSidebarWidget providing the data.

Returns:

the CustomSidebarWidget backing this sidebar element

setWidget

public void setWidget(CustomSidebarWidget widget)

Parameters:

widget - the custom sidebar widget to set

getTitle

public TranslatedText getTitle()

Gets the title of the underlying widget.

Overrides:

getTitle in class CMSSidebarElement

Returns:

the title of the underlying CustomSidebarWidget as a TranslatedText

getDescription

public TranslatedText getDescription()

Overrides:

getDescription in class CMSSidebarElement

canEdit

public boolean canEdit()

Overrides:

canEdit in class CMSSidebarElement

getAdminBackendUrl

public String getAdminBackendUrl()

Overrides:

getAdminBackendUrl in class CMSSidebarElement