Package org.ametys.cms.contenttype
Interface ContentTypeDescriptor
- All Known Subinterfaces:
ContentType
- All Known Implementing Classes:
AbstractContentTypeDescriptor
,AutomaticContentType
,ContentTypeDefinition
,DefaultContentType
,DynamicContentTypeDescriptor
,HTMLContentType
,ODFContentType
,PostContentType
,WebContentType
public interface ContentTypeDescriptor
This class represents a descriptor for content type
-
Method Summary
Modifier and TypeMethodDescriptionRetrieves the category of the content type.Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icondefault String
Returns the default i18n catalog for this content type.Retrieves the default title of the content type.Retrieves the description of the content type.getEditionMetadataSetNames
(boolean includeInternal) Deprecated.Retrieves the CSS class to use for decorator above the main iconRetrieves the CSS class to use for glyph icondefault String
getIconPath
(String pluginName) Returns the path for iconsgetId()
Retrieves the id of the content type.getLabel()
Retrieves the label of the content type.Retrieves the URL of the icon without the context path.Retrieves the URL of the icon without the context path.getMetadataSetForEdition
(String metadataSetName) Deprecated.UseContentType.getView(String)
insteadgetMetadataSetForView
(String metadataSetName) Deprecated.UseContentType.getView(String)
insteadRetrieves the name of the plugin declaring this content type.Retrieves the URL of the icon without the context path.String[]
Retrieves the super type's ids.getViewMetadataSetNames
(boolean includeInternal) Deprecated.UseContentType.getViewNames()
instead
-
Method Details
-
getId
Retrieves the id of the content type.- Returns:
- the id.
-
getPluginName
Retrieves the name of the plugin declaring this content type.- Returns:
- the name of the plugin.
-
getLabel
Retrieves the label of the content type.- Returns:
- the label.
-
getDescription
Retrieves the description of the content type.- Returns:
- the description.
-
getDefaultTitle
Retrieves the default title of the content type.- Returns:
- the default title.
-
getCategory
Retrieves the category of the content type.- Returns:
- the category.
-
getSupertypeIds
Retrieves the super type's ids.- Returns:
- the super type's ids, or empty if this content type doesn't extend a specific content type.
-
getIconGlyph
Retrieves the CSS class to use for glyph icon- Returns:
- the glyph name.
-
getIconDecorator
Retrieves the CSS class to use for decorator above the main icon- Returns:
- the glyph name.
-
getSmallIcon
Retrieves the URL of the icon without the context path.- Returns:
- the icon URL for the small image 16x16.
-
getMediumIcon
Retrieves the URL of the icon without the context path.- Returns:
- the icon URL for the medium sized image 32x32.
-
getLargeIcon
Retrieves the URL of the icon without the context path.- Returns:
- the icon URL for the large image 48x48.
-
getViewMetadataSetNames
Deprecated.UseContentType.getViewNames()
insteadReturns all names of "view" metadataSets.- Parameters:
includeInternal
- if the result should include internal metadataSets.- Returns:
- all names of "view" metadataSets.
-
getEditionMetadataSetNames
Deprecated.UseContentType.getViewNames()
insteadReturns all names of "edition" metadataSets.- Parameters:
includeInternal
- if the result should include internal metadataSets.- Returns:
- all names of "edition" metadataSets.
-
getMetadataSetForView
Deprecated.UseContentType.getView(String)
insteadRetrieves the metadata set name for view.- Parameters:
metadataSetName
- the metadata set name.- Returns:
- the metadata definition.
-
getMetadataSetForEdition
Deprecated.UseContentType.getView(String)
insteadRetrieves the metadata set name for edition.- Parameters:
metadataSetName
- the metadata set name.- Returns:
- the metadata set.
-
getCSSFiles
Returns the list of CSS files needed to correctly display the content's in BO, such as the content's icon- Returns:
- The list of CSS files needed. Must not be null.
-
getDefaultCatalog
Returns the default i18n catalog for this content type.- Returns:
- the default i18n catalog for this content type.
-
getIconPath
Returns the path for icons- Parameters:
pluginName
- the configured plugin- Returns:
- the path for icons
-
ContentType.getViewNames()
instead