com.groupdocs.markdown

Class CustomImagesStrategy

java.lang.Object

com.groupdocs.markdown.CustomImagesStrategy

All Implemented Interfaces:

IImageExportStrategy

public class CustomImagesStrategy
extends Object
implements IImageExportStrategy

Implements an image export strategy that allows the user to control how images are saved when a document is converted to Markdown format.

Example:

 // Set options
 DocumentConverterOptions options = new DocumentConverterOptions();
 options.setImageExportStrategy(new CustomImagesStrategy(imageFolder, this::renameImageHandler));

 // Convert document without saving images
 String markdown = MarkdownConverter.convert("document.pdf", options);
 // The markdown will contain image references like "file_0_originalName",
 // but the actual image files won't be saved

 private int index = 0;

 // Renaming function
 private void renameImageHandler(CustomImageSavingArgs args) {
     args.setOutputImageFileName("file_" + index + "_" + args.getImageFileName());
     index++;
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomImagesStrategy.CustomImageSavingHandler Functional interface representing a custom image-saving handler.

Constructor Summary

Constructors

Constructor and Description
CustomImagesStrategy(String imagesFolder, CustomImagesStrategy.CustomImageSavingHandler customHandler) Initializes a new instance of the CustomImagesStrategy class.

Method Summary

Modifier and Type	Method and Description
CustomImagesStrategy.CustomImageSavingHandler	getCustomHandler()
String	getImagesFolder() Gets the folder where images will be exported.
OutputStream	getImageStream(ImageExportContext context) Gets an output stream for writing the exported image to the file system.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomImagesStrategy

public CustomImagesStrategy(String imagesFolder,
                            CustomImagesStrategy.CustomImageSavingHandler customHandler)

Initializes a new instance of the CustomImagesStrategy class.

Parameters:

imagesFolder - The folder where images will be exported.

customHandler - The custom handler defining the mechanism for saving images.

Throws:

IllegalArgumentException - if imagesFolder is null.

Method Detail

getImagesFolder

public String getImagesFolder()

Gets the folder where images will be exported.

Specified by:

getImagesFolder in interface IImageExportStrategy

Returns:

The path to the folder where images will be saved.

getImageStream

public OutputStream getImageStream(ImageExportContext context)

Gets an output stream for writing the exported image to the file system.

If the images folder does not exist, it will be created automatically. The image will be saved with the filename specified in the ImageExportContext.

Specified by:

getImageStream in interface IImageExportStrategy

Parameters:

context - The image export context containing information about the image being processed.

Returns:

An output stream for writing the image data to the file system.

getCustomHandler

public CustomImagesStrategy.CustomImageSavingHandler getCustomHandler()