Uses of Class
picocli.CommandLine.Help.Ansi.Text

Uses of CommandLine.Help.Ansi.Text in picocli

Fields in picocli declared as CommandLine.Help.Ansi.Text

Modifier and Type	Field	Description
(package private) static CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.EMPTY_TEXT

Fields in picocli with type parameters of type CommandLine.Help.Ansi.Text

Modifier and Type	Field	Description
protected final List<CommandLine.Help.Ansi.Text>	CommandLine.Help.TextTable.columnValues	The char[] slots of the TextTable to copy text values into.

Methods in picocli that return CommandLine.Help.Ansi.Text

Modifier and Type	Method	Description
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.append(String string)	Deprecated. use concat(String) instead
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.append(CommandLine.Help.Ansi.Text text)	Deprecated. use concat(CommandLine.Help.Ansi.Text) instead
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.apply(String plainText, List<CommandLine.Help.Ansi.IStyle> styles)	Deprecated. use CommandLine.Help.ColorScheme.apply(String, List) instead
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.apply(String plainText, List<CommandLine.Help.Ansi.IStyle> styles)	Returns a new Text object where all the specified styles are applied to the full length of the specified plain text.
CommandLine.Help.Ansi.Text	CommandLine.Help.TextTable.cellAt(int row, int col)	Deprecated. use CommandLine.Help.TextTable.textAt(int, int) instead
CommandLine.Help.Ansi.Text	CommandLine.Help.commandNamesText(String separator)	Returns a Text object containing the command name and all aliases, separated with the specified separator.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.commandText(String command)	Returns a Text with all command styles applied to the specified command string.
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.concat(String string)	Returns a copy of this Text instance with the specified text concatenated to the end.
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.concat(CommandLine.Help.Ansi.Text other)	Returns a copy of this Text instance with the specified text concatenated to the end.
(package private) static CommandLine.Help.Ansi.Text	CommandLine.Help.concatOptionText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer)
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.concatOptionText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.OptionSpec option)
(package private) static CommandLine.Help.Ansi.Text	CommandLine.Help.concatPositionalText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer)
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.concatPositionalText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam)
private static CommandLine.Help.Ansi.Text[]	CommandLine.Help.createDescriptionFirstLines(CommandLine.Help.ColorScheme scheme, CommandLine.Model.ArgSpec arg, String[] description, boolean[] showDefault)
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisCommandText()	Returns a Text object containing a partial detailed synopsis showing only the subcommands, starting with a " " space.
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisEndOfOptionsText()	Returns a Text object containing a partial detailed synopsis showing only the end of options delimiter (if enabled), starting with a " " space.
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisGroupsText(Set<CommandLine.Model.ArgSpec> outparam_groupArgs)	Returns a Text object containing a partial detailed synopsis showing only the options and positional parameters in the specified validating groups, starting with a " " space.
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec> done, Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions)	Returns a Text object containing a partial detailed synopsis showing only the options, starting with a " " space.
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisOptionsText(Collection<CommandLine.Model.ArgSpec> done, List<CommandLine.Model.OptionSpec> optionList, Comparator<CommandLine.Model.OptionSpec> optionSort, boolean clusterBooleanOptions)	Returns a Text object containing a partial detailed synopsis showing only the specified options, starting with a " " space.
protected CommandLine.Help.Ansi.Text	CommandLine.Help.createDetailedSynopsisPositionalsText(Collection<CommandLine.Model.ArgSpec> done)	Returns a Text object containing a partial detailed synopsis showing only the positional parameters, starting with a " " space.
private CommandLine.Help.Ansi.Text	CommandLine.Help.DefaultOptionRenderer.createLongOptionText(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer renderer, CommandLine.Help.ColorScheme scheme, String longOption)
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.errorText(String error)	Returns a Text with all error styles applied to the specified error string.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.optionParamText(String optionParam)	Returns a Text with all optionParam styles applied to the specified optionParam string.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.optionText(String option)	Returns a Text with all option styles applied to the specified option string.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.parameterText(String parameter)	Returns a Text with all parameter styles applied to the specified parameter string.
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.rawSynopsisUnitText(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs)
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.DefaultOptionRenderer.render(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.DefaultParameterRenderer.render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer paramLabelRenderer, CommandLine.Help.ColorScheme scheme)
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.IOptionRenderer.render(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)	Returns a text representation of the specified option and its parameter(s) if any.
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.IParameterRenderer.render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)	Returns a text representation of the specified positional parameter.
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.MinimalOptionRenderer.render(CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
CommandLine.Help.Ansi.Text[][]	CommandLine.Help.MinimalParameterRenderer.render(CommandLine.Model.PositionalParamSpec param, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
private CommandLine.Help.Ansi.Text[][]	CommandLine.Help.DefaultOptionRenderer.renderDescriptionLines(CommandLine.Model.OptionSpec option, CommandLine.Help.ColorScheme scheme, String requiredOption, String shortOption, CommandLine.Help.Ansi.Text longOptionText)
CommandLine.Help.Ansi.Text	CommandLine.Help.DefaultParamLabelRenderer.renderParameterLabel(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi ansi, List<CommandLine.Help.Ansi.IStyle> styles)
CommandLine.Help.Ansi.Text	CommandLine.Help.IParamLabelRenderer.renderParameterLabel(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi ansi, List<CommandLine.Help.Ansi.IStyle> styles)	Returns a text rendering of the option parameter or positional parameter; returns an empty string "" if the option is a boolean and does not take a parameter.
CommandLine.Help.Ansi.Text[]	CommandLine.Help.Ansi.Text.splitLines()
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.stackTraceText(String stackTrace)	Returns a Text with all stackTrace styles applied to all lines in the specified stackTrace string.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.stackTraceText(Throwable t)	Returns a Text with all stackTrace styles applied to all lines in the stack trace of the specified Throwable.
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.substring(int start)	Returns a new Text instance that is a substring of this Text.
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.substring(int start, int end)	Returns a new Text instance that is a substring of this Text.
CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.synopsisText(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs)	Returns the synopsis of this group.
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.synopsisUnitText(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.Ansi.Text synopsis)
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.text(String stringWithMarkup)	Returns a new Text object for this Ansi mode, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
CommandLine.Help.Ansi.Text	CommandLine.Help.ColorScheme.text(String stringWithMarkup)	Returns a new Text object for this ColorScheme, encapsulating the specified string which may contain markup like @|bg(red),white,underline some text|@.
CommandLine.Help.Ansi.Text	CommandLine.Help.TextTable.textAt(int row, int col)	Returns the Text slot at the specified row and column to write a text value into.

Methods in picocli with parameters of type CommandLine.Help.Ansi.Text

Modifier and Type	Method	Description
void	CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text... values)	Adds a new empty row, then calls putValue for each of the specified values, adding more empty rows if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.append(CommandLine.Help.Ansi.Text text)	Deprecated. use concat(CommandLine.Help.Ansi.Text) instead
CommandLine.Help.Ansi.Text	CommandLine.Help.Ansi.Text.concat(CommandLine.Help.Ansi.Text other)	Returns a copy of this Text instance with the specified text concatenated to the end.
(package private) static CommandLine.Help.Ansi.Text	CommandLine.Help.concatOptionText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.OptionSpec option, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer)
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.concatOptionText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.OptionSpec option)
(package private) static CommandLine.Help.Ansi.Text	CommandLine.Help.concatPositionalText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer)
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.concatPositionalText(String prefix, CommandLine.Help.Ansi.Text text, CommandLine.Help.ColorScheme colorScheme, CommandLine.Model.PositionalParamSpec positionalParam)
private int	CommandLine.Help.TextTable.copy(BreakIterator line, CommandLine.Help.Ansi.Text text, CommandLine.Help.Ansi.Text columnValue, int offset)
private int	CommandLine.Help.TextTable.copy(CommandLine.Help.Ansi.Text value, CommandLine.Help.Ansi.Text destination, int offset)
private void	CommandLine.Help.TextTable.copy(CommandLine.Help.Ansi.Text value, CommandLine.Help.Ansi.Text destination, int offset, CommandLine.Help.TextTable.Count count)
void	CommandLine.Help.Ansi.Text.getStyledChars(int from, int length, CommandLine.Help.Ansi.Text destination, int offset)	Copies the specified substring of this Text into the specified destination, preserving the markup.
protected String	CommandLine.Help.insertSynopsisCommandName(int synopsisHeadingLength, CommandLine.Help.Ansi.Text optionsAndPositionalsAndCommandsDetails)	Returns the detailed synopsis text by inserting the command name before the specified text with options and positional parameters details.
void	CommandLine.Help.Layout.layout(CommandLine.Model.ArgSpec argSpec, CommandLine.Help.Ansi.Text[][] cellValues)	Copies the specified text values into the correct cells in the CommandLine.Help.TextTable.
private int	CommandLine.Help.TextTable.length(CommandLine.Help.Ansi.Text str)
private int	CommandLine.Help.TextTable.length(CommandLine.Help.Ansi.Text str, int from, int length)
protected String	CommandLine.Help.makeSynopsisFromParts(int synopsisHeadingLength, CommandLine.Help.Ansi.Text optionText, CommandLine.Help.Ansi.Text groupsText, CommandLine.Help.Ansi.Text endOfOptionsText, CommandLine.Help.Ansi.Text positionalParamText, CommandLine.Help.Ansi.Text commandText)	Concatenates the command name and the specified synopsis parts and returns a fully rendered synopsis String.
CommandLine.Help.TextTable.Cell	CommandLine.Help.TextTable.putValue(int row, int col, CommandLine.Help.Ansi.Text value)	Writes the specified value into the cell at the specified row and column and returns the last row and column written to.
private CommandLine.Help.Ansi.Text[][]	CommandLine.Help.DefaultOptionRenderer.renderDescriptionLines(CommandLine.Model.OptionSpec option, CommandLine.Help.ColorScheme scheme, String requiredOption, String shortOption, CommandLine.Help.Ansi.Text longOptionText)
private CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.synopsisUnitText(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.Ansi.Text synopsis)
private int	CommandLine.Help.TextTable.unindent(CommandLine.Help.Ansi.Text[] values)

Constructors in picocli with parameters of type CommandLine.Help.Ansi.Text

Modifier	Constructor	Description
	Text(CommandLine.Help.Ansi.Text other)	Copy constructor.