Package com.scroogexhtml.pictures

Interface PictureAdapter

public interface PictureAdapter
The PictureAdapter interface is designed to support the conversion of embedded pictures within RTF (Rich Text Format) documents. It provides methods for initializing, adding, finalizing, and retrieving pictures during the conversion process. Implementing classes can use these methods to manage the pictures encountered in the RTF code and potentially transform or store them as needed.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPicture()
    Processes and adds an embedded picture encountered during the conversion of RTF documents into a more usable format.
    default void
    beforeConvert()
    This method is invoked before the conversion of embedded pictures in RTF documents.
    void
    finalizePicture()
    Completes any remaining tasks after the processing of an embedded picture during the RTF document conversion process.
    EmbeddedPicture
    getCurrentPicture()
    Retrieves the current embedded picture in the conversion process.
    Map<String,EmbeddedPicture>
    getPictures()
    Retrieves a map of embedded pictures.

  • Method Details

    • beforeConvert

      default void beforeConvert()
      This method is invoked before the conversion of embedded pictures in RTF documents. Implementing classes can override this method to perform any necessary setup or initialization prior to the picture conversion process.

    • addPicture

      void addPicture()
      Processes and adds an embedded picture encountered during the conversion of RTF documents into a more usable format. Implementing classes should provide the logic to handle the picture data that is being added.

    • getCurrentPicture

      EmbeddedPicture getCurrentPicture()
      Retrieves the current embedded picture in the conversion process.
      Returns:
      the current EmbeddedPicture being processed or managed by the implementation.

    • finalizePicture

      void finalizePicture()
      Completes any remaining tasks after the processing of an embedded picture during the RTF document conversion process. Implementing classes should use this method to perform any cleanup, finalization, or post-processing needed once an embedded picture has been added, and any necessary transformations have been applied.

    • getPictures

      Map<String,EmbeddedPicture> getPictures()
      Retrieves a map of embedded pictures.
      Returns:
      a map where the keys are unique string identifiers for each picture, and the values are the corresponding EmbeddedPicture objects associated with those identifiers.