CustomImageSavingArgs Leave feedback

Inheritance: java.lang.Object

public class CustomImageSavingArgs

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).setOutputImageFileName(String) to change the file name the image is saved under, or #setOutputStream(OutputStream).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);
 

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

Parameters:

public String getImageFileName()

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

Returns: java.lang.String

public String getShapeType()

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

Returns: java.lang.String

public String getOutputDirectory()

Gets the output directory where images are being saved.

Returns: java.lang.String

public String getImageFileNameOutput()

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

Returns: java.lang.String

public OutputStream getOutputStream()

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

Returns: java.io.OutputStream

public InputStream getReplacementImageStream()

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

Returns: java.io.InputStream

public void setOutputImageFileName(String fileName)

Overrides the default file name for this image.

Parameters:

public void setOutputStream(OutputStream stream)

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

Parameters:

public void setReplacementImage(InputStream imageStream)

Provides a replacement image instead of the original.

Parameters: