de.oio.jpdfunit.document
Interface Content

public interface Content

The interface Content provides the user the possibilities to get content relative informations of the pdf document.

Author:

bbratkus

Method Summary

String	getContent() The method returns the content of the document.
String	getContentOnPage(int page) The method returns the content of the document for a certain page.
int	getFirstPageForContent(String text, TextSearchType type) The method returns the page number for a certain text and type.
List	getListOfPagesForContent(String text, TextSearchType type) The method returns the page numbers for a certain text and type.
int[]	getPagesForContent(String text, TextSearchType type) Deprecated. As of version 0.93, replaced by Content.getListOfPagesForContent(String text, TextSearchType type).
boolean	isTextContent(String text, TextSearchType type) The method returns true for a certain text and type if it is content.
boolean	isTextContentOnPage(String text, TextSearchType type, int page) The method returns true for a certain text, type and if it is content.

Method Detail

getContent

String getContent()

The method returns the content of the document.

Returns:

The content of the pdf file.

getContentOnPage

String getContentOnPage(int page)

The method returns the content of the document for a certain page.

Parameters:

page - The page to get the content for. The page count is 1-based.

Returns:

The content of the pdf file on the selected page.

getFirstPageForContent

int getFirstPageForContent(String text,
                           TextSearchType type)

The method returns the page number for a certain text and type.

Parameters:

text - The text to search within the document for. Even a regular expression is a valid parameter.

type - The TextSearchtype but remember that this is relative to the single pages of the document.

Returns:

The page number for the input parameters.

getListOfPagesForContent

List getListOfPagesForContent(String text,
                              TextSearchType type)

The method returns the page numbers for a certain text and type.

Parameters:

text - The text to search within the document for. Even a regular expression is a valid parameter.

type - The TextSearchtype but remember that this is relative to the single pages of the document.

Returns:

The page numbers for the input parameters. The page count is 1-based.

getPagesForContent

int[] getPagesForContent(String text,
                         TextSearchType type)

Deprecated. As of version 0.93, replaced by Content.getListOfPagesForContent(String text, TextSearchType type).

The method returns the page numbers for a certain text and type.

Parameters:

text - The text to search within the document for. Even a regular expression is a valid parameter.

type - The TextSearchtype but remember that this is relative to the single pages of the document.

Returns:

The page numbers for the input parameters. The page count is 1-based.

See Also:

Content

isTextContent

boolean isTextContent(String text,
                      TextSearchType type)

The method returns true for a certain text and type if it is content.

Parameters:

text - The text to search within the document for. Even a regular expression is a valid parameter.

type - The TextSearchtype but remember that this is relative to the single pages of the document.

Returns:

Returns true if the parameters matches.

isTextContentOnPage

boolean isTextContentOnPage(String text,
                            TextSearchType type,
                            int page)

The method returns true for a certain text, type and if it is content.

Parameters:

text - The text to search within the document for. Even a regular expression is a valid parameter.

type - The TextSearchtype but remember that this is relative to the single pages of the document.

page - The supposed page for the text. The page count is 1-based.

Returns:

Returns true if the parameters matches.