MultiPageOptions

Inheritance: java.lang.Object

public class MultiPageOptions

Base class for multiple pages supported formats

Constructors

ConstructorDescription
MultiPageOptions()Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(int[] pages)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(int[] pages, Rectangle exportArea)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(String[] pageTitles)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(String[] pageTitles, Rectangle exportArea)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(IntRange[] ranges)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(IntRange[] ranges, Rectangle exportArea)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(IntRange range)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(IntRange range, Rectangle exportArea)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(int page)Initializes a new instance of the MultiPageOptions class.
MultiPageOptions(int page, Rectangle exportArea)Initializes a new instance of the MultiPageOptions class.

Methods

MethodDescription
getPages()Gets or sets the pages.
setPages(int[] value)Gets or sets the pages.
getPageTitles()Gets or sets the page titles.
setPageTitles(String[] value)Gets or sets the page titles.
getTimeInterval()Gets the time interval.
setTimeInterval(TimeInterval value)Sets the time interval.
getPageRasterizationOptions()Gets the page rasterization options.
setPageRasterizationOptions(VectorRasterizationOptions[] value)Sets the page rasterization options.
getExportArea()Gets or sets the export area.
setExportArea(Rectangle value)Gets or sets the export area.
getMode()Gets or sets the mode.
setMode(int value)Gets or sets the mode.
getOutputLayersNames()Gets or sets the output layers names(Works if export format supports layers naming, for example for Psd)
setOutputLayersNames(String[] value)Gets or sets the output layers names(Works if export format supports layers naming, for example for Psd)
getMergeLayers()Gets a value indicating whether [merge layers].
setMergeLayers(boolean value)Sets a value indicating whether [merge layers].
initPages(IntRange[] ranges)Initializes the pages from ranges array

MultiPageOptions()

public MultiPageOptions()

Initializes a new instance of the MultiPageOptions class.

MultiPageOptions(int[] pages)

public MultiPageOptions(int[] pages)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pagesint[]The pages.

MultiPageOptions(int[] pages, Rectangle exportArea)

public MultiPageOptions(int[] pages, Rectangle exportArea)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pagesint[]The array of pages.
exportAreaRectangleThe export area.

MultiPageOptions(String[] pageTitles)

public MultiPageOptions(String[] pageTitles)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pageTitlesjava.lang.String[]The page titles.

MultiPageOptions(String[] pageTitles, Rectangle exportArea)

public MultiPageOptions(String[] pageTitles, Rectangle exportArea)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pageTitlesjava.lang.String[]The page titles.
exportAreaRectangleThe export area.

MultiPageOptions(IntRange[] ranges)

public MultiPageOptions(IntRange[] ranges)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
rangesIntRange[]The IntRange.

MultiPageOptions(IntRange[] ranges, Rectangle exportArea)

public MultiPageOptions(IntRange[] ranges, Rectangle exportArea)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
rangesIntRange[]The IntRange.
exportAreaRectangleThe export area.

MultiPageOptions(IntRange range)

public MultiPageOptions(IntRange range)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
rangeIntRangeThe IntRange.

MultiPageOptions(IntRange range, Rectangle exportArea)

public MultiPageOptions(IntRange range, Rectangle exportArea)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
rangeIntRangeThe IntRange.
exportAreaRectangleThe export area.

MultiPageOptions(int page)

public MultiPageOptions(int page)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pageintThe page index.

MultiPageOptions(int page, Rectangle exportArea)

public MultiPageOptions(int page, Rectangle exportArea)

Initializes a new instance of the MultiPageOptions class.

Parameters:

ParameterTypeDescription
pageintThe page index.
exportAreaRectangleThe export area.

getPages()

public int[] getPages()

Gets or sets the pages.

Value: The pages.

Returns: int[]

setPages(int[] value)

public void setPages(int[] value)

Gets or sets the pages.

Value: The pages.

Parameters:

ParameterTypeDescription
valueint[]

Example: This example shows how to convert a multi-page DJVU image to a multi-frame TIFF image.

String dir = "c:\\temp\\";

// Load a DJVU image from a file stream.
java.io.FileInputStream stream = new java.io.FileInputStream(dir + "sample.djvu");
try {
    com.aspose.imaging.fileformats.djvu.DjvuImage djvuImage = new com.aspose.imaging.fileformats.djvu.DjvuImage(stream);
    try {
        com.aspose.imaging.imageoptions.TiffOptions saveOptions = new com.aspose.imaging.imageoptions.TiffOptions(com.aspose.imaging.fileformats.tiff.enums.TiffExpectedFormat.Default);
        saveOptions.setCompression(com.aspose.imaging.fileformats.tiff.enums.TiffCompressions.Deflate);

        // Note that if the image is colorful, it will be automatically converted to B/W format according to the option below:
        saveOptions.setBitsPerSample(new int[]{1});

        saveOptions.setMultiPageOptions(new com.aspose.imaging.imageoptions.DjvuMultiPageOptions());

        // By default, all pages will be stored to the output TIFF, but the desired set of pages can be specified explicitly.
        // Only the first and the second page will be exported.
        saveOptions.getMultiPageOptions().setPages(new int[]{0, 1});

        // Set page titles.
        saveOptions.getMultiPageOptions().setPageTitles(new String[]{"The First Page", "The Second Page"});

        // Save to TIFF
        djvuImage.save(dir + "sample.tif", saveOptions);
    } finally {
        djvuImage.dispose();
    }
} finally {
    stream.close();
}

getPageTitles()

public String[] getPageTitles()

Gets or sets the page titles.

Value: The page titles.

Returns: java.lang.String[]

setPageTitles(String[] value)

public void setPageTitles(String[] value)

Gets or sets the page titles.

Value: The page titles.

Parameters:

ParameterTypeDescription
valuejava.lang.String[]

Example: This example shows how to convert a multi-page DJVU image to a multi-frame TIFF image.

String dir = "c:\\temp\\";

// Load a DJVU image from a file stream.
java.io.FileInputStream stream = new java.io.FileInputStream(dir + "sample.djvu");
try {
    com.aspose.imaging.fileformats.djvu.DjvuImage djvuImage = new com.aspose.imaging.fileformats.djvu.DjvuImage(stream);
    try {
        com.aspose.imaging.imageoptions.TiffOptions saveOptions = new com.aspose.imaging.imageoptions.TiffOptions(com.aspose.imaging.fileformats.tiff.enums.TiffExpectedFormat.Default);
        saveOptions.setCompression(com.aspose.imaging.fileformats.tiff.enums.TiffCompressions.Deflate);

        // Note that if the image is colorful, it will be automatically converted to B/W format according to the option below:
        saveOptions.setBitsPerSample(new int[]{1});

        saveOptions.setMultiPageOptions(new com.aspose.imaging.imageoptions.DjvuMultiPageOptions());

        // By default, all pages will be stored to the output TIFF, but the desired set of pages can be specified explicitly.
        // Only the first and the second page will be exported.
        saveOptions.getMultiPageOptions().setPages(new int[]{0, 1});

        // Set page titles.
        saveOptions.getMultiPageOptions().setPageTitles(new String[]{"The First Page", "The Second Page"});

        // Save to TIFF
        djvuImage.save(dir + "sample.tif", saveOptions);
    } finally {
        djvuImage.dispose();
    }
} finally {
    stream.close();
}

getTimeInterval()

public final TimeInterval getTimeInterval()

Gets the time interval.

Value: The time interval.

Returns: TimeInterval - the time interval.

setTimeInterval(TimeInterval value)

public final void setTimeInterval(TimeInterval value)

Sets the time interval.

Value: The time interval.

Parameters:

ParameterTypeDescription
valueTimeIntervalthe time interval.

getPageRasterizationOptions()

public final VectorRasterizationOptions[] getPageRasterizationOptions()

Gets the page rasterization options.

Returns: com.aspose.imaging.imageoptions.VectorRasterizationOptions[] - the page rasterization options.

setPageRasterizationOptions(VectorRasterizationOptions[] value)

public final void setPageRasterizationOptions(VectorRasterizationOptions[] value)

Sets the page rasterization options.

Parameters:

ParameterTypeDescription
valueVectorRasterizationOptions[]the page rasterization options.

getExportArea()

public Rectangle getExportArea()

Gets or sets the export area.

Value: The export area.

Returns: Rectangle

setExportArea(Rectangle value)

public void setExportArea(Rectangle value)

Gets or sets the export area.

Value: The export area.

Parameters:

ParameterTypeDescription
valueRectangle

getMode()

public int getMode()

Gets or sets the mode.

Value: The mode.

Returns: int

setMode(int value)

public void setMode(int value)

Gets or sets the mode.

Value: The mode.

Parameters:

ParameterTypeDescription
valueint

getOutputLayersNames()

public String[] getOutputLayersNames()

Gets or sets the output layers names(Works if export format supports layers naming, for example for Psd)

Value: The output layers names.

Returns: java.lang.String[]

setOutputLayersNames(String[] value)

public void setOutputLayersNames(String[] value)

Gets or sets the output layers names(Works if export format supports layers naming, for example for Psd)

Value: The output layers names.

Parameters:

ParameterTypeDescription
valuejava.lang.String[]

getMergeLayers()

public final boolean getMergeLayers()

Gets a value indicating whether [merge layers].

Value: true if [merge layers]; otherwise, false.

Returns: boolean - a value indicating whether [merge layers].

setMergeLayers(boolean value)

public final void setMergeLayers(boolean value)

Sets a value indicating whether [merge layers].

Value: true if [merge layers]; otherwise, false.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether [merge layers].

initPages(IntRange[] ranges)

public void initPages(IntRange[] ranges)

Initializes the pages from ranges array

Parameters:

ParameterTypeDescription
rangesIntRange[]The ranges.