Package nl.gx.webmanager.wcb.foundation

Class MenuItemComponentDefinitionImpl

java.lang.Object

nl.gx.webmanager.wcb.foundation.ComponentDefinitionImpl

nl.gx.webmanager.wcb.foundation.MenuItemComponentDefinitionImpl

All Implemented Interfaces:

ComponentDefinition, MenuItemComponentDefinition

Direct Known Subclasses:

ElementComponentDefinitionImpl, PanelComponentDefinitionImpl

public abstract class MenuItemComponentDefinitionImpl
extends ComponentDefinitionImpl
implements MenuItemComponentDefinition

Implementation of MenuItemComponentDefinition that contains all information needed to install a component which adds an entry to the WebManager menu structure.

Constructor Summary

Constructors

Constructor	Description
MenuItemComponentDefinitionImpl(boolean isLicensed)	Constructs a new MenuItemComponentDefinitionImpl instance.

Method Summary

Modifier and Type	Method	Description
String	getMenuTextMessageKey()	Returns the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menu structure.
String	getSubMenu()	Deprecated.
String	getSubMenuLocationAfter()	Deprecated.
String	getSubMenuLocationBefore()	Deprecated.
String	getSubMenuTextMessageKey()	Deprecated.
String	getTargetMenu()	Deprecated. For panels use PanelComponentDefinition.getMenuCategory()
String	getTargetMenuLocationAfter()	Deprecated.
String	getTargetMenuLocationBefore()	Deprecated.
void	setMenuTextMessageKey(String messageKey)	Sets the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menustructure.
void	setSubMenu(String subMenu)	Deprecated.
void	setSubMenuLocationAfter(String subMenuLocationAfter)	Deprecated.
void	setSubMenuLocationBefore(String subMenuLocationBefore)	Deprecated.
void	setSubMenuTextMessageKey(String subMenuTextMessageKey)	Deprecated.
void	setTargetMenu(String targetMenu)	Deprecated. For panels use PanelComponentDefinitionImpl.setMenuCategory(String)
void	setTargetMenuLocationAfter(String menuitem)	Deprecated.
void	setTargetMenuLocationBefore(String menuitem)	Deprecated.

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, getDescription, getDisplayLanguage, getEntityClassNames, getEntityFactoryClassName, getExtensions, getId, getImplementationClassName, getImplementationInstance, getInstanceClassName, getInterfaceClassNames, getLanguageResourceMessage, getLanguageResourceMessages, getLanguageResources, getName, getNameSpace, getNodeType, getPermissionCategory, getPermissionsForPermissionGroups, getPersistenceManagerClassName, getProperties, getTypeId, getWrapperClassNames, isLicensed, setComponentBundleDefinition, setExtensions

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

getMenuItemPermissions

Constructor Detail

MenuItemComponentDefinitionImpl

public MenuItemComponentDefinitionImpl(boolean isLicensed)

Constructs a new MenuItemComponentDefinitionImpl instance.

Parameters:

isLicensed - Identifies the associated component as a Component requiring a license.

Method Detail

getMenuTextMessageKey

public String getMenuTextMessageKey()

Description copied from interface: MenuItemComponentDefinition

Returns the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menu structure.

Specified by:

getMenuTextMessageKey in interface MenuItemComponentDefinition

Returns:

the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menu structure

setMenuTextMessageKey

public void setMenuTextMessageKey(String messageKey)

Sets the key in the message properties file of the component which is mapped on the value that is used for the description of the component in the menustructure.

Parameters:

messageKey - The key in the message properties file

getTargetMenu

@Deprecated
public String getTargetMenu()

Deprecated.

For panels use PanelComponentDefinition.getMenuCategory()

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

Specified by:

getTargetMenu in interface MenuItemComponentDefinition

Returns:

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

setTargetMenu

@Deprecated
public void setTargetMenu(String targetMenu)

Deprecated.

For panels use PanelComponentDefinitionImpl.setMenuCategory(String)

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

Parameters:

targetMenu - Identifying value of the WebManager menu

getTargetMenuLocationAfter

@Deprecated
public String getTargetMenuLocationAfter()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns the id of the menu item after which the new menu item should be inserted.

Specified by:

getTargetMenuLocationAfter in interface MenuItemComponentDefinition

Returns:

The id of the menu item after which the new menu item should be inserted

setTargetMenuLocationAfter

@Deprecated
public void setTargetMenuLocationAfter(String menuitem)

Deprecated.

Sets the id of the menu item after which the new menu item should be inserted.

Parameters:

menuitem - Id of a menu item

getTargetMenuLocationBefore

@Deprecated
public String getTargetMenuLocationBefore()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns the id of the menu item before which the new menu item should be inserted.

Specified by:

getTargetMenuLocationBefore in interface MenuItemComponentDefinition

Returns:

The id of the menu item before which the new menu item should be inserted

setTargetMenuLocationBefore

@Deprecated
public void setTargetMenuLocationBefore(String menuitem)

Deprecated.

Sets the id of the menu item before which the new menu item should be inserted.

Parameters:

menuitem - Id of a menu item

getSubMenu

@Deprecated
public final String getSubMenu()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns a string identifying the sub menu within the target menu where the component will be shown in the menu. If this method returns the same value for one ore more components they will be placed together in the same sub menu.

Specified by:

getSubMenu in interface MenuItemComponentDefinition

Returns:

A string identifying the sub menu within the target menu where the component will be shown in the menu

setSubMenu

@Deprecated
public final void setSubMenu(String subMenu)

Deprecated.

Sets the string identifying the sub menu within the target menu where the component will be shown in the menu.

Parameters:

subMenu - The string identifying the sub menu within the target menu where the component will be shown in the menu

getSubMenuLocationAfter

@Deprecated
public final String getSubMenuLocationAfter()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns the id of the menu item in the sub menu after which the new menu item should be inserted.

Specified by:

getSubMenuLocationAfter in interface MenuItemComponentDefinition

Returns:

the id of the menu item in the sub menu after which the new menu item should be inserted.

setSubMenuLocationAfter

@Deprecated
public final void setSubMenuLocationAfter(String subMenuLocationAfter)

Deprecated.

Sets the id of the menu item in the sub menu after which the new menu item should be inserted.

Parameters:

subMenuLocationAfter - The id of the menu item in the sub menu after which the new menu item should be inserted

getSubMenuLocationBefore

@Deprecated
public final String getSubMenuLocationBefore()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns the id of the menu item in the sub menu before which the new menu item should be inserted.

Specified by:

getSubMenuLocationBefore in interface MenuItemComponentDefinition

Returns:

the id of the menu item in the sub menu before which the new menu item should be inserted.

setSubMenuLocationBefore

@Deprecated
public final void setSubMenuLocationBefore(String subMenuLocationBefore)

Deprecated.

Sets the id of the menu item in the sub menu before which the new menu item should be inserted.

Parameters:

subMenuLocationBefore - The id of the menu item in the sub menu before which the new menu item should be inserted.

getSubMenuTextMessageKey

@Deprecated
public final String getSubMenuTextMessageKey()

Deprecated.

Description copied from interface: MenuItemComponentDefinition

Returns the key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu. If different components return different descriptions one is chosen at random. (The last one registered). If this method returns null and there already is an entry for the sub menu in the menu, the current descriptions will be retained.

Specified by:

getSubMenuTextMessageKey in interface MenuItemComponentDefinition

Returns:

the key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu

setSubMenuTextMessageKey

@Deprecated
public final void setSubMenuTextMessageKey(String subMenuTextMessageKey)

Deprecated.

Sets the key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu.

Parameters:

subMenuTextMessageKey - The key in the message properties file of the component which is mapped on the value that is used for the description of the sub menu within the target menu.