com.groupdocs.redaction.options

Class PreviewOptions


  • public class PreviewOptions
extends Object

    Provides options to sets requirements and stream delegates for preview generation.

    • Constructor Detail

      • PreviewOptions

        public PreviewOptions(ICreatePageStream createPageStream)

        Initializes a new instance of PreviewOptions class, causing the output stream to be closed.

        Parameters:
        createPageStream - Creates a stream for a specific page preview

      • PreviewOptions

        public PreviewOptions(ICreatePageStream createPageStream,
              IReleasePageStream releasePageStream)

        Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use.

        Parameters:
        createPageStream - Creates a stream for a specific page preview
        releasePageStream - Notifies that the page preview generation is done and gets output stream

    • Method Detail

      • getWidth

        public final int getWidth()

        Gets or sets page preview width.

        Returns:
        Page preview width.

      • setWidth

        public final void setWidth(int value)

        Gets or sets page preview width.

        Parameters:
        value - Page preview width.

      • getHeight

        public final int getHeight()

        Gets or sets page preview height.

        Returns:
        Page preview height.

      • setHeight

        public final void setHeight(int value)

        Gets or sets page preview height.

        Parameters:
        value - Page preview height.

      • getPageNumbers

        public final int[] getPageNumbers()

        Gets or sets an array of page numbers to generate preview.

        Returns:
        An array of page numbers to generate preview.

      • setPageNumbers

        public final void setPageNumbers(int[] value)

        Gets or sets an array of page numbers to generate preview.

        Parameters:
        value - An array of page numbers to generate preview.

      • getPreviewFormat

        public final PreviewFormats getPreviewFormat()

        Gets or sets preview image format.

        Returns:
        Preview image format.

      • setPreviewFormat

        public final void setPreviewFormat(PreviewFormats value)

        Gets or sets preview image format.

        Parameters:
        value - Preview image format.

      • getCreatePageStream

        public final ICreatePageStream getCreatePageStream()

        Gets or sets an instance of page stream creation delegate.

        Returns:
        An instance of page stream creation delegate.

      • setCreatePageStream

        public final void setCreatePageStream(ICreatePageStream value)

        Gets or sets an instance of page stream creation delegate.

        Parameters:
        value - An instance of page stream creation delegate.

      • getReleasePageStream

        public final IReleasePageStream getReleasePageStream()

        Gets or sets an instance of page preview completion delegate.

        Returns:
        An instance of page preview completion delegate.

      • setReleasePageStream

        public final void setReleasePageStream(IReleasePageStream value)

        Gets or sets an instance of page preview completion delegate.

        Parameters:
        value - An instance of page preview completion delegate.