Uses of Class
picocli.CommandLine.Help.Ansi.Text
Packages that use CommandLine.Help.Ansi.Text
Package
Description
Provides classes and interfaces for the main picocli command line parsing and
autocompletion
functionality.-
Uses of CommandLine.Help.Ansi.Text in picocli
Fields in picocli with type parameters of type CommandLine.Help.Ansi.TextModifier and TypeFieldDescriptionprotected final List<CommandLine.Help.Ansi.Text>
CommandLine.Help.TextTable.columnValues
Thechar[]
slots of theTextTable
to copy text values into.Methods in picocli that return CommandLine.Help.Ansi.TextModifier and TypeMethodDescriptionDeprecated.CommandLine.Help.Ansi.Text.append
(CommandLine.Help.Ansi.Text text) Deprecated.useconcat(CommandLine.Help.Ansi.Text)
insteadCommandLine.Help.Ansi.apply
(String plainText, List<CommandLine.Help.Ansi.IStyle> styles) Deprecated.useCommandLine.Help.ColorScheme.apply(String, List)
insteadCommandLine.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.TextTable.cellAt
(int row, int col) Deprecated.useCommandLine.Help.TextTable.textAt(int, int)
insteadCommandLine.Help.commandNamesText
(String separator) Returns aText
object containing the command name and all aliases, separated with the specified separator.CommandLine.Help.ColorScheme.commandText
(String command) Returns a Text with all command styles applied to the specified command string.Returns a copy of thisText
instance with the specified text concatenated to the end.CommandLine.Help.Ansi.Text.concat
(CommandLine.Help.Ansi.Text other) Returns a copy of thisText
instance with the specified text concatenated to the end.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.Returns a Text with all error styles applied to the specified error string.CommandLine.Help.ColorScheme.optionParamText
(String optionParam) Returns a Text with all optionParam styles applied to the specified optionParam string.CommandLine.Help.ColorScheme.optionText
(String option) Returns a Text with all option styles applied to the specified option string.CommandLine.Help.ColorScheme.parameterText
(String parameter) Returns a Text with all parameter styles applied to the specified parameter string.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.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.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.splitLines()
CommandLine.Help.ColorScheme.stackTraceText
(String stackTrace) Returns a Text with all stackTrace styles applied to all lines in the specified stackTrace string.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.substring
(int start) Returns a newText
instance that is a substring of this Text.CommandLine.Help.Ansi.Text.substring
(int start, int end) Returns a newText
instance that is a substring of this Text.CommandLine.Model.ArgGroupSpec.synopsisText
(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs) Returns the synopsis of this group.Returns a new Text object for this Ansi mode, encapsulating the specified string which may contain markup like@|bg(red),white,underline some text|@
.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.TextTable.textAt
(int row, int col) Returns theText
slot at the specified row and column to write a text value into.Methods in picocli with parameters of type CommandLine.Help.Ansi.TextModifier and TypeMethodDescriptionvoid
CommandLine.Help.TextTable.addRowValues
(CommandLine.Help.Ansi.Text... values) CommandLine.Help.Ansi.Text.append
(CommandLine.Help.Ansi.Text text) Deprecated.useconcat(CommandLine.Help.Ansi.Text)
insteadCommandLine.Help.Ansi.Text.concat
(CommandLine.Help.Ansi.Text other) Returns a copy of thisText
instance with the specified text concatenated to the end.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 theCommandLine.Help.TextTable
.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.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.Constructors in picocli with parameters of type CommandLine.Help.Ansi.Text
concat(String)
instead