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 gives you full control over how images are saved during conversion.

Supply an IImageSavingHandler implementation to rename images, redirect them to a custom stream, or apply any other custom logic when each image is encountered.

Example:

 IImageSavingHandler handler = new RenameHandler();

 ConvertOptions options = new ConvertOptions();
 options.setImageExportStrategy(new CustomImagesStrategy("images", handler));

 String markdown = MarkdownConverter.toMarkdown("document.docx", options);
 

Constructor Summary

Constructors

Constructor and Description
CustomImagesStrategy(String imagesFolder, com.groupdocs.markdown.imageexport.IImageSavingHandler handler) Initializes a new instance of the CustomImagesStrategy class.

Method Summary

Modifier and Type	Method and Description
com.groupdocs.markdown.imageexport.IImageSavingHandler	getCustomHandler()
String	getImagesFolder() Gets the physical folder where images will be saved on disk.
String	getImagesRelativePath() Gets or sets the path used in the Markdown image references.
OutputStream	getImageStream(ImageExportContext context) Gets a stream for writing the exported image to the file system.
void	setImagesRelativePath(String imagesRelativePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomImagesStrategy

public CustomImagesStrategy(String imagesFolder,
                            com.groupdocs.markdown.imageexport.IImageSavingHandler handler)

Initializes a new instance of the CustomImagesStrategy class.

Parameters:

imagesFolder - the folder where images will be exported

handler - the handler that is called for each image during conversion

Method Detail

getImagesFolder

public String getImagesFolder()

Gets the physical folder where images will be saved on disk.

Specified by:

getImagesFolder in interface IImageExportStrategy

Returns:

a relative or absolute folder path. This value is used to construct image URIs in the Markdown output.

getImagesRelativePath

public String getImagesRelativePath()

Gets or sets the path used in the Markdown image references. When null or empty, the full imagesFolder path is used.

setImagesRelativePath

public void setImagesRelativePath(String imagesRelativePath)

getImageStream

public OutputStream getImageStream(ImageExportContext context)

Gets a stream for writing the exported image to the file system.

Specified by:

getImageStream in interface IImageExportStrategy

Parameters:

context - The image export context containing the default image file name and other metadata. You may modify imageFileName before returning the stream to change the file name that appears in the Markdown output.

Returns:

a writable stream where the image data will be written, or null to use the default behavior

getCustomHandler

public com.groupdocs.markdown.imageexport.IImageSavingHandler getCustomHandler()