Class ContextTools


  • public class ContextTools
    extends Object
    Helper class to mark errors in text.
    • 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
      • 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.