Package io.goobi.viewer.model.cms.pages.content.types

Class CMSShortTextContent

java.lang.Object

io.goobi.viewer.model.cms.pages.content.CMSContent

io.goobi.viewer.model.cms.pages.content.types.CMSShortTextContent

All Implemented Interfaces:

TranslatableCMSContent, IPolyglott

@Entity
public class CMSShortTextContent
extends CMSContent
implements TranslatableCMSContent

CMS content for small texts, holding up to 4,294,967,295 characters (all translations combined)

Author:

florian

Constructor Summary

Constructors

Constructor	Description
CMSShortTextContent()
CMSShortTextContent(CMSShortTextContent orig)

Method Summary

Modifier and Type	Method	Description
CMSContent	copy()
List<File>	exportHtmlFragment(String outputFolderPath, String namingScheme)	Writes HTML fragment value as file for re-indexing.
String	getBackendComponentName()
String	getData(Integer w, Integer h)
Locale	getSelectedLocale()
TranslatedText	getText()
String	getTranslation()
String	handlePageLoad(boolean resetResults, CMSComponent component)	Method to call when loading a CMSPage including this content item
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()
boolean	isEmpty(Locale locale)	If this returns true, an associated language tab should have neither the 'already-translated' nor the '-partly-translated' class
boolean	isValid(Locale locale)	Only meaningfull for the default language for which all required fields must be filled
void	setSelectedLocale(Locale locale)	Set the locale to use for display and editing
void	setText(TranslatedText text)

Methods inherited from class io.goobi.viewer.model.cms.pages.content.CMSContent

getBackendComponentLibrary, getData, getId, getItemId, getOwningComponent, getOwningPage, isRequired, setId, setItemId, setOwningComponent, setRequired

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

Methods inherited from interface io.goobi.viewer.model.cms.pages.content.TranslatableCMSContent

getTranslation, isRequired

Constructor Details

CMSShortTextContent

public CMSShortTextContent()

CMSShortTextContent

public CMSShortTextContent(CMSShortTextContent orig)

Method Details

getBackendComponentName

public String getBackendComponentName()

Specified by:

getBackendComponentName in class CMSContent

getTranslation

public String getTranslation()

Specified by:

getTranslation in interface TranslatableCMSContent

getText

public TranslatedText getText()

Specified by:

getText in interface TranslatableCMSContent

setText

public void setText(TranslatedText text)

Specified by:

setText in interface TranslatableCMSContent

copy

public CMSContent copy()

Specified by:

copy in class CMSContent

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

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

isValid

public boolean isValid(Locale locale)

Description copied from interface: IPolyglott

Only meaningfull for the default language for which all required fields must be filled

Specified by:

isValid in interface IPolyglott

Returns:

true if all required fields contain a value in the given locale

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

Returns:

true if no fields are filled for the given locale

getSelectedLocale

public Locale getSelectedLocale()

Specified by:

getSelectedLocale in interface IPolyglott

Returns:

the locale currently set by IPolyglott.setSelectedLocale(Locale)

setSelectedLocale

public void setSelectedLocale(Locale locale)

Description copied from interface: IPolyglott

Set the locale to use for display and editing

Specified by:

setSelectedLocale in interface IPolyglott

exportHtmlFragment

public List<File> exportHtmlFragment(String outputFolderPath,
 String namingScheme)
                              throws IOException,
ViewerConfigurationException

Description copied from class: CMSContent

Writes HTML fragment value as file for re-indexing. HTML/text fragments are exported directly. Attached media items are exported as long as their content type is one of the supported text document formats.

Specified by:

exportHtmlFragment in class CMSContent

Parameters:

outputFolderPath - a String object.

namingScheme - a String object.

Returns:

Exported Files

Throws:

IOException - if any.

ViewerConfigurationException

handlePageLoad

public String handlePageLoad(boolean resetResults,
 CMSComponent component)
                      throws PresentationException

Description copied from class: CMSContent

Method to call when loading a CMSPage including this content item

Specified by:

handlePageLoad in class CMSContent

Returns:

a JSF action response

Throws:

PresentationException

getData

public String getData(Integer w,
 Integer h)

Specified by:

getData in class CMSContent

Returns:

a string representing this contentItem for use in frontend-components. May be an empty string for content with no clear String representation

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in class CMSContent