com.groupdocs.parser.data

Class HighlightItem

java.lang.Object

com.groupdocs.parser.data.HighlightItem

public class HighlightItem
extends Object

Represents a highlight, a part of the text which is usually used to explain the context of the found text in the search functionality.

An instance of HighlightItem class is used as return value of Parser.getHighlight(int, boolean, com.groupdocs.parser.options.HighlightOptions) method, SearchResult.getLeftHighlightItem() and SearchResult.getRightHighlightItem() properties. See the usage examples there.

Constructor Summary

Constructors

Constructor and Description
HighlightItem(int position, String text) Initializes a new instance of the HighlightItem class.

Method Summary

Modifier and Type	Method and Description
int	getPosition() Gets the position in the document text.
String	getText() Gets the text of the highlight.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightItem

public HighlightItem(int position,
                     String text)

Initializes a new instance of the HighlightItem class.

Parameters:

position - The position in the document text.

text - The text of the highlight.

Method Detail

getPosition

public int getPosition()

Gets the position in the document text.

Returns:

A zero-based index of the start position of the highlight.

getText

public String getText()

Gets the text of the highlight.

Returns:

A string value that represents the text of the highlight.