Interface CommandLine.Help.IOptionRenderer
- All Known Implementing Classes:
CommandLine.Help.DefaultOptionRenderer
,CommandLine.Help.MinimalOptionRenderer
- Enclosing class:
- CommandLine.Help
public static interface CommandLine.Help.IOptionRenderer
-
Method Summary
Modifier and TypeMethodDescriptionrender
(CommandLine.Option option, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Returns a text representation of the specified Option and the Field that captures the option value.
-
Method Details
-
render
CommandLine.Help.Ansi.Text[][] render(CommandLine.Option option, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme) Returns a text representation of the specified Option and the Field that captures the option value.- Parameters:
option
- the command line option to show online usage help forfield
- the field that will hold the value for the command line optionparameterLabelRenderer
- responsible for rendering option parameters to textscheme
- color scheme for applying ansi color styles to options and option parameters- Returns:
- a 2-dimensional array of text values: one or more rows, each containing one or more columns
-