nl.gx.webmanager.wcb.elementtype
Interface ElementComponentDefinition

All Superinterfaces:

ComponentDefinition, MenuItemComponentDefinition

All Known Implementing Classes:

ElementComponentDefinitionImpl

public interface ElementComponentDefinition
extends MenuItemComponentDefinition

Extended component definition that should be used by elementComponents to provide GX WebManager with additional information/configuration.

Author:

bramk

Method Summary

char	getAccessKey() Returns the shortcut key for in the WebManager element menu that can be used to add an element to an element holder like a page.
java.util.Map<java.lang.Class<? extends Element>,Permission[]>	getCreatePermissions() Returns the permissions that grant the user the authorization to create an instance of the element contained by this element component.
java.util.Map<java.lang.Class<? extends Element>,Permission[]>	getDeletePermissions() Returns the permissions that grant the user the authorization to delete an instance of the element contained by this element component.
java.lang.String	getDescription() Returns the description of the element.
java.lang.String	getLargeIcon() Returns the location of the icon for in the WebManager toolbar that can be used to add an element to an element holder like a page.
java.lang.String	getName() Returns the name of the element that is shown in the WebManager element menu.
java.lang.String	getPresentationScope() Returns the presentation scope for the element, is directly mapped on the scope of a presentation object.
java.lang.String	getSmallIcon() Returns the icon for in the WebManager element menu that depicts the type of element.
void	setCreatePermissions(java.lang.Class<? extends Element> elementClass, Permission[] permissions) Sets the permissions that grant the user the authorization to create an instance of the element contained by this element component.
void	setDeletePermissions(java.lang.Class<? extends Element> elementClass, Permission[] permissions) Sets the permissions that grant the user the authorization to delete an instance of the element contained by this element component.

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

getMenuItemPermissions, getMenuTextMessageKey, getTargetMenu, getTargetMenuLocationAfter, getTargetMenuLocationBefore

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

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

Method Detail

getAccessKey

char getAccessKey()

Returns the shortcut key for in the WebManager element menu that can be used to add an element to an element holder like a page.

Returns:

The shortcut key

getPresentationScope

java.lang.String getPresentationScope()

Returns the presentation scope for the element, is directly mapped on the scope of a presentation object.

Returns:

The presentation scope for the element

getLargeIcon

java.lang.String getLargeIcon()

Returns the location of the icon for in the WebManager toolbar that can be used to add an element to an element holder like a page. The icon should consist of a gif image in the format 100 x 25 px.

Returns:

The location of the icon for in the WebManager toolbar

getSmallIcon

java.lang.String getSmallIcon()

Returns the icon for in the WebManager element menu that depicts the type of element.

Returns:

The icon for in the WebManager element menu that depicts the type of element

getName

java.lang.String getName()

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

Specified by:

getName in interface ComponentDefinition

Returns:

The name of the element

getDescription

java.lang.String getDescription()

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

Specified by:

getDescription in interface ComponentDefinition

Returns:

The description of the element

getCreatePermissions

java.util.Map<java.lang.Class<? extends Element>,Permission[]> getCreatePermissions()

Returns the permissions that grant the user the authorization to create an instance of the element contained by this element component. The user has to be assigned to one of the permissions only to be granted that authorization.

Returns:

All permissions that grant the user the authorization to create an instance of any of the element classes for which permissions were registered

setCreatePermissions

void setCreatePermissions(java.lang.Class<? extends Element> elementClass,
                          Permission[] permissions)

Sets the permissions that grant the user the authorization to create an instance of the element contained by this element component. The user has to be assigned to one of the permissions only to be granted that authorization. If input argument is null, create permission is granted to all users

Parameters:

elementClass - Element class to set the permissions for. The permissions will be applicable for any instances of the given class.

permissions - All permissions that grant the user the authorization to create an instance of the element contained by this element component

getDeletePermissions

java.util.Map<java.lang.Class<? extends Element>,Permission[]> getDeletePermissions()

Returns the permissions that grant the user the authorization to delete an instance of the element contained by this element component. The user has to be assigned to one of the permissions only to be granted that authorization.

Returns:

All permissions that grant the user the authorization to delete an instance of any of the element classes for which permissions were registered

setDeletePermissions

void setDeletePermissions(java.lang.Class<? extends Element> elementClass,
                          Permission[] permissions)

Sets the permissions that grant the user the authorization to delete an instance of the element contained by this element component. The user has to be assigned to one of the permissions only to be granted that authorization. If input argument is null, delete permission is granted to all users

Parameters:

elementClass - Element class to set the permissions for. The permissions will be applicable for any instances of the given class.

permissions - All permissions that grant the user the authorization to delete an instance of the element contained by this element component