Class MenuItemComponentDefinitionImpl

    • 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
      • 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
      • 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
      • 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
      • 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.