com.groupdocs.search.options

Interface IHighlightOptions

All Superinterfaces:

ITextOptions

All Known Implementing Classes:

HighlightOptions

public interface IHighlightOptions
extends ITextOptions

Defines interface of options for highlighting found terms.

Method Summary

Modifier and Type	Method and Description
Color	getHighlightColor() Gets a color that is used to highlight occurrences.
String	getTermHighlightEndTag() Gets the end tag of the highlighting of the found word.
String	getTermHighlightStartTag() Gets the start tag of the highlighting of the found word.
int	getTermsAfter() Gets the maximum number of words in a text snippet after highlighted word.
int	getTermsBefore() Gets the maximum number of words in a text snippet before highlighted word.
int	getTermsTotal() Gets the maximum number of words in a text snippet.
boolean	getUseInlineStyles() Gets a value indicating whether inline styles are used to highlight occurrences.
void	setHighlightColor(Color value) Sets a color that is used to highlight occurrences.
void	setTermHighlightEndTag(String value) Sets the end tag of the highlighting of the found word.
void	setTermHighlightStartTag(String value) Sets the start tag of the highlighting of the found word.
void	setTermsAfter(int value) Sets the maximum number of words in a text snippet after highlighted word.
void	setTermsBefore(int value) Sets the maximum number of words in a text snippet before highlighted word.
void	setTermsTotal(int value) Sets the maximum number of words in a text snippet.
void	setUseInlineStyles(boolean value) Sets a value indicating whether inline styles are used to highlight occurrences.

Methods inherited from interface com.groupdocs.search.options.ITextOptions

getAdditionalFields, getCancellation, getCustomExtractor, getGenerateHead, getImageIndexingOptions, getMetadataIndexingOptions, getOcrIndexingOptions, getUseRawTextExtraction, setAdditionalFields, setCancellation, setCustomExtractor, setGenerateHead, setUseRawTextExtraction

Method Detail

getHighlightColor

Color getHighlightColor()

Gets a color that is used to highlight occurrences. The default value is #FFD800.

Returns:

A color that is used to highlight occurrences.

getTermHighlightEndTag

String getTermHighlightEndTag()

Gets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

Returns:

The end tag of the highlighting of the found word.

getTermHighlightStartTag

String getTermHighlightStartTag()

Gets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

Returns:

The start tag of the highlighting of the found word.

getTermsAfter

int getTermsAfter()

Gets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is 7.

Returns:

The maximum number of words in a text snippet after highlighted word.

getTermsBefore

int getTermsBefore()

Gets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is 7.

Returns:

The maximum number of words in a text snippet before highlighted word.

getTermsTotal

int getTermsTotal()

Gets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is 21.

Returns:

The maximum number of words in a text snippet.

getUseInlineStyles

boolean getUseInlineStyles()

Gets a value indicating whether inline styles are used to highlight occurrences. The default value is true.

Returns:

A value indicating whether inline styles are used to highlight occurrences.

setHighlightColor

void setHighlightColor(Color value)

Sets a color that is used to highlight occurrences. The default value is #FFD800.

Parameters:

value - A color that is used to highlight occurrences.

setTermHighlightEndTag

void setTermHighlightEndTag(String value)

Sets the end tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

Parameters:

value - The end tag of the highlighting of the found word.

setTermHighlightStartTag

void setTermHighlightStartTag(String value)

Sets the start tag of the highlighting of the found word. This tag is used only when highlighting in plain text. The default value is an empty string.

Parameters:

value - The start tag of the highlighting of the found word.

setTermsAfter

void setTermsAfter(int value)

Sets the maximum number of words in a text snippet after highlighted word. The value must be in the range from 0 to 10000. The default value is 7.

Parameters:

value - The maximum number of words in a text snippet after highlighted word.

setTermsBefore

void setTermsBefore(int value)

Sets the maximum number of words in a text snippet before highlighted word. The value must be in the range from 0 to 10000. The default value is 7.

Parameters:

value - The maximum number of words in a text snippet before highlighted word.

setTermsTotal

void setTermsTotal(int value)

Sets the maximum number of words in a text snippet. The value must be in the range from 0 to 10000. The default value is 21.

Parameters:

value - The maximum number of words in a text snippet.

setUseInlineStyles

void setUseInlineStyles(boolean value)

Sets a value indicating whether inline styles are used to highlight occurrences. The default value is true.

Parameters:

value - A value indicating whether inline styles are used to highlight occurrences.