Class MultiLineStringUtil
- java.lang.Object
-
- com.inductiveautomation.ignition.common.util.gui.MultiLineStringUtil
-
public class MultiLineStringUtil extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description MultiLineStringUtil()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.lang.String[]
toMultiLineByChar(java.lang.String s, int max)
Helper function to format string by characters.static java.lang.String[]
toMultiLineByWord(java.lang.String s, int max)
Helper function to format string by words.static java.lang.String[]
toMultiLineStringFormat(java.lang.String s)
Convert a string to a multi line tooltip string using the default max character per line and max lines.static java.lang.String[]
toMultiLineStringFormat(java.lang.String s, boolean formatByWord)
Convert a string to a multi line tooltip string using the default max character per line and max lines.static java.lang.String[]
toMultiLineStringFormat(java.lang.String s, int max, int maxLines, boolean formatByWord)
Convert a string to a multi line tooltip string given a max character per line
-
-
-
Method Detail
-
toMultiLineStringFormat
public static java.lang.String[] toMultiLineStringFormat(java.lang.String s)
Convert a string to a multi line tooltip string using the default max character per line and max lines. By default it will format by word.- Parameters:
s
- String to be formatted- Returns:
- String array to be displayed
-
toMultiLineStringFormat
public static java.lang.String[] toMultiLineStringFormat(java.lang.String s, boolean formatByWord)
Convert a string to a multi line tooltip string using the default max character per line and max lines.- Parameters:
s
- String to be formattedformatByWord
- formatted by word by default, set to false to format by character- Returns:
- String array to be displayed
-
toMultiLineStringFormat
public static java.lang.String[] toMultiLineStringFormat(java.lang.String s, int max, int maxLines, boolean formatByWord)
Convert a string to a multi line tooltip string given a max character per line- Parameters:
s
- String to be formattedmax
- Max characters per line. Spaces COUNT towards the max.maxLines
- Max number of lines. Use -1 (or any number less than 0) for indefinite number of lines.formatByWord
- boolean to determine whether to format by word or by character- Returns:
- String array to be displayed
-
toMultiLineByWord
public static java.lang.String[] toMultiLineByWord(java.lang.String s, int max)
Helper function to format string by words. DOES NOT take into account new lines.- Parameters:
s
- String to be formattedmax
- Max characters per line. Spaces COUNT towards the max.- Returns:
- String array formatted by word
-
toMultiLineByChar
public static java.lang.String[] toMultiLineByChar(java.lang.String s, int max)
Helper function to format string by characters. DOES NOT take into account new lines.- Parameters:
s
- String to be formattedmax
- Max characters per line. Spaces COUNT towards the max.- Returns:
- String array formatted by characters
-
-