Package com.atlassian.confluence.search.summary

Interface HitHighlighterFactory

All Known Implementing Classes:

DefaultHitHighlighterFactory

public interface HitHighlighterFactory

Creates a HitHighlighter which finds search hits in content based on a given Lucene query. Highlights those hits with a formatter.

Method Summary

Modifier and Type	Method	Description
HitHighlighter	create(String queryString)	Create a new highlighter that uses the default formatter, and HTML encoding.

Method Details

create

HitHighlighter create(String queryString)

Create a new highlighter that uses the default formatter, and HTML encoding.

The output format for hit highlights is: Lorem ipsum <span class="search-highlight>dolor</span> sit amet