Package org.opencms.file.types
Class CmsResourceTypeFolderExtended
- java.lang.Object
-
- org.opencms.file.types.A_CmsResourceType
-
- org.opencms.file.types.A_CmsResourceTypeFolderBase
-
- org.opencms.file.types.CmsResourceTypeFolderExtended
-
- All Implemented Interfaces:
java.io.Serializable
,I_CmsConfigurationParameterHandler
,I_CmsResourceType
- Direct Known Subclasses:
CmsResourceTypeFolderSubSitemap
,CmsResourceTypeSubsitemapContentFolder
public class CmsResourceTypeFolderExtended extends A_CmsResourceTypeFolderBase
Resource type descriptor for extended folder types (like for example the workplace galleries).This type extends a folder but has a configurable type id and type name. Optionally, a workplace class name for the type and a parameter String can be provided.
- Since:
- 6.0.0
- 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 java.lang.String
CONFIGURATION_FOLDER_CLASS
Configuration key for the optional folder class name.static java.lang.String
CONFIGURATION_FOLDER_CLASS_PARAMS
Configuration key for the optional folder class parameters.-
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 CmsResourceTypeFolderExtended()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance.CmsParameterConfiguration
getConfiguration()
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.java.lang.String
getFolderClassName()
Returns the (optional) configured folder class name for this folder.java.lang.String
getFolderClassParams()
Returns the (optional) configured folder class parameters name for this folder.-
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, getCopyResources, 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
-
-
-
-
Field Detail
-
CONFIGURATION_FOLDER_CLASS
public static final java.lang.String CONFIGURATION_FOLDER_CLASS
Configuration key for the optional folder class name.- See Also:
- Constant Field Values
-
CONFIGURATION_FOLDER_CLASS_PARAMS
public static final java.lang.String CONFIGURATION_FOLDER_CLASS_PARAMS
Configuration key for the optional folder class parameters.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsResourceTypeFolderExtended
public CmsResourceTypeFolderExtended()
-
-
Method Detail
-
addConfigurationParameter
public void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
Description copied from interface:I_CmsConfigurationParameterHandler
Adds a configuration parameter to this parameter configurable class instance.- Specified by:
addConfigurationParameter
in interfaceI_CmsConfigurationParameterHandler
- Overrides:
addConfigurationParameter
in classA_CmsResourceType
- Parameters:
paramName
- the name of the parameterparamValue
- the value for the parameter- See Also:
A_CmsResourceType.addConfigurationParameter(java.lang.String, java.lang.String)
-
getConfiguration
public CmsParameterConfiguration getConfiguration()
Description copied from interface:I_CmsConfigurationParameterHandler
Returns the parameters of this configurable class instance, ornull
if the class does not need any parameters.- Specified by:
getConfiguration
in interfaceI_CmsConfigurationParameterHandler
- Overrides:
getConfiguration
in classA_CmsResourceType
- Returns:
- the parameters of this configurable class instance,
or
null
if the class does not need any parameters - See Also:
A_CmsResourceType.getConfiguration()
-
getFolderClassName
public java.lang.String getFolderClassName()
Returns the (optional) configured folder class name for this folder.- Returns:
- the (optional) configured folder class name for this folder
-
getFolderClassParams
public java.lang.String getFolderClassParams()
Returns the (optional) configured folder class parameters name for this folder.- Returns:
- the (optional) configured folder class parameters for this folder
-
-