com.groupdocs.markdown

Class CustomImageSavingArgs

java.lang.Object

com.groupdocs.markdown.CustomImageSavingArgs

public class CustomImageSavingArgs
extends Object

Provides information and controls for saving a single image during document-to-Markdown conversion.

An instance of this class is passed to the callback registered with CustomImagesStrategy for each image found in the source document.

Use setOutputImageFileName(String) to change the file name the image is saved under, or setOutputStream(OutputStream) to redirect the image data to a custom stream. If neither method is called, the library uses the defaults provided by imageFileName and outputDirectory.

Example:

 CustomImagesStrategy strategy = new CustomImagesStrategy(args -> {
     args.setOutputImageFileName("thumb-" + args.getImageFileName());
 });

 ConvertOptions options = new ConvertOptions();
 options.setImageExportStrategy(strategy);
 

Constructor Summary

Constructors

Constructor and Description
CustomImageSavingArgs(String suggestedFileName, String shapeType, String outputDirectory)

Method Summary

Modifier and Type	Method and Description
String	getImageFileName() Gets the default file name (without path) suggested by the library for this image.
String	getImageFileNameOutput() Gets the overridden file name, or null if no override was specified.
String	getOutputDirectory() Gets the output directory where images are being saved.
OutputStream	getOutputStream() Gets the custom output stream, or null if not specified.
InputStream	getReplacementImageStream() Gets the replacement image stream, or null if not specified.
String	getShapeType() Gets the type of the shape that contains the image in the source document (for example, "Picture" or "Shape").
void	setOutputImageFileName(String fileName) Overrides the default file name for this image.
void	setOutputStream(OutputStream stream) Redirects the image data to a custom writable stream instead of file output.
void	setReplacementImage(InputStream imageStream) Provides a replacement image instead of the original.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomImageSavingArgs

public CustomImageSavingArgs(String suggestedFileName,
                             String shapeType,
                             String outputDirectory)

Method Detail

getImageFileName

public String getImageFileName()

Gets the default file name (without path) suggested by the library for this image.

getShapeType

public String getShapeType()

Gets the type of the shape that contains the image in the source document (for example, "Picture" or "Shape").

getOutputDirectory

public String getOutputDirectory()

Gets the output directory where images are being saved.

getImageFileNameOutput

public String getImageFileNameOutput()

Gets the overridden file name, or null if no override was specified.

getOutputStream

public OutputStream getOutputStream()

Gets the custom output stream, or null if not specified.

getReplacementImageStream

public InputStream getReplacementImageStream()

Gets the replacement image stream, or null if not specified.

setOutputImageFileName

public void setOutputImageFileName(String fileName)

Overrides the default file name for this image.

Parameters:

fileName - new file name (without path)

setOutputStream

public void setOutputStream(OutputStream stream)

Redirects the image data to a custom writable stream instead of file output.

Parameters:

stream - writable stream

Throws:

IllegalArgumentException - if stream is null

setReplacementImage

public void setReplacementImage(InputStream imageStream)

Provides a replacement image instead of the original.

Parameters:

imageStream - readable stream with image data

Throws:

IllegalArgumentException - if stream is null