org.opencms.file.types
Class CmsRecourceTypeFolderGallery

java.lang.Object
  extended by org.opencms.file.types.A_CmsResourceType
      extended by org.opencms.file.types.A_CmsResourceTypeFolderBase
          extended by org.opencms.file.types.CmsResourceTypeFolderExtended
              extended by org.opencms.file.types.CmsRecourceTypeFolderGallery
All Implemented Interfaces:
I_CmsConfigurationParameterHandler, I_CmsResourceType

public class CmsRecourceTypeFolderGallery
extends CmsResourceTypeFolderExtended

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:
7.6.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencms.file.types.I_CmsResourceType
I_CmsResourceType.Formatter
 
Field Summary
static java.lang.String CONFIGURATION_FOLDER_CONTENT_TYPES
          Configuration key for the optional folder class name.
 
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_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.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
 
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
 
Constructor Summary
CmsRecourceTypeFolderGallery()
           
 
Method Summary
 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, or null if the class does not need any parameters.
 java.lang.String getFolderContentTypes()
          Returns the folder content types.
 
Methods inherited from class org.opencms.file.types.CmsResourceTypeFolderExtended
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, 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, 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 Detail

CONFIGURATION_FOLDER_CONTENT_TYPES

public static final java.lang.String CONFIGURATION_FOLDER_CONTENT_TYPES
Configuration key for the optional folder class name.

See Also:
Constant Field Values
Constructor Detail

CmsRecourceTypeFolderGallery

public CmsRecourceTypeFolderGallery()
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 interface I_CmsConfigurationParameterHandler
Overrides:
addConfigurationParameter in class CmsResourceTypeFolderExtended
Parameters:
paramName - the name of the parameter
paramValue - 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, or null if the class does not need any parameters.

Specified by:
getConfiguration in interface I_CmsConfigurationParameterHandler
Overrides:
getConfiguration in class CmsResourceTypeFolderExtended
Returns:
the parameters of this configurable class instance, or null if the class does not need any parameters
See Also:
A_CmsResourceType.getConfiguration()

getFolderContentTypes

public java.lang.String getFolderContentTypes()
Returns the folder content types.

Returns:
the folder content types