Package io.meeds.social.navigation.plugin

Interface SidebarPlugin

public interface SidebarPlugin
A class to allow managing Sidebar item types

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final io.meeds.portal.navigation.model.SidebarItem
    SIDEBAR_SEPARATOR
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<io.meeds.portal.navigation.model.SidebarItem>
    getDefaultItems()
     
    default io.meeds.portal.navigation.constant.SidebarItemType
    getType()
     
    default boolean
    itemExists(io.meeds.portal.navigation.model.SidebarItem item, String username)
     
    default io.meeds.portal.navigation.model.SidebarItem
    resolveProperties(io.meeds.portal.navigation.model.SidebarItem item, String username, Locale locale)
    Resolves Item Name and Icon when storage is maintained

  • Field Details

  • Method Details

    • getType

      default io.meeds.portal.navigation.constant.SidebarItemType getType()
      Returns:
      SidebarItemType managed by the implementing plugin

    • resolveProperties

      default io.meeds.portal.navigation.model.SidebarItem resolveProperties(io.meeds.portal.navigation.model.SidebarItem item, String username, Locale locale)
      Resolves Item Name and Icon when storage is maintained
      Parameters:
      item -
      username -
      locale -

    • getDefaultItems

      default List<io.meeds.portal.navigation.model.SidebarItem> getDefaultItems()
      Returns:
      List of SidebarItem to inject on startup

    • itemExists

      default boolean itemExists(io.meeds.portal.navigation.model.SidebarItem item, String username)
      Parameters:
      item - SidebarItem
      username - User name
      Returns:
      true if the item exists and the user has access to it, else false