org.jodconverter.filter

Class PagesSelectorFilter

java.lang.Object

org.jodconverter.filter.PagesSelectorFilter

All Implemented Interfaces:

Filter

public class PagesSelectorFilter
extends Object
implements Filter

This filter is used to select specific pages from a document in order to convert only the selected pages.

Constructor Summary

Constructors

Constructor and Description
PagesSelectorFilter(Integer... pages) Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).
PagesSelectorFilter(Set<Integer> pages) Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).

Method Summary

Modifier and Type	Method and Description
void	doFilter(org.jodconverter.office.OfficeContext context, com.sun.star.lang.XComponent document, FilterChain chain) The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request.

Methods inherited from class java.lang.Object

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

Constructor Detail

PagesSelectorFilter

public PagesSelectorFilter(Integer... pages)

Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).

Parameters:

pages - The page numbers of the page to convert. First page is index 1.

PagesSelectorFilter

public PagesSelectorFilter(Set<Integer> pages)

Creates a new filter that will select the specified pages while converting a document (only the given pages will be converted).

Parameters:

pages - The page numbers of the page to convert. First page is index 1.

Method Detail

doFilter

public void doFilter(org.jodconverter.office.OfficeContext context,
                     com.sun.star.lang.XComponent document,
                     FilterChain chain)
              throws Exception

Description copied from interface: Filter

The doFilter method of the Filter is called each time a document is passed through the chain due to a conversion request. The FilterChain passed in to this method allows the Filter to pass on the document to the next entity in the chain.

A typical implementation of this method would either invoke the next filter in the chain using the FilterChain object (chain.doFilter()), or not pass on the document to the next filter in the filter chain to block the conversion processing.

Specified by:

doFilter in interface Filter

Parameters:

context - The OfficeContext in use to pass along the chain.

document - The XComponent being converted to pass along the chain.

chain - The chain.

Throws:

Exception - If an error occurs processing the filter.