Uses of Class
picocli.CommandLine.Help.ColorScheme

Packages that use CommandLine.Help.ColorScheme

Package	Description
picocli	Provides classes and interfaces for the main picocli command line parsing and autocompletion functionality.

Uses of CommandLine.Help.ColorScheme in picocli

Fields in picocli declared as CommandLine.Help.ColorScheme

Modifier and Type	Field	Description
protected CommandLine.Help.ColorScheme	CommandLine.Help.Layout.colorScheme

Methods in picocli that return CommandLine.Help.ColorScheme

Modifier and Type	Method	Description
CommandLine.Help.ColorScheme	CommandLine.Help.ColorScheme.Builder.build()	Creates and returns a new ColorScheme with the values configured on this builder.
CommandLine.Help.ColorScheme	CommandLine.AbstractHandler.colorScheme()	Deprecated. Returns the ColorScheme to use.
CommandLine.Help.ColorScheme	CommandLine.Help.colorScheme()	Returns the ColorScheme model that this Help was constructed with.
CommandLine.Help.ColorScheme	CommandLine.Help.Layout.colorScheme()	Returns the ColorScheme used to create Text objects in this layout.
static CommandLine.Help.ColorScheme	CommandLine.Help.defaultColorScheme(CommandLine.Help.Ansi ansi)	Creates and returns a new CommandLine.Help.ColorScheme initialized with picocli default values: commands are bold, options and parameters use a yellow foreground, and option parameters use italic.
CommandLine.Help.ColorScheme	CommandLine.getColorScheme()	Returns the color scheme to use when printing help.

Methods in picocli with parameters of type CommandLine.Help.ColorScheme

Modifier and Type	Method	Description
int	CommandLine.Help.calcLongOptionColumnWidth(List<CommandLine.Model.OptionSpec> options, List<CommandLine.Model.PositionalParamSpec> positionals, CommandLine.Help.ColorScheme aColorScheme)	Returns the width of the long options column in the usage help message.
CommandLine.Help	CommandLine.IHelpFactory.create(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)	Returns a Help instance to assist in rendering the usage help message
CommandLine.Help.Layout	CommandLine.Help.createDefaultLayout(List<CommandLine.Model.OptionSpec> options, List<CommandLine.Model.PositionalParamSpec> positionals, CommandLine.Help.ColorScheme aColorScheme)	Returns a Layout instance configured with the user preferences captured in this Help instance.
static CommandLine.Help.TextTable	CommandLine.Help.TextTable.forColumns(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.Column... columns)	Constructs a TextTable with the specified columns.
static CommandLine.Help.TextTable	CommandLine.Help.TextTable.forColumnWidths(CommandLine.Help.ColorScheme colorScheme, int... columnWidths)	Constructs a new TextTable with columns with the specified width, all SPANning multiple columns on overflow except the last column which WRAPS to the next row.
static CommandLine.Help.TextTable	CommandLine.Help.TextTable.forDefaultColumns(CommandLine.Help.ColorScheme colorScheme, int longOptionsColumnWidth, int usageHelpWidth)	Constructs a TextTable with five columns as follows: required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow) short option name (width: 2, indent: 0, TRUNCATE on overflow) comma separator (width: 1, indent: 0, TRUNCATE on overflow) long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow) description line(s) (width: 51, indent: 1, WRAP to next row on overflow)
String	CommandLine.getUsageMessage(CommandLine.Help.ColorScheme colorScheme)	Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but returns the usage help message as a String instead of printing it to the PrintStream.
void	CommandLine.HelpCommand.init(CommandLine helpCommandLine, CommandLine.Help.ColorScheme colorScheme, PrintWriter out, PrintWriter err)	Initializes this object with the information needed to implement a help command that provides usage help for other commands.
void	CommandLine.IHelpCommandInitializable2.init(CommandLine helpCommandLine, CommandLine.Help.ColorScheme colorScheme, PrintWriter outWriter, PrintWriter errWriter)	Initializes this object with the information needed to implement a help command that provides usage help for other commands.
static boolean	CommandLine.printHelpIfRequested(List<CommandLine> parsedCommands, PrintStream out, PrintStream err, CommandLine.Help.ColorScheme colorScheme)	Deprecated. use CommandLine.executeHelpRequest(ParseResult) instead
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	CommandLine.setColorScheme(CommandLine.Help.ColorScheme colorScheme)	Sets the color scheme to use when printing help.
CommandLine.Help.Ansi.Text	CommandLine.Model.ArgGroupSpec.synopsisText(CommandLine.Help.ColorScheme colorScheme, Set<CommandLine.Model.ArgSpec> outparam_groupArgs)	Returns the synopsis of this group.
void	CommandLine.usage(PrintStream out, CommandLine.Help.ColorScheme colorScheme)	Prints a usage help message for the annotated command class to the specified PrintStream.
void	CommandLine.usage(PrintWriter writer, CommandLine.Help.ColorScheme colorScheme)	Similar to CommandLine.usage(PrintStream, Help.ColorScheme), but with the specified PrintWriter instead of a PrintStream.
static void	CommandLine.usage(Object command, PrintStream out, CommandLine.Help.ColorScheme colorScheme)	Equivalent to new CommandLine(command).usage(out, colorScheme).

Constructors in picocli with parameters of type CommandLine.Help.ColorScheme

Constructor	Description
Builder(CommandLine.Help.ColorScheme existing)	Constructs a color scheme builder with all attributes copied from the specified color scheme.
Help(Object command, CommandLine.Help.ColorScheme colorScheme)	Deprecated. use Help(picocli.CommandLine.Model.CommandSpec, picocli.CommandLine.Help.ColorScheme)
Help(CommandLine.Model.CommandSpec commandSpec, CommandLine.Help.ColorScheme colorScheme)	Constructs a new Help instance with the specified color scheme, initialized from annotations on the specified class and superclasses.
Layout(CommandLine.Help.ColorScheme colorScheme, int tableWidth)	Constructs a Layout with the specified color scheme, a new default TextTable, the default option renderer, and the default parameter renderer.
Layout(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.TextTable textTable)	Constructs a Layout with the specified color scheme, the specified TextTable, the default option renderer, and the default parameter renderer.
Layout(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.TextTable textTable, CommandLine.Help.IOptionRenderer optionRenderer, CommandLine.Help.IParameterRenderer parameterRenderer)	Constructs a Layout with the specified color scheme, the specified TextTable, the specified option renderer and the specified parameter renderer.
Text(int maxLength, CommandLine.Help.ColorScheme colorScheme)	Constructs a Text with the specified max length (for use in a TextTable Column).
Text(String input, CommandLine.Help.ColorScheme colorScheme)	Constructs a Text with the specified String (which may contain markup), and ColorScheme.
TextTable(CommandLine.Help.ColorScheme colorScheme, CommandLine.Help.Column[] columns)