Skip navigation links

com.oracle.outsidein.options
Class PageRange

java.lang.Object
com.oracle.outsidein.options.PageRange

public class PageRange

extends java.lang.Object

Indicates the range of pages to render or write to the output file.

See Also:

OptionsCache.getPageRange(), OptionsCache.setPageRange(PageRange)

Constructor Summary

PageRange()
Creates a PageRange object for rendering all pages in the source document.

PageRange(long startPage)
Creates a PageRange object for rendering from a particular start page until the last page of the source document.

PageRange(long startPage, long stopPage)
Creates a PageRange object for rendering a range of pages in the source document.

Method Summary

boolean	getPrintAll() Obtains whether all pages of the document are set to be rendered
long	getStartPage() Obtain the start page of the page range.
long	getStopPage() Obtains the last page of the page range.
void	setPrintAll(boolean value) Sets whether all pages of the document are to be rendered
void	setStartPage(long value) Sets the start page of the page range.
void	setStopPage(long value) Sets the last page of the page range.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRange

public PageRange()

Creates a PageRange object for rendering all pages in the source document.

PageRange

public PageRange(long startPage,
                 long stopPage)
          throws OutsideInException

Creates a PageRange object for rendering a range of pages in the source document.

Parameters:

startPage - the 1-based index of the start page

stopPage - the 1-based index of the last page to render

Throws:

OutsideInException

PageRange

public PageRange(long startPage)

Creates a PageRange object for rendering from a particular start page until the last page of the source document.

Parameters:

startPage - the 1-based index of the start page

Method Detail

getPrintAll

public boolean getPrintAll()

Obtains whether all pages of the document are set to be rendered

Returns:

true if all pages are to be rendered

setPrintAll

public void setPrintAll(boolean value)

Sets whether all pages of the document are to be rendered

Parameters:

value -

getStartPage

public long getStartPage()

Obtain the start page of the page range. 0 indicates rendering will begin with the first page of the source document.

Returns:

the 1-based index of the start page

setStartPage

public void setStartPage(long value)

Sets the start page of the page range. 0 indicates rendering will begin with the first page of the source document.

Parameters:

value - the 1-based index of the start page

getStopPage

public long getStopPage()

Obtains the last page of the page range. 0 indicates rendering will stop with the last page in the source document.

Returns:

the 1-based index of the last page to render

setStopPage

public void setStopPage(long value)

Sets the last page of the page range. 0 indicates rendering will stop with the last page in the source document.

Parameters:

value - the 1-based index of the last page to render

Skip navigation links