Class HighlightState

java.lang.Object
  |
  +--HighlightState

public class HighlightState

extends java.lang.Object

Encapsulates information regarding what is to be highlighted in a ContentRenderPane. This is an immutable object.

Version:

$2006-11-04 23:55:27 mdh$

Author:

Malcolm D. Hyman

Constructor Summary

HighlightState(java.lang.String text, boolean orthNorm, boolean accentless, boolean regex, java.lang.String searchLang)
Constructor.

Method Summary

java.lang.String	getSearchLang()
java.lang.String	getText()
WordTokenTable	getWordTokenTable() The returned WordTokenTable is mutable.
boolean	isAccentless()
boolean	isOrthNormal()
boolean	isRegex()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightState

public HighlightState(java.lang.String text,
                      boolean orthNorm,
                      boolean accentless,
                      boolean regex,
                      java.lang.String searchLang)

Constructor.

Parameters:

text - string to highlight

orthNorm - true if search is with orthographic normalization

accentless - true if diacritics are ignored in search

regex - true if string is regular expression

searchLang - language for search

Method Detail

getText

public java.lang.String getText()

isOrthNormal

public boolean isOrthNormal()

isAccentless

public boolean isAccentless()

isRegex

public boolean isRegex()

getSearchLang

public java.lang.String getSearchLang()

getWordTokenTable

public WordTokenTable getWordTokenTable()

The returned WordTokenTable is mutable.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object