Package org.opencms.file.types

Class CmsResourceTypeSubsitemapContentFolder

java.lang.Object

org.opencms.file.types.A_CmsResourceType

org.opencms.file.types.A_CmsResourceTypeFolderBase

org.opencms.file.types.CmsResourceTypeFolderExtended

org.opencms.file.types.CmsResourceTypeSubsitemapContentFolder

All Implemented Interfaces:

Serializable, I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsResourceTypeSubsitemapContentFolder
extends CmsResourceTypeFolderExtended

Content type class for subsitemap content folders.

Has special handling for copy resources.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType

I_CmsResourceType.Formatter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CONFIG_SOURCE	The default value for the config file copy source.

Fields inherited from class org.opencms.file.types.CmsResourceTypeFolderExtended

CONFIGURATION_FOLDER_CLASS, CONFIGURATION_FOLDER_CLASS_PARAMS

Fields inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase

ATTR_SHALLOW_FOLDER_COPY

Fields inherited from class org.opencms.file.types.A_CmsResourceType

CONFIGURATION_GALLERY_JAVASCRIPT_PATH, CONFIGURATION_GALLERY_PREVIEW_PROVIDER, CONFIGURATION_GALLERY_TYPE_NAMES, CONFIGURATION_INTERNAL, DEFAULT_GALLERY_PREVIEW_PROVIDER, m_addititionalModuleResourceType, m_className, m_configuration, m_copyResources, m_defaultProperties, m_frozen, m_galleryPreviewProvider, m_mappings, m_moduleName, m_typeId, m_typeName, MACRO_RESOURCE_FOLDER_PATH, MACRO_RESOURCE_FOLDER_PATH_TOUCH, MACRO_RESOURCE_NAME, MACRO_RESOURCE_PARENT_PATH, MACRO_RESOURCE_ROOT_PATH, MACRO_RESOURCE_SITE_PATH

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Fields inherited from interface org.opencms.file.types.I_CmsResourceType

ADD_MAPPING_METHOD, ADD_RESOURCE_TYPE_METHOD, CONFIGURATION_PROPERTY_CREATE, CONFIGURATION_RESOURCE_TYPE_ID, CONFIGURATION_RESOURCE_TYPE_NAME, PROPERTY_ON_RESOURCE, PROPERTY_ON_STRUCTURE

Constructor Summary

Constructors

Constructor	Description
CmsResourceTypeSubsitemapContentFolder()

Method Summary

Modifier and Type	Method	Description
protected List<CmsConfigurationCopyResource>	getCopyResources(CmsObject cms, String resourcename, CmsMacroResolver resolver)	Gets the actual copy resources to use when creating a resource.
static boolean	isEnableNewPageFormatByDefault()	Checks if the 'use formatter keys' option should be enabled by default in generated sitemap configurations.
static void	setEnableNewPageFormatByDefault(boolean enabled)	Enables / disables the default value to use for 'use formatter keys' option in generated sitemap configurations.

Methods inherited from class org.opencms.file.types.CmsResourceTypeFolderExtended

addConfigurationParameter, getConfiguration, getFolderClassName, getFolderClassParams

Methods inherited from class org.opencms.file.types.A_CmsResourceTypeFolderBase

chtype, copyResource, createResource, getLoaderId, isFolder, moveResource, replaceResource, setDateExpired, setDateLastModified, setDateReleased, undelete, undoChanges

Methods inherited from class org.opencms.file.types.A_CmsResourceType

addCopyResource, addDefaultProperty, addMappingType, changeLock, chflags, chtype, copyResourceToProject, createRelations, createSibling, deleteResource, equals, getAdjustLinksFolder, getCachePropertyDefault, getClassName, getConfiguredCopyResources, getConfiguredDefaultProperties, getConfiguredMappings, getFormattersForResource, getGalleryPreviewProvider, getGalleryTypes, getMacroResolver, getModuleName, getResourceType, getTypeId, getTypeName, hashCode, importResource, initConfiguration, initConfiguration, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, replaceResource, restoreResource, setAdditionalModuleResourceType, setAdjustLinksFolder, setModuleName, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_CONFIG_SOURCE

public static final String DEFAULT_CONFIG_SOURCE

The default value for the config file copy source.

See Also:

• Constant Field Values

Constructor Details

CmsResourceTypeSubsitemapContentFolder

public CmsResourceTypeSubsitemapContentFolder()

Method Details

isEnableNewPageFormatByDefault

public static boolean isEnableNewPageFormatByDefault()

Checks if the 'use formatter keys' option should be enabled by default in generated sitemap configurations.

Returns:

true if the 'use formatter keys' option should be enabled by default

setEnableNewPageFormatByDefault

public static void setEnableNewPageFormatByDefault(boolean enabled)

Enables / disables the default value to use for 'use formatter keys' option in generated sitemap configurations.

Parameters:

enabled - the default value for the 'use formatter keys' option

getCopyResources

protected List<CmsConfigurationCopyResource> getCopyResources(CmsObject cms,
 String resourcename,
 CmsMacroResolver resolver)

Description copied from class: A_CmsResourceType

Gets the actual copy resources to use when creating a resource.

Overrides:

getCopyResources in class A_CmsResourceType

Parameters:

cms - the CMS context

resourcename - the path of the resource to create

resolver - the macro resolver to use

Returns:

the copy resources to use

See Also:

• A_CmsResourceType.getCopyResources(org.opencms.file.CmsObject, java.lang.String, org.opencms.util.CmsMacroResolver)