Package io.jmix.ui.icon

Interface IconProvider

All Known Implementing Classes:
ClassPathIconProvider, FallbackIconProvider, FileIconProvider, FontAwesomeIconProvider, ThemeIconProvider
public interface IconProvider
Marker interface for beans that can provide Resource by some icon path.

The IconResolver bean obtains all beans that implements IconProvider interface and iterates over them to find the one that can provide Resource for icon. So you should use this interface to mark new icon provider to use your custom icon set.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canProvide(String iconPath)
     
    com.vaadin.server.Resource
    getIconResource(String iconPath)
     

  • Method Details

    • getIconResource

      com.vaadin.server.Resource getIconResource(String iconPath)
      Returns:
      an instance of Resource by the given iconPath.

    • canProvide

      boolean canProvide(@Nullable String iconPath)
      Returns:
      true if icon provider can return an instance of Resource by the given iconPath or false otherwise