Class ElementComponentDefinitionImpl

    • 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

      • 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)
      • setPresentationScope

        public void setPresentationScope​(String presentationScope)
      • 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