Package org.fife.ui.rsyntaxtextarea

## Class RSyntaxUtilities

- java.lang.Object
- - org.fife.ui.rsyntaxtextarea.RSyntaxUtilities

- All Implemented Interfaces:
    `SwingConstants`

      public class RSyntaxUtilities
      extends Object
      implements SwingConstants

  Utility methods used by `RSyntaxTextArea` and its associated classes.

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static int` | `OS_LINUX` | Integer constant representing Linux.
    `static int` | `OS_MAC_OSX` | Integer constant representing Mac OS X.
    `static int` | `OS_OTHER` | Integer constant representing an "unknown" OS.
    `static int` | `OS_WINDOWS` | Integer constant representing a Windows-variant OS.

    - ### Fields inherited from interface javax.swing.SwingConstants

      `BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `RSyntaxUtilities()` |

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static String` | `escapeForHtml​(String s, String newlineReplacement, boolean inPreBlock)` | Returns a string with characters that are special to HTML (such as `<`, `>` and `&`) replaced by their HTML escape sequences.
    `static Map<?,​?>` | `getDesktopAntiAliasHints()` | Returns the rendering hints for text that will most accurately reflect those of the native windowing system.
    `static Color` | `getFoldedLineBottomColor​(RSyntaxTextArea textArea)` | Returns the color to use for the line underneath a folded region line.
    `static Gutter` | `getGutter​(RTextArea textArea)` | Returns the gutter component of the scroll pane containing a text area, if any.
    `static Color` | `getHyperlinkForeground()` | Returns the color to use for hyperlink-style components.
    `static String` | `getLeadingWhitespace​(String text)` | Returns the leading whitespace of a string.
    `static String` | `getLeadingWhitespace​(Document doc, int offs)` | Returns the leading whitespace of a specific line in a document.
    `static Rectangle` | `getLineWidthUpTo​(RSyntaxTextArea textArea, Segment s, int p0, int p1, TabExpander e, Rectangle rect, int x0)` | Returns the bounding box (in the current view) of a specified position in the model.
    `static Point` | `getMatchingBracketPosition​(RSyntaxTextArea textArea, Point input)` | Returns the location of the bracket paired with the one at the current caret position.
    `static Token` | `getNextImportantToken​(Token t, RSyntaxTextArea textArea, int line)` | Returns the next non-whitespace, non-comment token in a text area.
    `static int` | `getNextVisualPositionFrom​(int pos, Position.Bias b, Shape a, int direction, Position.Bias[] biasRet, View view)` | Provides a way to determine the next visually represented model location at which one might place a caret.
    `static int` | `getOS()` | Returns an integer constant representing the OS.
    `static int` | `getPatternFlags​(boolean matchCase, int others)` | Returns the flags necessary to create a `Pattern`.
    `static int` | `getPositionAbove​(RSyntaxTextArea c, int offs, float x, TabExpander e)` | Determines the position in the model that is closest to the given view location in the row above.
    `static int` | `getPositionBelow​(RSyntaxTextArea c, int offs, float x, TabExpander e)` | Determines the position in the model that is closest to the given view location in the row below.
    `static Token` | `getPreviousImportantToken​(RSyntaxDocument doc, int line)` | Returns the last non-whitespace, non-comment token, starting with the specified line.
    `static Token` | `getPreviousImportantTokenFromOffs​(RSyntaxDocument doc, int offs)` | Returns the last non-whitespace, non-comment token, before the specified offset.
    `static Token` | `getTokenAtOffset​(RSyntaxDocument doc, int offset)` | Returns the token at the specified offset.
    `static Token` | `getTokenAtOffset​(RSyntaxTextArea textArea, int offset)` | Returns the token at the specified offset.
    `static Token` | `getTokenAtOffset​(Token tokenList, int offset)` | Returns the token at the specified index, or `null` if the given offset isn't in this token list's range. Note that this method does NOT check to see if `tokenList` is null; callers should check for themselves.
    `static float` | `getTokenListWidth​(Token tokenList, RSyntaxTextArea textArea, TabExpander e)` | Determines the width of the given token list taking tabs into consideration.
    `static float` | `getTokenListWidth​(Token tokenList, RSyntaxTextArea textArea, TabExpander e, float x0)` | Determines the width of the given token list taking tabs into consideration.
    `static float` | `getTokenListWidthUpTo​(Token tokenList, RSyntaxTextArea textArea, TabExpander e, float x0, int upTo)` | Determines the width of the given token list taking tabs into consideration and only up to the given index in the document (exclusive).
    `static int` | `getWordEnd​(RSyntaxTextArea textArea, int offs)` | Returns the end of the word at the given offset.
    `static int` | `getWordStart​(RSyntaxTextArea textArea, int offs)` | Returns the start of the word at the given offset.
    `static boolean` | `isBracket​(char ch)` | Returns whether or not this character is a "bracket" to be matched by such programming languages as C, C++, and Java.
    `static boolean` | `isDigit​(char ch)` | Returns whether or not a character is a digit (0-9).
    `static boolean` | `isHexCharacter​(char ch)` | Returns whether or not this character is a hex character.
    `static boolean` | `isJavaOperator​(char ch)` | Returns whether a character is a Java operator.
    `static boolean` | `isLetter​(char ch)` | Returns whether a character is a US-ASCII letter (A-Z or a-z).
    `static boolean` | `isLetterOrDigit​(char ch)` | Returns whether or not a character is a US-ASCII letter or a digit.
    `static boolean` | `isLightForeground​(Color fg)` | Returns whether the specified color is "light" to use as a foreground.
    `static boolean` | `isNonWordChar​(Token t)` | Returns whether the specified token is a single non-word char (e.g.
    `static boolean` | `isWhitespace​(char ch)` | Returns whether or not a character is a whitespace character (either a space ' ' or tab '\t').
    `static boolean` | `regexCanFollowInJavaScript​(Token t)` | Returns whether a regular expression token can follow the specified token in JavaScript.
    `static void` | `selectAndPossiblyCenter​(JTextArea textArea, DocumentRange range, boolean select)` | Selects a range of text in a text component.
    `static char` | `toLowerCase​(char ch)` | If the character is an upper-case US-ASCII letter, it returns the lower-case version of that letter; otherwise, it just returns the character.
    `static Pattern` | `wildcardToPattern​(String wildcard, boolean matchCase, boolean escapeStartChar)` | Creates a regular expression pattern that matches a "wildcard" pattern.

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

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

- - ### Field Detail

    - #### OS_WINDOWS

          public static final int OS_WINDOWS

      Integer constant representing a Windows-variant OS.
      See Also:
        Constant Field Values

    - #### OS_MAC_OSX

          public static final int OS_MAC_OSX

      Integer constant representing Mac OS X.
      See Also:
        Constant Field Values

    - #### OS_LINUX

          public static final int OS_LINUX

      Integer constant representing Linux.
      See Also:
        Constant Field Values

    - #### OS_OTHER

          public static final int OS_OTHER

      Integer constant representing an "unknown" OS. 99.99% of the time, this means some UNIX variant (AIX, SunOS, etc.).
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### RSyntaxUtilities

          public RSyntaxUtilities()

  - ### Method Detail

    - #### escapeForHtml

          public static final String escapeForHtml​(String s,
                                                   String newlineReplacement,
                                                   boolean inPreBlock)

      Returns a string with characters that are special to HTML (such as `<`, `>` and `&`) replaced by their HTML escape sequences.
      Parameters:
        `s` - The input string.
        `newlineReplacement` - What to replace newline characters with. If this is `null`, they are simply removed.
        `inPreBlock` - Whether this HTML will be in within `pre` tags. If this is `true`, spaces will be kept as-is; otherwise, they will be converted to "`` ".
      Returns:
        The escaped version of `s`.

    - #### getDesktopAntiAliasHints

          public static Map<?,​?> getDesktopAntiAliasHints()

      Returns the rendering hints for text that will most accurately reflect those of the native windowing system.
      Returns:
        The rendering hints, or `null` if they cannot be determined.

    - #### getFoldedLineBottomColor

          public static Color getFoldedLineBottomColor​(RSyntaxTextArea textArea)

      Returns the color to use for the line underneath a folded region line.
      Parameters:
        `textArea` - The text area.
      Returns:
        The color to use.

    - #### getGutter

          public static Gutter getGutter​(RTextArea textArea)

      Returns the gutter component of the scroll pane containing a text area, if any.
      Parameters:
        `textArea` - The text area.
      Returns:
        The gutter, or `null` if the text area is not in an `RTextScrollPane`.
      See Also:
        `RTextScrollPane.getGutter()`

    - #### getHyperlinkForeground

          public static final Color getHyperlinkForeground()

      Returns the color to use for hyperlink-style components. This method will return `Color.blue` unless it appears that the current LookAndFeel uses light text on a dark background, in which case a brighter alternative is returned.
      Returns:
        The color to use for hyperlinks.
      See Also:
        `isLightForeground(Color)`

    - #### getLeadingWhitespace

          public static String getLeadingWhitespace​(String text)

      Returns the leading whitespace of a string.
      Parameters:
        `text` - The String to check.
      Returns:
        The leading whitespace.
      See Also:
        `getLeadingWhitespace(Document, int)`

    - #### getLeadingWhitespace

          public static String getLeadingWhitespace​(Document doc,
                                                    int offs)
                                             throws BadLocationException

      Returns the leading whitespace of a specific line in a document.
      Parameters:
        `doc` - The document.
        `offs` - The offset whose line to get the leading whitespace for.
      Returns:
        The leading whitespace.
      Throws:
        `BadLocationException` - If `offs` is not a valid offset in the document.
      See Also:
        `getLeadingWhitespace(String)`

    - #### getLineWidthUpTo

          public static Rectangle getLineWidthUpTo​(RSyntaxTextArea textArea,
                                                   Segment s,
                                                   int p0,
                                                   int p1,
                                                   TabExpander e,
                                                   Rectangle rect,
                                                   int x0)
                                            throws BadLocationException

      Returns the bounding box (in the current view) of a specified position in the model. This method is designed for line-wrapped views to use, as it allows you to specify a "starting position" in the line, from which the x-value is assumed to be zero. The idea is that you specify the first character in a physical line as `p0`, as this is the character where the x-pixel value is 0.
      Parameters:
        `textArea` - The text area containing the text.
        `s` - A segment in which to load the line. This is passed in so we don't have to reallocate a new `Segment` for each call.
        `p0` - The starting position in the physical line in the document.
        `p1` - The position for which to get the bounding box in the view.
        `e` - How to expand tabs.
        `rect` - The rectangle whose x- and width-values are changed to represent the bounding box of `p1`. This is reused to keep from needlessly reallocating Rectangles.
        `x0` - The x-coordinate (pixel) marking the left-hand border of the text. This is useful if the text area has a border, for example.
      Returns:
        The bounding box in the view of the character `p1`.
      Throws:
        `BadLocationException` - If `p0` or `p1` is not a valid location in the specified text area's document.
        `IllegalArgumentException` - If `p0` and `p1` are not on the same line.

    - #### getMatchingBracketPosition

          public static Point getMatchingBracketPosition​(RSyntaxTextArea textArea,
                                                         Point input)

      Returns the location of the bracket paired with the one at the current caret position.
      Parameters:
        `textArea` - The text area.
        `input` - A point to use as the return value. If this is `null`, a new object is created and returned.
      Returns:
        A point representing the matched bracket info. The "x" field is the offset of the bracket at the caret position (either just before or just after the caret), and the "y" field is the offset of the matched bracket. Both "x" and "y" will be `-1` if there isn't a matching bracket (or the caret isn't on a bracket).

    - #### getNextImportantToken

          public static final Token getNextImportantToken​(Token t,
                                                          RSyntaxTextArea textArea,
                                                          int line)

      Returns the next non-whitespace, non-comment token in a text area.
      Parameters:
        `t` - The next token in this line's token list.
        `textArea` - The text area.
        `line` - The current line index (the line index of `t`).
      Returns:
        The next non-whitespace, non-comment token, or `null` if there isn't one.
      See Also:
        `getPreviousImportantToken(RSyntaxDocument, int)`, `getPreviousImportantTokenFromOffs(RSyntaxDocument, int)`

    - #### getNextVisualPositionFrom

          public static int getNextVisualPositionFrom​(int pos,
                                                      Position.Bias b,
                                                      Shape a,
                                                      int direction,
                                                      Position.Bias[] biasRet,
                                                      View view)
                                               throws BadLocationException

      Provides a way to determine the next visually represented model location at which one might place a caret. Some views may not be visible, they might not be in the same order found in the model, or they just might not allow access to some of the locations in the model.

      NOTE: You should only call this method if the passed-in `javax.swing.text.View` is an instance of `TokenOrientedView` and `javax.swing.text.TabExpander`; otherwise, a `ClassCastException` could be thrown.

      Parameters:
        `pos` - the position to convert >= 0
        `a` - the allocated region in which to render
        `direction` - the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This will be one of the following values:
        - SwingConstants.WEST
        - SwingConstants.EAST
        - SwingConstants.NORTH
        - SwingConstants.SOUTH
      Returns:
        the location within the model that best represents the next location visual position
      Throws:
        `BadLocationException`
        `IllegalArgumentException` - if `direction` doesn't have one of the legal values above

    - #### getOS

          public static final int getOS()

      Returns an integer constant representing the OS. This can be handy for special case situations such as Mac OS-X (special application registration) or Windows (allow mixed case, etc.).
      Returns:
        An integer constant representing the OS.

    - #### getPatternFlags

          public static final int getPatternFlags​(boolean matchCase,
                                                  int others)

      Returns the flags necessary to create a `Pattern`.
      Parameters:
        `matchCase` - Whether the pattern should be case sensitive.
        `others` - Any other flags. This may be `0`.
      Returns:
        The flags.

    - #### getPositionAbove

          public static final int getPositionAbove​(RSyntaxTextArea c,
                                                   int offs,
                                                   float x,
                                                   TabExpander e)
                                            throws BadLocationException

      Determines the position in the model that is closest to the given view location in the row above. The component given must have a size to compute the result. If the component doesn't have a size a value of -1 will be returned.
      Parameters:
        `c` - the editor
        `offs` - the offset in the document >= 0
        `x` - the X coordinate >= 0
      Returns:
        the position >= 0 if the request can be computed, otherwise a value of -1 will be returned.
      Throws:
        `BadLocationException` - if the offset is out of range

    - #### getPositionBelow

          public static final int getPositionBelow​(RSyntaxTextArea c,
                                                   int offs,
                                                   float x,
                                                   TabExpander e)
                                            throws BadLocationException

      Determines the position in the model that is closest to the given view location in the row below. The component given must have a size to compute the result. If the component doesn't have a size a value of -1 will be returned.
      Parameters:
        `c` - the editor
        `offs` - the offset in the document >= 0
        `x` - the X coordinate >= 0
      Returns:
        the position >= 0 if the request can be computed, otherwise a value of -1 will be returned.
      Throws:
        `BadLocationException` - if the offset is out of range

    - #### getPreviousImportantToken

          public static final Token getPreviousImportantToken​(RSyntaxDocument doc,
                                                              int line)

      Returns the last non-whitespace, non-comment token, starting with the specified line.
      Parameters:
        `doc` - The document.
        `line` - The line at which to start looking.
      Returns:
        The last non-whitespace, non-comment token, or `null` if there isn't one.
      See Also:
        `getNextImportantToken(Token, RSyntaxTextArea, int)`, `getPreviousImportantTokenFromOffs(RSyntaxDocument, int)`

    - #### getPreviousImportantTokenFromOffs

          public static final Token getPreviousImportantTokenFromOffs​(RSyntaxDocument doc,
                                                                      int offs)

      Returns the last non-whitespace, non-comment token, before the specified offset.
      Parameters:
        `doc` - The document.
        `offs` - The ending offset for the search.
      Returns:
        The last non-whitespace, non-comment token, or `null` if there isn't one.
      See Also:
        `getPreviousImportantToken(RSyntaxDocument, int)`, `getNextImportantToken(Token, RSyntaxTextArea, int)`

    - #### getTokenAtOffset

          public static final Token getTokenAtOffset​(RSyntaxTextArea textArea,
                                                     int offset)

      Returns the token at the specified offset.
      Parameters:
        `textArea` - The text area.
        `offset` - The offset of the token.
      Returns:
        The token, or `null` if the offset is not valid.
      See Also:
        `getTokenAtOffset(RSyntaxDocument, int)`, `getTokenAtOffset(Token, int)`

    - #### getTokenAtOffset

          public static final Token getTokenAtOffset​(RSyntaxDocument doc,
                                                     int offset)

      Returns the token at the specified offset.
      Parameters:
        `doc` - The document.
        `offset` - The offset of the token.
      Returns:
        The token, or `null` if the offset is not valid.
      See Also:
        `getTokenAtOffset(RSyntaxTextArea, int)`, `getTokenAtOffset(Token, int)`

    - #### getTokenAtOffset

          public static final Token getTokenAtOffset​(Token tokenList,
                                                     int offset)

      Returns the token at the specified index, or `null` if the given offset isn't in this token list's range.
      Note that this method does NOT check to see if `tokenList` is null; callers should check for themselves.
      Parameters:
        `tokenList` - The list of tokens in which to search.
        `offset` - The offset at which to get the token.
      Returns:
        The token at `offset`, or `null` if none of the tokens are at that offset.
      See Also:
        `getTokenAtOffset(RSyntaxTextArea, int)`, `getTokenAtOffset(RSyntaxDocument, int)`

    - #### getWordEnd

          public static int getWordEnd​(RSyntaxTextArea textArea,
                                       int offs)
                                throws BadLocationException

      Returns the end of the word at the given offset.
      Parameters:
        `textArea` - The text area.
        `offs` - The offset into the text area's content.
      Returns:
        The end offset of the word.
      Throws:
        `BadLocationException` - If `offs` is invalid.
      See Also:
        `getWordStart(RSyntaxTextArea, int)`

    - #### getWordStart

          public static int getWordStart​(RSyntaxTextArea textArea,
                                         int offs)
                                  throws BadLocationException

      Returns the start of the word at the given offset.
      Parameters:
        `textArea` - The text area.
        `offs` - The offset into the text area's content.
      Returns:
        The start offset of the word.
      Throws:
        `BadLocationException` - If `offs` is invalid.
      See Also:
        `getWordEnd(RSyntaxTextArea, int)`

    - #### getTokenListWidth

          public static final float getTokenListWidth​(Token tokenList,
                                                      RSyntaxTextArea textArea,
                                                      TabExpander e)

      Determines the width of the given token list taking tabs into consideration. This is implemented in a 1.1 style coordinate system where ints are used and 72dpi is assumed.

      This method also assumes that the passed-in token list begins at x-pixel `0` in the view (for tab purposes).

      Parameters:
        `tokenList` - The tokenList list representing the text.
        `textArea` - The text area in which this token list resides.
        `e` - The tab expander. This value cannot be `null`.
      Returns:
        The width of the token list, in pixels.

    - #### getTokenListWidth

          public static final float getTokenListWidth​(Token tokenList,
                                                      RSyntaxTextArea textArea,
                                                      TabExpander e,
                                                      float x0)

      Determines the width of the given token list taking tabs into consideration. This is implemented in a 1.1 style coordinate system where ints are used and 72dpi is assumed.

      Parameters:
        `tokenList` - The token list list representing the text.
        `textArea` - The text area in which this token list resides.
        `e` - The tab expander. This value cannot be `null`.
        `x0` - The x-pixel coordinate of the start of the token list.
      Returns:
        The width of the token list, in pixels.
      See Also:
        `getTokenListWidthUpTo(org.fife.ui.rsyntaxtextarea.Token, org.fife.ui.rsyntaxtextarea.RSyntaxTextArea, javax.swing.text.TabExpander, float, int)`

    - #### getTokenListWidthUpTo

          public static final float getTokenListWidthUpTo​(Token tokenList,
                                                          RSyntaxTextArea textArea,
                                                          TabExpander e,
                                                          float x0,
                                                          int upTo)

      Determines the width of the given token list taking tabs into consideration and only up to the given index in the document (exclusive).
      Parameters:
        `tokenList` - The token list representing the text.
        `textArea` - The text area in which this token list resides.
        `e` - The tab expander. This value cannot be `null`.
        `x0` - The x-pixel coordinate of the start of the token list.
        `upTo` - The document position at which you want to stop, exclusive. If this position is before the starting position of the token list, a width of `0` will be returned; similarly, if this position comes after the entire token list, the width of the entire token list is returned.
      Returns:
        The width of the token list, in pixels, up to, but not including, the character at position `upTo`.
      See Also:
        `getTokenListWidth(org.fife.ui.rsyntaxtextarea.Token, org.fife.ui.rsyntaxtextarea.RSyntaxTextArea, javax.swing.text.TabExpander)`

    - #### isBracket

          public static final boolean isBracket​(char ch)

      Returns whether or not this character is a "bracket" to be matched by such programming languages as C, C++, and Java.
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a "bracket" - one of '(', ')', '[', ']', '{', and '}'.

    - #### isDigit

          public static final boolean isDigit​(char ch)

      Returns whether or not a character is a digit (0-9).
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a digit.

    - #### isHexCharacter

          public static final boolean isHexCharacter​(char ch)

      Returns whether or not this character is a hex character. This method accepts both upper- and lower-case letters a-f.
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a hex character 0-9, a-f, or A-F.

    - #### isJavaOperator

          public static final boolean isJavaOperator​(char ch)

      Returns whether a character is a Java operator. Note that C and C++ operators are the same as Java operators.
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a Java operator.

    - #### isLetter

          public static final boolean isLetter​(char ch)

      Returns whether a character is a US-ASCII letter (A-Z or a-z).
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a US-ASCII letter.

    - #### isLetterOrDigit

          public static final boolean isLetterOrDigit​(char ch)

      Returns whether or not a character is a US-ASCII letter or a digit.
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a US-ASCII letter or a digit.

    - #### isLightForeground

          public static final boolean isLightForeground​(Color fg)

      Returns whether the specified color is "light" to use as a foreground. Colors that return `true` indicate that the current Look and Feel probably uses light text colors on a dark background.
      Parameters:
        `fg` - The foreground color.
      Returns:
        Whether it is a "light" foreground color.
      See Also:
        `getHyperlinkForeground()`

    - #### isNonWordChar

          public static final boolean isNonWordChar​(Token t)

      Returns whether the specified token is a single non-word char (e.g. not in `[A-Za-z]`. This is a HACK to work around the fact that many standard token makers return things like semicolons and periods as `TokenTypes.IDENTIFIER`s just to make the syntax highlighting coloring look a little better.
      Parameters:
        `t` - The token to check. This cannot be `null`.
      Returns:
        Whether the token is a single non-word char.

    - #### isWhitespace

          public static final boolean isWhitespace​(char ch)

      Returns whether or not a character is a whitespace character (either a space ' ' or tab '\t'). This checks for the Unicode character values 0x0020 and 0x0009.
      Parameters:
        `ch` - The character to check.
      Returns:
        Whether or not the character is a whitespace character.

    - #### regexCanFollowInJavaScript

          public static boolean regexCanFollowInJavaScript​(Token t)

      Returns whether a regular expression token can follow the specified token in JavaScript.
      Parameters:
        `t` - The token to check, which may be `null`.
      Returns:
        Whether a regular expression token may follow this one in JavaScript.

    - #### selectAndPossiblyCenter

          public static final void selectAndPossiblyCenter​(JTextArea textArea,
                                                           DocumentRange range,
                                                           boolean select)

      Selects a range of text in a text component. If the new selection is outside of the previous viewable rectangle, then the view is centered around the new selection.
      Parameters:
        `textArea` - The text component whose selection is to be centered.
        `range` - The range to select.

    - #### toLowerCase

          public static final char toLowerCase​(char ch)

      If the character is an upper-case US-ASCII letter, it returns the lower-case version of that letter; otherwise, it just returns the character.
      Parameters:
        `ch` - The character to lower-case (if it is a US-ASCII upper-case character).
      Returns:
        The lower-case version of the character.

    - #### wildcardToPattern

          public static Pattern wildcardToPattern​(String wildcard,
                                                  boolean matchCase,
                                                  boolean escapeStartChar)

      Creates a regular expression pattern that matches a "wildcard" pattern.
      Parameters:
        `wildcard` - The wildcard pattern.
        `matchCase` - Whether the pattern should be case sensitive.
        `escapeStartChar` - Whether to escape a starting `'^'` character.
      Returns:
        The pattern.