Interface CommandLine.Help.IParameterRenderer
-
- Enclosing class:
- CommandLine.Help
public static interface CommandLine.Help.IParameterRenderer
When customizing online help forParameters
details, a customIParameterRenderer
can be used to create textual representation of a Parameters field in a tabular format: one or more rows, each containing one or more columns. TheLayout
is responsible for placing these text values in theTextTable
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CommandLine.Help.Ansi.Text[][]
render(CommandLine.Parameters parameters, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified Parameters and the Field that captures the parameter values.
-
-
-
Method Detail
-
render
CommandLine.Help.Ansi.Text[][] render(CommandLine.Parameters parameters, Field field, CommandLine.Help.IParamLabelRenderer parameterLabelRenderer, CommandLine.Help.ColorScheme scheme)
Returns a text representation of the specified Parameters and the Field that captures the parameter values.- Parameters:
parameters
- the command line parameters to show online usage help forfield
- the field that will hold the value for the command line parametersparameterLabelRenderer
- responsible for rendering parameter labels to textscheme
- color scheme for applying ansi color styles to positional parameters- Returns:
- a 2-dimensional array of text values: one or more rows, each containing one or more columns
-
-