org.languagetool.tools

Class ContextTools

java.lang.Object

org.languagetool.tools.ContextTools

public class ContextTools
extends Object

Helper class to mark errors in text.

Constructor Summary

Constructors

Constructor and Description
ContextTools()

Method Summary

Modifier and Type	Method and Description
String	getContext(int fromPos, int toPos, String contents)
String	getPlainTextContext(int fromPos, int toPos, String contents) Get a plain text context that uses ^ characters in a new line as a marker of the given string region.
void	setContextSize(int contextSize) The context size of the error.
void	setErrorMarker(String start, String end) Set the string used to mark the beginning and end of an error, e.g.
void	setErrorMarkerEnd(String errorMarkerEnd) Set the string used to mark the end of an error, e.g.
void	setErrorMarkerStart(String errorMarkerStart) Set the string used to mark the beginning of an error, e.g.
void	setEscapeHtml(boolean escapeHtml) Whether HTML special characters should be escaped.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextTools

public ContextTools()

Method Detail

getContext

public String getContext(int fromPos,
                         int toPos,
                         String contents)

getPlainTextContext

public String getPlainTextContext(int fromPos,
                                  int toPos,
                                  String contents)

Get a plain text context that uses ^ characters in a new line as a marker of the given string region. Ignores setEscapeHtml(boolean).

Since:

2.3

setErrorMarker

public void setErrorMarker(String start,
                           String end)

Set the string used to mark the beginning and end of an error, e.g. <span class="error"> and </span>

Since:

5.1

setErrorMarkerStart

public void setErrorMarkerStart(String errorMarkerStart)

Set the string used to mark the beginning of an error, e.g. <span class="error">

setErrorMarkerEnd

public void setErrorMarkerEnd(String errorMarkerEnd)

Set the string used to mark the end of an error, e.g. </span>

setContextSize

public void setContextSize(int contextSize)

The context size of the error. This many characters of the original text will be used from the left and from the right context of the error.

setEscapeHtml

public void setEscapeHtml(boolean escapeHtml)

Whether HTML special characters should be escaped.