Package com.levigo.jadice.web.server.annotation

Interface AnnotationImageProvider

All Known Implementing Classes:
AnnoImageProvider
public interface AnnotationImageProvider
An AnnotationImageProvider serves an appropriate image for the JWTImageAnnotationRenderer depending on the annotations' image identifier.

In order to apply the AnnotationImageProvider for an annotation profile, register it using AnnotationProfileRegistry.registerAnnotationImageProvider(String, AnnotationImageProvider).

On the client side, the AnnotationCustomizer can be used to set the appropriate image identifier.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.levigo.jadice.document.io.SeekableInputStream
    provideAnnotationImage(String annotationImageID)
    Provides an image for the requested image annotation identifier.

  • Method Details

    • provideAnnotationImage

      com.levigo.jadice.document.io.SeekableInputStream provideAnnotationImage(String annotationImageID) throws IOException
      Provides an image for the requested image annotation identifier.
      Parameters:
      annotationImageID - The image identification set by the AnnotationCustomizer.
      Returns:
      The image for the requested annotation. Must never return null.
      Throws:
      IOException - if the image couldn't be loaded/obtained.