Interface CoverPageContributor

All Known Implementing Classes:
DefaultCoverPageContributor

public interface CoverPageContributor
This interface allows users to provide custom implementations for modifying or adding parameters that will be used when generating cover pages. Implementers of this interface can modify or add parameters based on the given Item. These parameters will be processed and passed to the rendering engine, allowing users to customize the cover page generation.
  • Method Details

    • processCoverPageParams

      Map<String,String> processCoverPageParams(Item item, Map<String,String> parameters)
      Processes and potentially modifies or adds parameters related to cover page generation. Implementers can use the provided Item object and an existing map of parameters to modify or add new key-value pairs. The resulting set of parameters will be passed on to the rendering step.
      Parameters:
      item - The Item that the coverpage is rendered for.
      parameters - A map of existing parameters that are already set for the cover page.
      Returns:
      A map containing the final set of parameters after modification. This map will be passed to the rendering step for cover page generation.