Interface ElementComponentDefinition

    • Method Detail

      • getAccessKey

        @Deprecated
        char getAccessKey()
        Deprecated.
        As of 10.0 elements do not have an access key. This setting will be ignored.
        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

        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

        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

        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

        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

        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

        Map<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​(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

        Map<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​(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