com.gnostice.documents

Class PageRangeSettings

java.lang.Object

com.gnostice.documents.PageRangeSettings

All Implemented Interfaces:

Cloneable

public class PageRangeSettings
extends Object
implements Cloneable

This class represents page range settings for document-processing operations.

See Also:

DocumentConverter.convertToFile(Object, String, String, String, EncoderSettings, boolean, Object, Object)

Constructor Summary

Constructors

Constructor and Description
PageRangeSettings() Creates a new instance of this class with all pages selected for printing.
PageRangeSettings(String pageRange) Creates a new instance of this class with specified page range.
PageRangeSettings(String pageRange, PageRange pageSubRangeMode, PageOrdering pageOrdering) Creates a new instance of this class with specified page range and other settings.

Method Summary

Modifier and Type	Method and Description
Object	clone()
PageOrdering	getPageOrdering() Returns specified page order.
String	getPageRange() Returns the current page range.
PageRange	getPageSubRangeMode() Returns current page selection setting.
void	setPageOrdering(PageOrdering pageOrdering) Sets specified page order.
void	setPageRange(String pageRange) Sets specified page range.
void	setPageSubRangeMode(PageRange pageSubRangeMode) Sets specified page selection.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRangeSettings

public PageRangeSettings()

Creates a new instance of this class with all pages selected for printing.

PageRangeSettings

public PageRangeSettings(String pageRange,
                         PageRange pageSubRangeMode,
                         PageOrdering pageOrdering)

Creates a new instance of this class with specified page range and other settings.

Parameters:

pageRange - pages that need to be included

pageSubRangeMode - which pages in the specified pages need to be selected

pageOrdering - how the pages need to be ordered

PageRangeSettings

public PageRangeSettings(String pageRange)

Creates a new instance of this class with specified page range. If the specified page range is "" or "-", then all pages will be included.

Parameters:

pageRange - pages that need to be included

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getPageRange

public String getPageRange()

Returns the current page range.

Returns:

the current page range

setPageRange

public void setPageRange(String pageRange)

Sets specified page range.

Parameters:

pageRange - page range that needs to be set

getPageSubRangeMode

public PageRange getPageSubRangeMode()

Returns current page selection setting.

Returns:

constant specify current page selection

setPageSubRangeMode

public void setPageSubRangeMode(PageRange pageSubRangeMode)

Sets specified page selection.

Parameters:

pageSubRangeMode - constant specify current page selection

getPageOrdering

public PageOrdering getPageOrdering()

Returns specified page order.

Returns:

constant specifying current page order

setPageOrdering

public void setPageOrdering(PageOrdering pageOrdering)

Sets specified page order.

Parameters:

pageOrdering - constant specifying current page order