Class CmsResourceTypeFolder
- java.lang.Object
-
- org.opencms.file.types.A_CmsResourceType
-
- org.opencms.file.types.A_CmsResourceTypeFolderBase
-
- org.opencms.file.types.CmsResourceTypeFolder
-
- All Implemented Interfaces:
java.io.Serializable
,I_CmsConfigurationParameterHandler
,I_CmsResourceType
public class CmsResourceTypeFolder extends A_CmsResourceTypeFolderBase
Resource type descriptor for the type "folder".- 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_INDEX_PAGE_TYPE
Configuration key for the optional list of resource types to show as available index page types.static int
RESOURCE_TYPE_ID
The type id of this resource.static java.lang.String
RESOURCE_TYPE_NAME
The name of this resource type.-
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 CmsResourceTypeFolder()
Default constructor, used to initialize member variables.
-
Method Summary
All Methods Static 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
getIndexPageTypes()
Returns the indexPageTypes.static int
getStaticTypeId()
Returns the static type id of this (default) resource type.static java.lang.String
getStaticTypeName()
Returns the static type name of this (default) resource type.void
initConfiguration(java.lang.String name, java.lang.String id, java.lang.String className)
Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.-
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, initialize, isAdditionalModuleResourceType, isDirectEditable, isIdentical, lockResource, processCopyResources, processDefaultProperties, removeResourceFromProject, replaceResource, restoreResource, setAdditionalModuleResourceType, setAdjustLinksFolder, setModuleName, toString, unlockResource, updateRelationForUndo, writeFile, writePropertyObject, writePropertyObjects
-
-
-
-
Field Detail
-
CONFIGURATION_INDEX_PAGE_TYPE
public static final java.lang.String CONFIGURATION_INDEX_PAGE_TYPE
Configuration key for the optional list of resource types to show as available index page types.- See Also:
- Constant Field Values
-
RESOURCE_TYPE_ID
public static final int RESOURCE_TYPE_ID
The type id of this resource.- See Also:
- Constant Field Values
-
RESOURCE_TYPE_NAME
public static final java.lang.String RESOURCE_TYPE_NAME
The name of this resource type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsResourceTypeFolder
public CmsResourceTypeFolder()
Default constructor, used to initialize member variables.
-
-
Method Detail
-
getStaticTypeId
public static int getStaticTypeId()
Returns the static type id of this (default) resource type.- Returns:
- the static type id of this (default) resource type
-
getStaticTypeName
public static java.lang.String getStaticTypeName()
Returns the static type name of this (default) resource type.- Returns:
- the static type name of this (default) resource type
-
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()
-
getIndexPageTypes
public java.lang.String getIndexPageTypes()
Returns the indexPageTypes.- Returns:
- the indexPageTypes
-
initConfiguration
public void initConfiguration(java.lang.String name, java.lang.String id, java.lang.String className) throws CmsConfigurationException
Description copied from interface:I_CmsResourceType
Special version of the configuration initialization used with resource types to set resource type, id and class name, required for the XML configuration.Please note: Many resource types defined in the core have in fact a fixed resource type and a fixed id. Configurable name and id is used only for certain types.
The provided named class must implement this interface (
). Usually the provided class name should be the class name of the resource type instance, but this may be different in special cases or configuration errors. For example, if a module is imported that contains it's own resource type class files, the included class file are usually not be available until the server is restarted. If the named class given in the XML configuration (or module manifest.xml) is not available, or not implementingI_CmsResourceType
, thenI_CmsResourceType
is used for the resource type instance.CmsResourceTypeUnknown
- Specified by:
initConfiguration
in interfaceI_CmsResourceType
- Overrides:
initConfiguration
in classA_CmsResourceType
- Parameters:
name
- the resource type nameid
- the resource type idclassName
- the class name of the resource type (read from the XML configuration)- Throws:
CmsConfigurationException
- if the configuration is invalid- See Also:
A_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)
-
-