com.groupdocs.search.options

Class HighlightOptions

java.lang.Object

com.groupdocs.search.options.TextOptions

com.groupdocs.search.options.HighlightOptions

All Implemented Interfaces:

IHighlightOptions, ITextOptions

public class HighlightOptions
extends TextOptions
implements IHighlightOptions

Provides options for highlighting found terms.

Learn more

• Highlighting search results

Field Summary

Fields inherited from class com.groupdocs.search.options.TextOptions

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	HighlightOptions() Initializes a new instance of the HighlightOptions class.
	HighlightOptions(Object data) Initializes a new instance of the TextOptions class.
protected	HighlightOptions(Object state1, Object state2) Initializes a new instance of the TextOptions class.

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 class com.groupdocs.search.options.TextOptions

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

HighlightOptions

public HighlightOptions()

Initializes a new instance of the HighlightOptions class.

HighlightOptions

public HighlightOptions(Object data)

Initializes a new instance of the TextOptions class.

Parameters:

data - The serialized data.

HighlightOptions

protected HighlightOptions(Object state1,
                           Object state2)

Initializes a new instance of the TextOptions class.

Parameters:

state1 - The state 1.

state2 - The state 2.

Method Detail

getHighlightColor

public Color getHighlightColor()

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

Specified by:

getHighlightColor in interface IHighlightOptions

Returns:

A color that is used to highlight occurrences.

getTermHighlightEndTag

public 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.

Specified by:

getTermHighlightEndTag in interface IHighlightOptions

Returns:

The end tag of the highlighting of the found word.

getTermHighlightStartTag

public 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.

Specified by:

getTermHighlightStartTag in interface IHighlightOptions

Returns:

The start tag of the highlighting of the found word.

getTermsAfter

public 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.

Specified by:

getTermsAfter in interface IHighlightOptions

Returns:

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

getTermsBefore

public 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.

Specified by:

getTermsBefore in interface IHighlightOptions

Returns:

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

getTermsTotal

public 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.

Specified by:

getTermsTotal in interface IHighlightOptions

Returns:

The maximum number of words in a text snippet.

getUseInlineStyles

public boolean getUseInlineStyles()

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

Specified by:

getUseInlineStyles in interface IHighlightOptions

Returns:

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

setHighlightColor

public void setHighlightColor(Color value)

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

Specified by:

setHighlightColor in interface IHighlightOptions

Parameters:

value - A color that is used to highlight occurrences.

setTermHighlightEndTag

public 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.

Specified by:

setTermHighlightEndTag in interface IHighlightOptions

Parameters:

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

setTermHighlightStartTag

public 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.

Specified by:

setTermHighlightStartTag in interface IHighlightOptions

Parameters:

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

setTermsAfter

public 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.

Specified by:

setTermsAfter in interface IHighlightOptions

Parameters:

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

setTermsBefore

public 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.

Specified by:

setTermsBefore in interface IHighlightOptions

Parameters:

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

setTermsTotal

public 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.

Specified by:

setTermsTotal in interface IHighlightOptions

Parameters:

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

setUseInlineStyles

public void setUseInlineStyles(boolean value)

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

Specified by:

setUseInlineStyles in interface IHighlightOptions

Parameters:

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