Package it.tidalwave.role.ui

Interface IconProvider

All Known Subinterfaces:
MutableIconProvider
All Known Implementing Classes:
MutableIconProviderSupport
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface IconProvider
The role of an object that can provide an icon for rendering.
Author:
Fabrizio Giudici
Status: draft API
Stereotype:
Role

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Class<IconProvider>
    _IconProvider_
     
    static final IconProvider
    DEFAULT
    A default IconProvider with an empty icon.

  • Method Summary

    Modifier and Type
    Method
    Description
    Icon
    getIcon(int requestedSize)
    Returns the icon for this object.

  • Field Details

    • _IconProvider_

      static final Class<IconProvider> _IconProvider_

    • DEFAULT

      static final IconProvider DEFAULT
      A default IconProvider with an empty icon.

  • Method Details

    • getIcon

      @Nonnull Icon getIcon(@Nonnegative int requestedSize)
      Returns the icon for this object. Note that the size parameter is just a hint to allow implementations to pick the correctly sized icon in an optimized fashion. In particular, implementations should try to do their best for providing an icon whose size is equal or greater than the requested one, but this is not guaranteed. It's up to the client code to eventually resize the returned icon for its purposes.
      Parameters:
      requestedSize - the requested icon size
      Returns:
      the icon