public class HighlightOptions extends TextOptions
| Constructor and Description |
|---|
HighlightOptions()
Initializes a new instance of the
HighlightOptions class. |
| Modifier and Type | Method and Description |
|---|---|
Color |
getHighlightColor()
Gets or sets a color that is used to highlight occurrences.
|
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 or sets a value indicating whether inline styles are used to highlight occurrences.
|
void |
setHighlightColor(Color value)
Gets or sets a color that is used to highlight occurrences.
|
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)
Gets or sets a value indicating whether inline styles are used to highlight occurrences.
|
getAdditionalFields, getCancellation, getCustomExtractor, getGenerateHead, getMetadataIndexingOptions, setAdditionalFields, setCancellation, setCustomExtractor, setGenerateHeadpublic HighlightOptions()
Initializes a new instance of the HighlightOptions class.
public final 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.
public final 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.
value - The maximum number of words in a text snippet before highlighted word.public final 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.
public final 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.
value - The maximum number of words in a text snippet after highlighted word.public final 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.
public final 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.
value - The maximum number of words in a text snippet.public final boolean getUseInlineStyles()
Gets or sets a value indicating whether inline styles are used to highlight occurrences.
The default value is true.
public final void setUseInlineStyles(boolean value)
Gets or sets a value indicating whether inline styles are used to highlight occurrences.
The default value is true.
value - A value indicating whether inline styles are used to highlight occurrences.public final Color getHighlightColor()
Gets or sets a color that is used to highlight occurrences. The default value is #FFD800.
public final void setHighlightColor(Color value)
Gets or sets a color that is used to highlight occurrences. The default value is #FFD800.
value - A color that is used to highlight occurrences.