Package nl.gx.webmanager.wcb.elementtype.impl

Class ElementComponentDefinitionImpl

java.lang.Object

nl.gx.webmanager.wcb.foundation.ComponentDefinitionImpl

nl.gx.webmanager.wcb.foundation.MenuItemComponentDefinitionImpl

nl.gx.webmanager.wcb.elementtype.impl.ElementComponentDefinitionImpl

All Implemented Interfaces:

ComponentDefinition, ElementComponentDefinition, MenuItemComponentDefinition

public class ElementComponentDefinitionImpl
extends MenuItemComponentDefinitionImpl
implements ElementComponentDefinition

This class implements additional properties for panels to the default componentdefinition.

Constructor Summary

Constructors

Constructor	Description
ElementComponentDefinitionImpl(boolean isLicensed)	Constructor.
ElementComponentDefinitionImpl(boolean isLicensed, Class elementClass)	Creates a new ElementComponentDefinitionImpl instance.

Method Summary

Modifier and Type	Method	Description
char	getAccessKey()	Deprecated.
HashMap<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.
HashMap<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.
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.
Permission[]	getMenuItemPermissions()	Returns the permission that grant the right for showing the menu item
String	getPresentationScope()	Returns the presentation scope for the element, is directly mapped on the scope of a presentation object.
String	getSmallIcon()	Returns the icon for in the WebManager element menu that depicts the type of element.
String	getStaticBackendDir()	Deprecated.
String	getTargetMenu()	Gets the identifying value of the WebManager menu to which the panel should be added.
void	setAccessKey(char accessKey)	Deprecated. As of 10.0 elements do not have an access key.
void	setCreatePermissions(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(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.
void	setLargeIcon(String largeIcon)
void	setPresentationScope(String presentationScope)
void	setSmallIcon(String smallIcon)
void	setTargetMenu(String targetMenu)	Sets the identifying value of the WebManager menu to which the panel should be added.

Methods inherited from class nl.gx.webmanager.wcb.foundation.MenuItemComponentDefinitionImpl

getMenuTextMessageKey, getSubMenu, getSubMenuLocationAfter, getSubMenuLocationBefore, getSubMenuTextMessageKey, getTargetMenuLocationAfter, getTargetMenuLocationBefore, setMenuTextMessageKey, setSubMenu, setSubMenuLocationAfter, setSubMenuLocationBefore, setSubMenuTextMessageKey, setTargetMenuLocationAfter, setTargetMenuLocationBefore

Methods inherited from class nl.gx.webmanager.wcb.foundation.ComponentDefinitionImpl

getComponentBundleDefinition, getControllerClassName, getDependencies, getDescription, getDisplayLanguage, getEntityClassNames, getEntityFactoryClassName, getExtensions, getId, getImplementationClassName, getImplementationInstance, getInstanceClassName, getInterfaceClassNames, getLanguageResourceMessage, getLanguageResourceMessages, getLanguageResources, getName, getNameSpace, getNodeType, getPermissionCategory, getPermissionsForPermissionGroups, getPersistenceManagerClassName, getProperties, getTypeId, getWrapperClassNames, isLicensed, setComponentBundleDefinition, setControllerClassName, setDependencies, setDescription, setEntityClassNames, setEntityFactoryClassName, setExtensions, setId, setImplementationClassName, setImplementationInstance, setInstanceClassName, setInterfaceClassNames, setLanguageResources, setName, setNameSpace, setNodeType, setPermissionCategory, setPermissionsForPermissionGroup, setPersistenceManagerClassName, setProperties, setTypeId, setWrapperClassNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, getNodeType, getPermissionCategory, getPermissionsForPermissionGroups, getPersistenceManagerClassName, getProperties, getTypeId, getWrapperClassNames, isLicensed, setComponentBundleDefinition, setExtensions

Methods inherited from interface nl.gx.webmanager.wcb.elementtype.ElementComponentDefinition

getDescription, getName

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

getMenuTextMessageKey, getSubMenu, getSubMenuLocationAfter, getSubMenuLocationBefore, getSubMenuTextMessageKey, getTargetMenuLocationAfter, getTargetMenuLocationBefore

Constructor Detail

ElementComponentDefinitionImpl

public ElementComponentDefinitionImpl(boolean isLicensed)

Constructor.

Parameters:

isLicensed -

ElementComponentDefinitionImpl

public ElementComponentDefinitionImpl(boolean isLicensed,
                                      Class elementClass)

Creates a new ElementComponentDefinitionImpl instance.

Parameters:

isLicensed - Indicates whether the ElementComponent requires a license.

Method Detail

getAccessKey

@Deprecated
public char getAccessKey()

Deprecated.

Description copied from interface: ElementComponentDefinition

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.

Specified by:

getAccessKey in interface ElementComponentDefinition

Returns:

The shortcut key

setAccessKey

@Deprecated
public void setAccessKey(char accessKey)

Deprecated.

As of 10.0 elements do not have an access key. This setting will be ignored.

Sets access key.

Parameters:

accessKey - Access key

getLargeIcon

public String getLargeIcon()

Description copied from interface: ElementComponentDefinition

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.

Specified by:

getLargeIcon in interface ElementComponentDefinition

Returns:

The location of the icon for in the WebManager toolbar

setLargeIcon

public void setLargeIcon(String largeIcon)

getTargetMenu

public String getTargetMenu()

Description copied from class: MenuItemComponentDefinitionImpl

Gets the identifying value of the WebManager menu to which the panel should be added.

Specified by:

getTargetMenu in interface MenuItemComponentDefinition

Overrides:

getTargetMenu in class MenuItemComponentDefinitionImpl

Returns:

the identifying value of the WebManager menu to which the panel should be added

setTargetMenu

public void setTargetMenu(String targetMenu)

Description copied from class: MenuItemComponentDefinitionImpl

Sets the identifying value of the WebManager menu to which the panel should be added.

Overrides:

setTargetMenu in class MenuItemComponentDefinitionImpl

Parameters:

targetMenu - Identifying value of the WebManager menu

getPresentationScope

public String getPresentationScope()

Description copied from interface: ElementComponentDefinition

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

Specified by:

getPresentationScope in interface ElementComponentDefinition

Returns:

The presentation scope for the element

setPresentationScope

public void setPresentationScope(String presentationScope)

getStaticBackendDir

@Deprecated
public String getStaticBackendDir()

Deprecated.

getSmallIcon

public String getSmallIcon()

Description copied from interface: ElementComponentDefinition

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

Specified by:

getSmallIcon in interface ElementComponentDefinition

Returns:

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

setSmallIcon

public void setSmallIcon(String smallIcon)

Parameters:

smallIcon -

getMenuItemPermissions

public Permission[] getMenuItemPermissions()

Returns the permission that grant the right for showing the menu item

Specified by:

getMenuItemPermissions in interface MenuItemComponentDefinition

Returns:

Array of permissions, each of one granting the right to show the menu item for inserting a new element.

getCreatePermissions

public HashMap<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.

Specified by:

getCreatePermissions in interface ElementComponentDefinition

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

public void setCreatePermissions(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

Specified by:

setCreatePermissions in interface ElementComponentDefinition

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

public HashMap<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.

Specified by:

getDeletePermissions in interface ElementComponentDefinition

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

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

Description copied from interface: ElementComponentDefinition

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

Specified by:

setDeletePermissions in interface ElementComponentDefinition

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