| Package | Description |
|---|---|
| org.opencms.ade.configuration |
Contains the ade configuration classes.
|
| org.opencms.ade.containerpage |
Contains the container page editor service classes.
|
| org.opencms.ade.galleries |
Contains server side classes for the gallery dialogs.
|
| org.opencms.configuration |
Reads and writes the XML based OpenCms configuration files.
|
| org.opencms.file |
This important package provides the methods to access the OpenCms VFS repository with the permissions
of an authenticated user.
|
| org.opencms.file.types |
The implementations of the core resource types for the VFS are located here.
|
| org.opencms.importexport |
Contains functions to import and export resources from the OpenCms VFS.
|
| org.opencms.jsp |
The implementation of the OpenCms JSP tag library, with some additional utility classes to
help in JSP scriplet code and navigation building.
|
| org.opencms.loader |
Low-level functions to manage the loading of resources from the OpenCms VFS.
|
| org.opencms.module |
OpenCms modules provide a powerful, standardized way to extend
the core OpenCms functionality.
|
| org.opencms.site.xmlsitemap |
Contains classes related to XML sitemap generation.
|
| org.opencms.ui |
General code for the Vaadin UI
|
| org.opencms.ui.apps |
Contains code for workplace apps
|
| org.opencms.ui.apps.dbmanager |
Contains classes of the cache admin app.
|
| org.opencms.ui.apps.resourcetypes | |
| org.opencms.ui.editors |
The available content editors.
|
| org.opencms.ui.editors.messagebundle |
The data bindings and logic for the translator editor.
|
| org.opencms.workplace |
The base classes for the OpenCms Workplace
(standard dialog, tab dialog, report based dialog)
and the Workplace configuration classes are located here.
|
| org.opencms.workplace.editors |
Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
|
| org.opencms.workplace.explorer |
Contains the functions that generate the Workplace "Explorer" view, also contains
the "New resource" wizard.
|
| org.opencms.xml.containerpage |
Contains functions for the ADE main pages, commonly called "Container Pages" in OpenCms.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsADEManager.getConfigurationType()
Gets the configuration file type.
|
I_CmsResourceType |
CmsADEManager.getElementViewType()
Gets the element view configuration resource type.
|
I_CmsResourceType |
CmsADEManager.getModuleConfigurationType()
Gets the module configuration resource type.
|
I_CmsResourceType |
CmsADEManager.getSitemapConfigurationType()
Gets the sitemap configuration resource type.
|
I_CmsResourceType |
CmsResourceTypeConfig.getType()
Gets the actual resource type for which this is a configuration.
|
| Modifier and Type | Method and Description |
|---|---|
protected CmsFormatterConfiguration |
CmsADEConfigData.getFormatters(CmsObject cms,
I_CmsResourceType resType,
CmsFormatterConfiguration schemaFormatters)
Gets the formatter configuration for a resource type.
|
boolean |
CmsADEConfigData.hasFormatters(CmsObject cms,
I_CmsResourceType resType,
java.util.Collection<CmsContainer> containers)
Checks if there are any matching formatters for the given set of containers.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
I_CmsResourceTypeEnabledCheck.checkEnabled(CmsObject cms,
CmsADEConfigData config,
I_CmsResourceType resType)
Check whether the given type is enabled for a dialog.
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsResourceType |
CmsGalleryService.CmsGalleryTypeInfo.getResourceType()
Returns the resourceType.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.util.List<I_CmsResourceType> |
CmsGalleryService.CmsGalleryTypeInfo.getContentTypes()
Returns the contentTypes.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
CmsGalleryService.CmsGalleryTypeInfo.addContentType(I_CmsResourceType type)
Adds a type to the list of content types.
|
protected void |
CmsGalleryService.CmsGalleryTypeInfo.setResourceType(I_CmsResourceType resourceType)
Sets the resourceType.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<CmsResourceTypeBean> |
CmsGalleryService.buildTypesList(java.util.List<I_CmsResourceType> resourceTypes,
java.util.Set<java.lang.String> creatableTypes,
java.util.Set<java.lang.String> deactivatedTypes,
java.util.List<java.lang.String> typesForTypeTab)
Returns the resource types beans.
|
protected void |
CmsGalleryService.CmsGalleryTypeInfo.setContentTypes(java.util.List<I_CmsResourceType> contentTypes)
Sets the contentTypes.
|
| Constructor and Description |
|---|
CmsGalleryTypeInfo(I_CmsResourceType resourceType,
I_CmsResourceType contentType,
java.util.List<CmsResource> galleries)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsDigesterResourceTypeCreationFactory.createObject(org.xml.sax.Attributes attributes) |
| Modifier and Type | Method and Description |
|---|---|
static void |
CmsVfsConfiguration.generateResourceTypeXml(org.dom4j.Element startNode,
java.util.List<I_CmsResourceType> resourceTypes,
boolean module)
Creates the xml output for resourcetype nodes.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsResourceBuilder.getType()
Gets the type.
|
| Modifier and Type | Method and Description |
|---|---|
CmsResourceFilter |
CmsResourceFilter.addExcludeType(I_CmsResourceType type)
Returns an extended filter in order to avoid the given type in the filtered resources.
|
CmsResourceFilter |
CmsResourceFilter.addRequireType(I_CmsResourceType type)
Returns an extended filter to guarantee a distinct resource type of the filtered resources.
|
void |
CmsObject.chtype(java.lang.String resourcename,
I_CmsResourceType type)
Changes the resource type of a resource.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
I_CmsResourceType type)
Creates a new resource of the given resource type with
empty content and no properties.
|
CmsResource |
CmsObject.createResource(java.lang.String resourcename,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties)
Creates a new resource of the given resource type
with the provided content and properties.
|
void |
CmsObject.replaceResource(java.lang.String resourcename,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties)
Replaces the content, type and properties of a resource.
|
static CmsResourceFilter |
CmsResourceFilter.requireType(I_CmsResourceType type)
Returns a new CmsResourceFilter requiring the given type.
|
void |
CmsResourceBuilder.setType(I_CmsResourceType type)
Sets the type.
|
| Constructor and Description |
|---|
CmsResource(CmsUUID structureId,
CmsUUID resourceId,
java.lang.String rootPath,
I_CmsResourceType type,
int flags,
CmsUUID projectId,
CmsResourceState state,
long dateCreated,
CmsUUID userCreated,
long dateLastModified,
CmsUUID userLastModified,
long dateReleased,
long dateExpired,
int linkCount,
int size,
long dateContent,
int version)
Creates a new CmsRecource object.
|
| Modifier and Type | Class and Description |
|---|---|
class |
A_CmsResourceType
Base implementation for resource type classes.
|
class |
A_CmsResourceTypeFolderBase
Resource type descriptor for the type "folder".
|
class |
A_CmsResourceTypeLinkParseable
Base implementation for resource types implementing the
I_CmsLinkParseable interface. |
class |
CmsRecourceTypeFolderGallery
Resource type descriptor for extended folder types (like for example the workplace galleries).
|
class |
CmsResourceTypeBinary
Resource type descriptor for the type "binary".
|
class |
CmsResourceTypeFolder
Resource type descriptor for the type "folder".
|
class |
CmsResourceTypeFolderExtended
Resource type descriptor for extended folder types (like for example the workplace galleries).
|
class |
CmsResourceTypeFolderSubSitemap
Resource type descriptor for sub site map folder types.
|
class |
CmsResourceTypeFunctionConfig
Resource type class for the second version of dynamic functions.
|
class |
CmsResourceTypeHtmlRedirect
The HTML redirect resource type.
|
class |
CmsResourceTypeImage
Resource type descriptor for the type "image".
|
class |
CmsResourceTypeJsp
Resource type descriptor for the type "jsp".
|
class |
CmsResourceTypeLocaleIndependentXmlContent
Special resource type for locale independent XML contents.
|
class |
CmsResourceTypeMacroFormatter
The macro formatter resource type.
|
class |
CmsResourceTypePlain
Resource type descriptor for the type "plain".
|
class |
CmsResourceTypePointer
Resource type descriptor for the type "pointer".
|
class |
CmsResourceTypeSeoFile
The SEO file resource type.
|
class |
CmsResourceTypeUnknown
Resource type descriptor used in case the given resource type class in the XML configuration could
not be instantiated.
|
class |
CmsResourceTypeUnknownFile
Resource type descriptor for unknown file types.
|
class |
CmsResourceTypeUnknownFolder
Resource type descriptor for unknown folder types.
|
class |
CmsResourceTypeXmlAdeConfiguration
Custom resource type for ADE configurations.
|
class |
CmsResourceTypeXmlContainerPage
Resource type descriptor for the type "containerpage".
|
class |
CmsResourceTypeXmlContent
Resource type descriptor for the type "xmlcontent".
|
class |
CmsResourceTypeXmlPage
Resource type descriptor for the type "xmlpage".
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsResourceType |
A_CmsResourceType.getResourceType(CmsResource resource)
Convenience method to get the initialized resource type instance for the given resource,
with a fall back to special "unknown" resource types in case the resource type is not configured.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsResourceType> |
A_CmsResourceType.getGalleryTypes() |
java.util.List<I_CmsResourceType> |
I_CmsResourceType.getGalleryTypes()
Returns the gallery types for this resource type.
|
| Modifier and Type | Method and Description |
|---|---|
void |
A_CmsResourceType.chtype(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
I_CmsResourceType type) |
void |
I_CmsResourceType.chtype(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
I_CmsResourceType type)
Changes the resource type of a resource.
|
boolean |
A_CmsResourceType.isIdentical(I_CmsResourceType type) |
boolean |
I_CmsResourceType.isIdentical(I_CmsResourceType type)
Tests if the given resource type definition is identical to this resource type definition.
|
void |
A_CmsResourceType.replaceResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties) |
void |
I_CmsResourceType.replaceResource(CmsObject cms,
CmsSecurityManager securityManager,
CmsResource resource,
I_CmsResourceType type,
byte[] content,
java.util.List<CmsProperty> properties)
Replaces the content, type and properties of a resource.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsImportVersion7.getType()
Deprecated.
Returns the type.
|
I_CmsResourceType |
CmsImportVersion10.getType()
Returns the type.
|
| Modifier and Type | Method and Description |
|---|---|
protected CmsResource |
CmsImportVersion5.importResource(java.lang.String source,
java.lang.String destination,
I_CmsResourceType type,
java.lang.String uuidstructure,
java.lang.String uuidresource,
long datelastmodified,
java.lang.String userlastmodified,
long datecreated,
java.lang.String usercreated,
long datereleased,
long dateexpired,
java.lang.String flags,
java.util.List<CmsProperty> properties)
Deprecated.
Imports a resource (file or folder) into the cms.
|
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
CmsJspTagEdit.getNewLink(CmsObject cms,
I_CmsResourceType resType,
java.lang.String creationSitemap)
Creates the String specifying where which type of resource has to be created.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsResourceManager.getDefaultTypeForName(java.lang.String resourcename)
Returns the default resource type for the given resource name, using the
configured resource type file extensions.
|
I_CmsResourceType |
CmsResourceManager.getResourceType(CmsResource resource)
Convenience method to get the initialized resource type instance for the given resource,
with a fall back to special "unknown" resource types in case the resource type is not configured.
|
I_CmsResourceType |
CmsResourceManager.getResourceType(int typeId)
Returns the initialized resource type instance for the given id.
|
I_CmsResourceType |
CmsResourceManager.getResourceType(java.lang.String typeName)
Returns the initialized resource type instance for the given resource type name.
|
I_CmsResourceType |
CmsResourceManager.getResTypeUnknownFile()
The configured default type for files when the resource type is missing.
|
I_CmsResourceType |
CmsResourceManager.getResTypeUnknownFolder()
The configured default type for folders when the resource type is missing.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsResourceType> |
CmsResourceManager.getResourceTypes()
Returns the (unmodifiable) list with all initialized resource types.
|
java.util.List<I_CmsResourceType> |
CmsResourceManager.getResourceTypesWithUnknown()
Returns the (unmodifiable) list with all initialized resource types including unknown types.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsResourceManager.addResourceType(I_CmsResourceType resourceType)
Adds a new resource type from the XML configuration to the internal list of loaded resource types.
|
boolean |
CmsResourceManager.hasResourceType(I_CmsResourceType type)
Checks if an initialized resource type instance equal to the given resource type is available.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.List<I_CmsResourceType> |
CmsModule.getResourceTypes()
Returns the list of additional resource types that belong to this module.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsModuleXmlHandler.addResourceType(I_CmsResourceType resourceType)
Adds a new resource type to the internal list of loaded resource types.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CmsModule.setResourceTypes(java.util.List<I_CmsResourceType> resourceTypes)
Sets the list of additional resource types that belong to this module.
|
| Modifier and Type | Method and Description |
|---|---|
protected java.util.List<I_CmsResourceType> |
CmsXmlSitemapGenerator.getDetailTypesForPage(CmsResource resource)
Gets the types for which a given resource is configured as a detail page.
|
| Modifier and Type | Method and Description |
|---|---|
static java.util.List<I_CmsResourceType> |
CmsVaadinUtils.getResourceTypes()
Gets list of resource types.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsEditor |
CmsWorkplaceAppManager.getEditorForType(I_CmsResourceType type,
boolean plainText)
Returns the editor for the given resource type.
|
static java.lang.String |
CmsEditor.getEditStateForNew(CmsObject cms,
I_CmsResourceType resourceType,
java.lang.String contextPath,
java.lang.String modelFilePath,
boolean plainText,
java.lang.String backLink)
Returns the edit state for the given resource structure id.
|
| Modifier and Type | Method and Description |
|---|---|
protected I_CmsResourceType |
CmsResourceTypeStatsView.getType()
Returns the type which is selected by UI.
|
I_CmsResourceType |
CmsResourceTypeStatResult.getType()
Getter for resource type.
|
| Constructor and Description |
|---|
CmsResourceTypeStatResult(I_CmsResourceType type,
java.lang.String siteRoot,
int count)
Public constructor.
|
| Modifier and Type | Field and Description |
|---|---|
protected I_CmsResourceType |
CmsEditResourceTypeDialog.m_type
Resource type.
|
| Constructor and Description |
|---|
CmsEditResourceTypeDialog(com.vaadin.ui.Window window,
CmsResourceTypeApp app,
I_CmsResourceType resourceType)
Public constructor.
|
CmsMoveResourceTypeDialog(com.vaadin.ui.Window window,
I_CmsResourceType type)
public constructor.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CmsAcaciaEditor.matchesType(I_CmsResourceType type,
boolean plainText) |
boolean |
CmsXmlPageEditor.matchesType(I_CmsResourceType type,
boolean plainText) |
boolean |
CmsXmlContentEditor.matchesType(I_CmsResourceType type,
boolean plainText) |
boolean |
CmsSourceEditor.matchesType(I_CmsResourceType type,
boolean plainText) |
boolean |
I_CmsEditor.matchesType(I_CmsResourceType type,
boolean plainText)
Checks whether the editor is available for the given resource type.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CmsMessageBundleEditor.matchesType(I_CmsResourceType type,
boolean plainText) |
| Modifier and Type | Method and Description |
|---|---|
I_CmsPreEditorActionDefinition |
CmsWorkplaceManager.getPreEditorConditionDefinition(I_CmsResourceType resourceType)
Returns the condition definition for the given resource type that is triggered before opening the editor.
|
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
I_CmsPreEditorActionDefinition.getResourceType()
Returns the resource type for which the action should be performed.
|
I_CmsResourceType |
A_CmsPreEditorActionDefinition.getResourceType() |
| Modifier and Type | Method and Description |
|---|---|
I_CmsResourceType |
CmsResourceUtil.getResourceType()
Returns the resource type for the given resource.
|
| Modifier and Type | Method and Description |
|---|---|
static CmsContainerElementBean |
CmsContainerElementBean.createElementForResourceType(CmsObject cms,
I_CmsResourceType resourceType,
java.lang.String targetFolder,
java.util.Map<java.lang.String,java.lang.String> individualSettings,
boolean isCopyModels,
java.util.Locale locale)
Creates an element bean for the given resource type.
|