com.groupdocs.comparison.options

Class PreviewOptions

java.lang.Object

com.groupdocs.comparison.options.PreviewOptions

public class PreviewOptions
extends Object

Provides options for generating document previews in the comparison process.

Example usage:

 try (Comparer comparer = new Comparer(sourceFile)) {

    PreviewOptions previewOptions = new PreviewOptions(
            pageNumber -> Files.newOutputStream(Paths.get(String.format("preview-page_%d.png", pageNumber)))
    );
    previewOptions.setPreviewFormat(PreviewFormats.PNG);
    previewOptions.setPageNumbers(new int[]{1, 2});

    comparer.getSource().generatePreview(previewOptions);
 }
 

See Also:

Comparer, PreviewFormats

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreviewOptions.Builder A PreviewOptions builder.

Constructor Summary

Constructors

Constructor and Description
PreviewOptions(CreatePageStreamFunction createPageStream) Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction function.
PreviewOptions(CreatePageStreamFunction createPageStream, ReleasePageStreamFunction releasePageStream) Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction and ReleasePageStreamFunction function.
PreviewOptions(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream) Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream function.
PreviewOptions(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream, com.groupdocs.comparison.common.delegates.Delegates.ReleasePageStream releasePageStream) Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream and Delegates.ReleasePageStream function.

Method Summary

Modifier and Type	Method and Description
CreatePageStreamFunction	getCreatePageStream() Gets a function to create output page preview stream.
int	getHeight() Gets the height of the preview images.
int[]	getPageNumbers() Gets an array of page numbers for which preview images will be generated.
PreviewFormats	getPreviewFormat() Gets a format of preview images.
ReleasePageStreamFunction	getReleasePageStream() Gets a function to release output page preview stream.
int	getWidth() Gets the width of the preview images.
void	setCreatePageStream(CreatePageStreamFunction createPageStream) Sets a function to create output page preview stream.
void	setCreatePageStream(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream) Sets a function to create output page preview stream.
void	setHeight(int value) Sets the height of the preview images.
void	setPageNumbers(int[] value) Sets an array of page numbers for which preview images will be generated.
void	setPreviewFormat(PreviewFormats value) Sets a format of preview images.
void	setReleasePageStream(com.groupdocs.comparison.common.delegates.Delegates.ReleasePageStream releasePageStream) Gets a function to release output page preview stream.
void	setReleasePageStream(ReleasePageStreamFunction releasePageStream) Sets a function to release output page preview stream.
void	setWidth(int value) Sets the width of the preview images.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewOptions

public PreviewOptions(CreatePageStreamFunction createPageStream)

Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction function.

Parameters:

createPageStream - The function to create output page preview stream.

PreviewOptions

public PreviewOptions(CreatePageStreamFunction createPageStream,
                      ReleasePageStreamFunction releasePageStream)

Initializes a new instance of the PreviewOptions class specifying CreatePageStreamFunction and ReleasePageStreamFunction function.

Parameters:

createPageStream - The function to create output page preview stream.

releasePageStream - The function to release output page preview stream.

PreviewOptions

public PreviewOptions(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream)

Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream function.

Parameters:

createPageStream - The function to create output page preview stream.

PreviewOptions

public PreviewOptions(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream,
                      com.groupdocs.comparison.common.delegates.Delegates.ReleasePageStream releasePageStream)

Initializes a new instance of the PreviewOptions class specifying Delegates.CreatePageStream and Delegates.ReleasePageStream function.

Parameters:

createPageStream - The function to create output page preview stream.

releasePageStream - The function to release output page preview stream.

Method Detail

getCreatePageStream

public CreatePageStreamFunction getCreatePageStream()

Gets a function to create output page preview stream.

Returns:

the function to create output page preview stream.

getHeight

public final int getHeight()

Gets the height of the preview images.

Returns:

the height of the preview images.

getPageNumbers

public final int[] getPageNumbers()

Gets an array of page numbers for which preview images will be generated.

Returns:

page numbers array

getPreviewFormat

public final PreviewFormats getPreviewFormat()

Gets a format of preview images.

Returns:

preview images format

getReleasePageStream

public ReleasePageStreamFunction getReleasePageStream()

Gets a function to release output page preview stream.

Returns:

the function to release output page preview stream.

getWidth

public final int getWidth()

Gets the width of the preview images.

Returns:

the width of the preview images.

setCreatePageStream

public void setCreatePageStream(CreatePageStreamFunction createPageStream)

Sets a function to create output page preview stream.

Parameters:

createPageStream - The function to create output page preview stream.

setCreatePageStream

public void setCreatePageStream(com.groupdocs.comparison.common.delegates.Delegates.CreatePageStream createPageStream)

Sets a function to create output page preview stream.

Parameters:

createPageStream - The function to create output page preview stream.

setHeight

public final void setHeight(int value)

Sets the height of the preview images.

Parameters:

value - The height of the preview images.

setPageNumbers

public final void setPageNumbers(int[] value)

Sets an array of page numbers for which preview images will be generated.

Parameters:

value - Page numbers array

setPreviewFormat

public final void setPreviewFormat(PreviewFormats value)

Sets a format of preview images.

Parameters:

value - Preview images format

setReleasePageStream

public void setReleasePageStream(com.groupdocs.comparison.common.delegates.Delegates.ReleasePageStream releasePageStream)

Gets a function to release output page preview stream.

Parameters:

releasePageStream - The function to release output page preview stream.

setReleasePageStream

public void setReleasePageStream(ReleasePageStreamFunction releasePageStream)

Sets a function to release output page preview stream.

Parameters:

releasePageStream - The function to release output page preview stream.

setWidth

public final void setWidth(int value)

Sets the width of the preview images.

Parameters:

value - The width of the preview images.