|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.file.types.A_CmsResourceType
org.opencms.file.types.A_CmsResourceTypeFolderBase
org.opencms.file.types.CmsResourceTypeFolder
public class CmsResourceTypeFolder
Resource type descriptor for the type "folder".
Field Summary | |
---|---|
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_CmsResourceType |
---|
CONFIGURATION_INTERNAL, m_addititionalModuleResourceType, m_className, m_copyResources, m_defaultProperties, m_frozen, m_mappings, 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 | |
---|---|
CmsResourceTypeFolder()
Default constructor, used to initialize member variables. |
Method Summary | |
---|---|
void |
addConfigurationParameter(java.lang.String paramName,
java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance. |
java.util.Map |
getConfiguration()
Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured. |
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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONFIGURATION_INDEX_PAGE_TYPE
public static final int RESOURCE_TYPE_ID
public static final java.lang.String RESOURCE_TYPE_NAME
Constructor Detail |
---|
public CmsResourceTypeFolder()
Method Detail |
---|
public static int getStaticTypeId()
public static java.lang.String getStaticTypeName()
public void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
I_CmsConfigurationParameterHandler
addConfigurationParameter
in interface I_CmsConfigurationParameterHandler
addConfigurationParameter
in class A_CmsResourceType
paramName
- the name of the parameterparamValue
- the value for the parameterA_CmsResourceType.addConfigurationParameter(java.lang.String, java.lang.String)
public java.util.Map getConfiguration()
I_CmsConfigurationParameterHandler
null
if the class does not need to be configured.
All elements in the configuration are key, value String pairs,
set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String)
method
during initialization of the loader.
Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.
getConfiguration
in interface I_CmsConfigurationParameterHandler
getConfiguration
in class A_CmsResourceType
null
A_CmsResourceType.getConfiguration()
public java.lang.String getIndexPageTypes()
public void initConfiguration(java.lang.String name, java.lang.String id, java.lang.String className) throws CmsConfigurationException
I_CmsResourceType
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 implementing I_CmsResourceType
,
then I_CmsResourceType
is used for the resource type instance.CmsResourceTypeUnknown
initConfiguration
in interface I_CmsResourceType
initConfiguration
in class A_CmsResourceType
name
- the resource type nameid
- the resource type idclassName
- the class name of the resource type (read from the XML configuration)
CmsConfigurationException
- if the configuration is invalidA_CmsResourceType.initConfiguration(java.lang.String, java.lang.String, String)
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |