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

Class CMSPageListContent

java.lang.Object

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

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

All Implemented Interfaces:

CMSCategoryHolder

@Entity
public class CMSPageListContent
extends CMSContent
implements CMSCategoryHolder

Constructor Summary

Constructors

Constructor	Description
CMSPageListContent()

Method Summary

Modifier and Type	Method	Description
boolean	addCategory(CMSCategory category)
CMSContent	copy()
List<File>	exportHtmlFragment(String outputFolderPath, String namingScheme)	Writes HTML fragment value as file for re-indexing.
String	getBackendComponentName()
List<CMSCategory>	getCategories()
String	getData(Integer w, Integer h)
List<CMSPage>	getNestedPages(Boolean random, CMSTemplateManager templateManager)	Getter for the field nestedPages.
List<CMSPage>	getNestedPages(Boolean random, Boolean paged, CMSTemplateManager templateManager)	Deprecated. use getNestedPages(Boolean, CMSTemplateManager) instead
List<CMSPage>	getNestedPagesByCategory(boolean random, boolean paged, CMSCategory category, CMSTemplateManager templateManager)	Deprecated. use getNestedPagesByCategory(boolean, CMSCategory, CMSTemplateManager) instead
List<CMSPage>	getNestedPagesByCategory(boolean random, CMSCategory category, CMSTemplateManager templateManager)	Getter for the field nestedPages.
int	getNestedPagesCount()	Getter for the field nestedPagesCount.
List<CheckboxSelectable<CMSCategory>>	getSelectableCategories()
List<CMSCategory>	getSortedCategories(int pageNo, boolean random, boolean paged, CMSTemplateManager templateManager)	getSortedCategories.
String	handlePageLoad(boolean resetResults, CMSComponent component)	Method to call when loading a CMSPage including this content item
boolean	isEmpty()
boolean	isGroupByCategory()
boolean	removeCategory(CMSCategory category)
void	resetData()	resetData.
void	setGroupByCategory(boolean groupByCategory)
void	setNestedPagesCount(int nestedPages)	Setter for the field nestedPagesCount.

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

Constructor Details

CMSPageListContent

public CMSPageListContent()

Method Details

getBackendComponentName

public String getBackendComponentName()

Specified by:

getBackendComponentName in class CMSContent

getCategories

public List<CMSCategory> getCategories()

Specified by:

getCategories in interface CMSCategoryHolder

getSelectableCategories

public List<CheckboxSelectable<CMSCategory>> getSelectableCategories()
                                                              throws DAOException

Throws:

DAOException

copy

public CMSContent copy()

Specified by:

copy in class CMSContent

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

addCategory

public boolean addCategory(CMSCategory category)

Specified by:

addCategory in interface CMSCategoryHolder

removeCategory

public boolean removeCategory(CMSCategory category)

Specified by:

removeCategory in interface CMSCategoryHolder

getNestedPages

@Deprecated(since="24.02")
public List<CMSPage> getNestedPages(Boolean random,
 Boolean paged,
 CMSTemplateManager templateManager)
                             throws DAOException

Deprecated.

use getNestedPages(Boolean, CMSTemplateManager) instead

Getter for the field nestedPages.

Parameters:

random -

paged -

templateManager -

Returns:

a List object.

Throws:

DAOException - if any.

getNestedPages

public List<CMSPage> getNestedPages(Boolean random,
 CMSTemplateManager templateManager)
                             throws DAOException

Getter for the field nestedPages.

Parameters:

random -

templateManager -

Returns:

a List object.

Throws:

DAOException - if any.

getNestedPagesByCategory

@Deprecated(since="24.02")
public List<CMSPage> getNestedPagesByCategory(boolean random,
 boolean paged,
 CMSCategory category,
 CMSTemplateManager templateManager)
                                       throws DAOException

Deprecated.

use getNestedPagesByCategory(boolean, CMSCategory, CMSTemplateManager) instead

Getter for the field nestedPages.

Parameters:

random -

paged -

category - a CMSCategory object.

templateManager -

Returns:

a List object.

Throws:

DAOException - if any.

getNestedPagesByCategory

public List<CMSPage> getNestedPagesByCategory(boolean random,
 CMSCategory category,
 CMSTemplateManager templateManager)
                                       throws DAOException

Getter for the field nestedPages.

Parameters:

random -

category - a CMSCategory object.

templateManager -

Returns:

a List object.

Throws:

DAOException - if any.

resetData

public void resetData()

resetData.

getNestedPagesCount

public int getNestedPagesCount()

Getter for the field nestedPagesCount.

Returns:

a int.

setNestedPagesCount

public void setNestedPagesCount(int nestedPages)

Setter for the field nestedPagesCount.

Parameters:

nestedPages - a int.

getSortedCategories

public List<CMSCategory> getSortedCategories(int pageNo,
 boolean random,
 boolean paged,
 CMSTemplateManager templateManager)
                                      throws DAOException

getSortedCategories.

Parameters:

pageNo -

random -

paged -

templateManager -

Returns:

a List object.

Throws:

DAOException - if any.

setGroupByCategory

public void setGroupByCategory(boolean groupByCategory)

isGroupByCategory

public boolean isGroupByCategory()

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