Package org.apache.lucene.search.highlight

# Class SpanGradientFormatter

java.lang.Object
org.apache.lucene.search.highlight.GradientFormatter
org.apache.lucene.search.highlight.SpanGradientFormatter

All Implemented Interfaces:
  `Formatter`

public class SpanGradientFormatter extends GradientFormatter
Formats text with different color intensity depending on the score of the term using the span tag. GradientFormatter uses a bgcolor argument to the font tag which doesn't work in Mozilla, thus this class.

See Also:
  - `GradientFormatter`

## Field Summary

### Fields inherited from class org.apache.lucene.search.highlight.GradientFormatter

`highlightBackground, highlightForeground`

## Constructor Summary

Constructors
Constructor
Description
`SpanGradientFormatter(float maxScore, String minForegroundColor, String maxForegroundColor, String minBackgroundColor, String maxBackgroundColor)`

## Method Summary

Modifier and Type
Method
Description
`String`
`highlightTerm(String originalText, TokenGroup tokenGroup)`

### Methods inherited from class org.apache.lucene.search.highlight.GradientFormatter

`getBackgroundColorString, getForegroundColorString, hexToInt`

### Methods inherited from class java.lang.Object

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

## Constructor Details

### SpanGradientFormatter

public SpanGradientFormatter(float maxScore, String minForegroundColor, String maxForegroundColor, String minBackgroundColor, String maxBackgroundColor)

## Method Details

### highlightTerm

public String highlightTerm(String originalText, TokenGroup tokenGroup)

Specified by:
  `highlightTerm` in interface `Formatter`
Overrides:
  `highlightTerm` in class `GradientFormatter`
Parameters:
  `originalText` - The section of text being considered for markup
  `tokenGroup` - contains one or several overlapping Tokens along with their scores and positions.