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

Class HtmlSidebarWidget

java.lang.Object

io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

io.goobi.viewer.model.cms.widgets.HtmlSidebarWidget

All Implemented Interfaces:

IPolyglott, Serializable

@Entity
public class HtmlSidebarWidget
extends CustomSidebarWidget

A subtype of CustomSidebarWidget to display a html text in different languages.

Author:

Florian Alpers

See Also:

• Serialized Form

Field Summary

Fields inherited from class io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

id

Constructor Summary

Constructors

Constructor	Description
HtmlSidebarWidget()	Empty default constructor.
HtmlSidebarWidget(HtmlSidebarWidget o)	Cloning constructor.

Method Summary

Modifier and Type	Method	Description
TranslatedText	getHtmlText()
de.intranda.metadata.multilanguage.IMetadataValue	getShortDescription(int maxLength)
CustomWidgetType	getType()	Return the type of this custom sidebar widget.
boolean	isComplete(Locale locale)	If this returns true, an associated language tab should have the 'already-translated' class, otherwise the '-partly-translated' class unless IPolyglott.isEmpty(Locale) also returns true.
boolean	isEmpty(Locale locale)	If this returns true, an associated language tab should have neither the 'already-translated' nor the '-partly-translated' class.
boolean	isHasShortDescription()
void	setSelectedLocale(Locale locale)	Sets the locale to use for display and editing.

Methods inherited from class io.goobi.viewer.model.cms.widgets.CustomSidebarWidget

clone, getAdminBackendUrl, getDescription, getId, getSelectedLocale, getStyleClass, getTitle, isCollapsed, isValid, setCollapsed, setId, setStyleClass, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.goobi.viewer.model.translations.IPolyglott

getLocales, isDefaultLocaleSelected, isSelected, setSelectedLocale

Constructor Details

HtmlSidebarWidget

public HtmlSidebarWidget()

Empty default constructor.

HtmlSidebarWidget

public HtmlSidebarWidget(HtmlSidebarWidget o)

Cloning constructor.

Parameters:

o - widget instance to clone

Method Details

getHtmlText

public TranslatedText getHtmlText()

Returns:

the html text

isComplete

public boolean isComplete(Locale locale)

Description copied from interface: IPolyglott

If this returns true, an associated language tab should have the 'already-translated' class, otherwise the '-partly-translated' class unless IPolyglott.isEmpty(Locale) also returns true.

Specified by:

isComplete in interface IPolyglott

Overrides:

isComplete in class CustomSidebarWidget

Parameters:

locale - the locale to check translation completeness for

Returns:

true if IPolyglott.isValid(Locale) returns true for the given locale and all fields contain a value which have a value in the default locale. For the default locale, IPolyglott.isComplete(Locale) and IPolyglott.isValid(Locale) are identical. For implementations with only one field, both methods are also always identical

isEmpty

public boolean isEmpty(Locale locale)

Description copied from interface: IPolyglott

If this returns true, an associated language tab should have neither the 'already-translated' nor the '-partly-translated' class.

Specified by:

isEmpty in interface IPolyglott

Overrides:

isEmpty in class CustomSidebarWidget

Parameters:

locale - the locale to check for empty fields

Returns:

true if no fields are filled for the given locale

setSelectedLocale

public void setSelectedLocale(Locale locale)

Description copied from interface: IPolyglott

Sets the locale to use for display and editing.

Specified by:

setSelectedLocale in interface IPolyglott

Overrides:

setSelectedLocale in class CustomSidebarWidget

Parameters:

locale - the locale to select

getType

public CustomWidgetType getType()

Description copied from class: CustomSidebarWidget

Return the type of this custom sidebar widget. Must be implemented by subclasses of CustomSidebarWidget

Overrides:

getType in class CustomSidebarWidget

Returns:

CustomWidgetType

isHasShortDescription

public boolean isHasShortDescription()

Overrides:

isHasShortDescription in class CustomSidebarWidget

getShortDescription

public de.intranda.metadata.multilanguage.IMetadataValue getShortDescription(int maxLength)

Overrides:

getShortDescription in class CustomSidebarWidget