Package nl.gx.webmanager.wcb.mediaitemtype

Interface MediaItemComponentDefinition

All Superinterfaces:

ComponentDefinition

All Known Implementing Classes:

MediaItemComponentDefinitionImpl

public interface MediaItemComponentDefinition
extends ComponentDefinition

Extended componentdefinition that should be used bij panelComponents to provide GX WebManager with aditional information/configuration.

Author:

Ivo Ladage

Method Summary

Modifier and Type	Method	Description
String	getContentType()	Return the content type.
String	getContentTypeLabelId()	Return the label id to be associated with the content type.
String	getDescription()	Returns the description of the panel.
String	getIcon()	Return filename of the icon to use to display the content type in WebManager.
String	getLargeIcon()	Returns the location of the large icon.
String	getLargeWmFileIcon()	Returns the large icon as the UUID of a wm:file node.
String	getName()	Returns the name of the panel that is shown in the WebManager menu.
String	getNodeType()	Return the name of the node type associated with this content type.
String	getSmallIcon()	Returns the location of the small icon.
String	getSmallWmFileIcon()	Returns the small icon as the UUID of a wm:file node.
boolean	isArticle()	Return if the type is an article or not.

Methods inherited from interface nl.gx.webmanager.wcb.ComponentDefinition

getComponentBundleDefinition, getControllerClassName, getDependencies, getDisplayLanguage, getEntityClassNames, getEntityFactoryClassName, getExtensions, getId, getImplementationClassName, getImplementationInstance, getInstanceClassName, getInterfaceClassNames, getLanguageResourceMessage, getLanguageResourceMessages, getLanguageResources, getNameSpace, getPermissionCategory, getPermissionsForPermissionGroups, getPersistenceManagerClassName, getProperties, getTypeId, getWrapperClassNames, isLicensed, setComponentBundleDefinition, setExtensions

Method Detail

getName

String getName()

Returns the name of the panel that is shown in the WebManager menu.

Specified by:

getName in interface ComponentDefinition

Returns:

The name of the Panel

getDescription

String getDescription()

Returns the description of the panel. Can be used in a configuration environment to give a description of the panel.

Specified by:

getDescription in interface ComponentDefinition

Returns:

The description of this panel

getContentType

String getContentType()

Return the content type. This is only a string value that is used to identify that the content type is unique

Returns:

the content type

getNodeType

String getNodeType()

Return the name of the node type associated with this content type.

Specified by:

getNodeType in interface ComponentDefinition

Returns:

Name of the node type associated with the content type

isArticle

boolean isArticle()

Return if the type is an article or not. Media types of the article type are considered to be element holders

Returns:

if the type is an article or not

getIcon

String getIcon()

Return filename of the icon to use to display the content type in WebManager. This is for WM9 backwards-compatibility and is the fallback for the WM 10.0 small icon.

Returns:

the filename

getLargeIcon

String getLargeIcon()

Returns the location of the large icon. This is added in WM 10.0 to support content creation.

Returns:

The location of the large icon

getLargeWmFileIcon

String getLargeWmFileIcon()

Returns the large icon as the UUID of a wm:file node. This is added in R23 to support modular content types, in which case the icon is determined by the editor and uploaded to the JCR, instead of being available in the bundle jar as a static file.

Returns:

The UUID of the wm:file node holding the large icon, or null if no such icon is available for this media item.

getSmallIcon

String getSmallIcon()

Returns the location of the small icon. This is added in WM 10.0 to support content creation.

Returns:

The location of the small icon

getSmallWmFileIcon

String getSmallWmFileIcon()

Returns the small icon as the UUID of a wm:file node. This is added in R23 to support modular content types, in which case the icon is determined by the editor and uploaded to the JCR, instead of being available in the bundle jar as a static file.

Returns:

The UUID of the wm:file node holding the small icon, or null if no such icon is available for this media item.

getContentTypeLabelId

String getContentTypeLabelId()

Return the label id to be associated with the content type.

Returns:

Label id of the content type