Interface DataSnippetProvider<D>

Type Parameters:
D - The type of handled data objects.

public interface DataSnippetProvider<D>
Definition of a provider of information used to visually represent objects in form of snippets.
Since:
5.2.5
  • Method Summary

    Modifier and Type
    Method
    Description
    getExtract(D object, Language language)
    Provides the extract text being used as a long representation of the given object.
    getHeader(D object, Language language)
    Provides the header text being used as a short representation of the given object.
    getIcon(D object)
    Provides a type image resource for the given object or null if no type image is available.
    getThumbnail(D object, Language language)
    Provides a thumbnail image resource for the given object or null if no thumbnail representation is available.
  • Method Details

    • getIcon

      @Nullable Image<?> getIcon(@NotNull D object)
      Provides a type image resource for the given object or null if no type image is available.
      Parameters:
      object - The object that is to be rendered in report lists.
      Returns:
      Image or null if no image is to be shown.
      Since:
      5.2.5
    • getThumbnail

      @Nullable Image<?> getThumbnail(@NotNull D object, @Nullable Language language)
      Provides a thumbnail image resource for the given object or null if no thumbnail representation is available.
      Parameters:
      object - An object representing the given data object.
      language - The language to provide the thumbnail image resource in. If not given, a context related language will be used.
      Returns:
      Image or null if no thumbnail is to be shown.
      Since:
      5.2.5
    • getHeader

      @NotNull String getHeader(@NotNull D object, @Nullable Language language)
      Provides the header text being used as a short representation of the given object.
      Parameters:
      object - An object representing the given data object.
      language - The language to provide the header text in. If not given, a context related language will be used.
      Returns:
      The header text.
      Since:
      5.2.5
    • getExtract

      @Nullable String getExtract(@NotNull D object, @Nullable Language language)
      Provides the extract text being used as a long representation of the given object.
      Parameters:
      object - An object representing the given data object.
      language - The language to provide the extract text in. If not given, a context related language will be used.
      Returns:
      The extract text or null.
      Since:
      5.2.5