<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Tue Feb 13 20:01:23 JST 2018 -->
<title>CommandLine.Help.Layout (picocli 2.3.0 API)</title>
<meta name="date" content="2018-02-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CommandLine.Help.Layout (picocli 2.3.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli"><span class="strong">Prev Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.Layout.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Help.Layout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">picocli</div>
<h2 title="Class CommandLine.Help.Layout" class="title">Class CommandLine.Help.Layout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>picocli.CommandLine.Help.Layout</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../picocli/CommandLine.Help.html" title="class in picocli">CommandLine.Help</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="strong">CommandLine.Help.Layout</span>
extends java.lang.Object</pre>
<div class="block">Use a Layout to format usage help text for options and parameters in tabular format.
<p>Delegates to the renderers to create <a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli"><code>CommandLine.Help.Ansi.Text</code></a> values for the annotated fields, and uses a
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a> to display these values in tabular format. Layout is responsible for deciding which values
to display where in the table. By default, Layout shows one option or parameter per table row.</p>
<p>Customize by overriding the <a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])"><code>layout(Field, CommandLine.Help.Ansi.Text[][])</code></a> method.</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli"><code>rendering options to text</code></a>,
<a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli"><code>rendering parameters to text</code></a>,
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>showing values in a tabular format</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a></code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#colorScheme">colorScheme</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli">CommandLine.Help.IOptionRenderer</a></code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#optionRenderer">optionRenderer</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli">CommandLine.Help.IParameterRenderer</a></code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#parameterRenderer">parameterRenderer</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#table">table</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme)">CommandLine.Help.Layout</a></strong>(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme)</code>
<div class="block">Constructs a Layout with the specified color scheme, a new default TextTable, the
<a href="../picocli/CommandLine.Help.html#createDefaultOptionRenderer()">default option renderer</a>, and the
<a href="../picocli/CommandLine.Help.html#createDefaultParameterRenderer()">default parameter renderer</a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme,%20picocli.CommandLine.Help.TextTable)">CommandLine.Help.Layout</a></strong>(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a> textTable)</code>
<div class="block">Constructs a Layout with the specified color scheme, the specified TextTable, the
<a href="../picocli/CommandLine.Help.html#createDefaultOptionRenderer()">default option renderer</a>, and the
<a href="../picocli/CommandLine.Help.html#createDefaultParameterRenderer()">default parameter renderer</a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme,%20picocli.CommandLine.Help.TextTable,%20picocli.CommandLine.Help.IOptionRenderer,%20picocli.CommandLine.Help.IParameterRenderer)">CommandLine.Help.Layout</a></strong>(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a> textTable,
<a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli">CommandLine.Help.IOptionRenderer</a> optionRenderer,
<a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli">CommandLine.Help.IParameterRenderer</a> parameterRenderer)</code>
<div class="block">Constructs a Layout with the specified color scheme, the specified TextTable, the
specified option renderer and the specified parameter renderer.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#addOption(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)">addOption</a></strong>(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</code>
<div class="block">Delegates to the <a href="../picocli/CommandLine.Help.Layout.html#optionRenderer"><code>option renderer</code></a> of this layout to obtain
text values for the specified <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a>, and then calls the <a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])"><code>layout(Field, CommandLine.Help.Ansi.Text[][])</code></a>
method to write these text values into the correct cells in the TextTable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#addOptions(java.util.List,%20picocli.CommandLine.Help.IParamLabelRenderer)">addOptions</a></strong>(java.util.List<java.lang.reflect.Field> fields,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</code>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addOption(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)"><code>addOption(Field, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Options in the list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameter(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)">addPositionalParameter</a></strong>(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</code>
<div class="block">Delegates to the <a href="../picocli/CommandLine.Help.Layout.html#parameterRenderer"><code>parameter renderer</code></a> of this layout
to obtain text values for the specified <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>, and then calls
<a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])"><code>layout(Field, CommandLine.Help.Ansi.Text[][])</code></a> to write these text values into the correct cells in the TextTable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameters(java.util.List,%20picocli.CommandLine.Help.IParamLabelRenderer)">addPositionalParameters</a></strong>(java.util.List<java.lang.reflect.Field> fields,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</code>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameter(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)"><code>addPositionalParameter(Field, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Parameters in the list.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])">layout</a></strong>(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>[][] cellValues)</code>
<div class="block">Copies the specified text values into the correct cells in the <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../picocli/CommandLine.Help.Layout.html#toString()">toString</a></strong>()</code>
<div class="block">Returns the section of the usage help message accumulated in the TextTable owned by this layout.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="colorScheme">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>colorScheme</h4>
<pre>protected final <a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme</pre>
</li>
</ul>
<a name="table">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre>protected final <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a> table</pre>
</li>
</ul>
<a name="optionRenderer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>optionRenderer</h4>
<pre>protected <a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli">CommandLine.Help.IOptionRenderer</a> optionRenderer</pre>
</li>
</ul>
<a name="parameterRenderer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>parameterRenderer</h4>
<pre>protected <a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli">CommandLine.Help.IParameterRenderer</a> parameterRenderer</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CommandLine.Help.Layout</h4>
<pre>public CommandLine.Help.Layout(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme)</pre>
<div class="block">Constructs a Layout with the specified color scheme, a new default TextTable, the
<a href="../picocli/CommandLine.Help.html#createDefaultOptionRenderer()">default option renderer</a>, and the
<a href="../picocli/CommandLine.Help.html#createDefaultParameterRenderer()">default parameter renderer</a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colorScheme</code> - the color scheme to use for common, auto-generated parts of the usage help message</dd></dl>
</li>
</ul>
<a name="CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme, picocli.CommandLine.Help.TextTable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CommandLine.Help.Layout</h4>
<pre>public CommandLine.Help.Layout(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a> textTable)</pre>
<div class="block">Constructs a Layout with the specified color scheme, the specified TextTable, the
<a href="../picocli/CommandLine.Help.html#createDefaultOptionRenderer()">default option renderer</a>, and the
<a href="../picocli/CommandLine.Help.html#createDefaultParameterRenderer()">default parameter renderer</a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colorScheme</code> - the color scheme to use for common, auto-generated parts of the usage help message</dd><dd><code>textTable</code> - the TextTable to lay out parts of the usage help message in tabular format</dd></dl>
</li>
</ul>
<a name="CommandLine.Help.Layout(picocli.CommandLine.Help.ColorScheme, picocli.CommandLine.Help.TextTable, picocli.CommandLine.Help.IOptionRenderer, picocli.CommandLine.Help.IParameterRenderer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CommandLine.Help.Layout</h4>
<pre>public CommandLine.Help.Layout(<a href="../picocli/CommandLine.Help.ColorScheme.html" title="class in picocli">CommandLine.Help.ColorScheme</a> colorScheme,
<a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a> textTable,
<a href="../picocli/CommandLine.Help.IOptionRenderer.html" title="interface in picocli">CommandLine.Help.IOptionRenderer</a> optionRenderer,
<a href="../picocli/CommandLine.Help.IParameterRenderer.html" title="interface in picocli">CommandLine.Help.IParameterRenderer</a> parameterRenderer)</pre>
<div class="block">Constructs a Layout with the specified color scheme, the specified TextTable, the
specified option renderer and the specified parameter renderer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>colorScheme</code> - the color scheme to use for common, auto-generated parts of the usage help message</dd><dd><code>optionRenderer</code> - the object responsible for rendering Options to Text</dd><dd><code>parameterRenderer</code> - the object responsible for rendering Parameters to Text</dd><dd><code>textTable</code> - the TextTable to lay out parts of the usage help message in tabular format</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="layout(java.lang.reflect.Field, picocli.CommandLine.Help.Ansi.Text[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>layout</h4>
<pre>public void layout(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.Ansi.Text.html" title="class in picocli">CommandLine.Help.Ansi.Text</a>[][] cellValues)</pre>
<div class="block">Copies the specified text values into the correct cells in the <a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><code>CommandLine.Help.TextTable</code></a>. This implementation
delegates to <a href="../picocli/CommandLine.Help.TextTable.html#addRowValues(picocli.CommandLine.Help.Ansi.Text...)"><code>CommandLine.Help.TextTable.addRowValues(CommandLine.Help.Ansi.Text...)</code></a> for each row of values.
<p>Subclasses may override.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field annotated with the specified Option or Parameters</dd><dd><code>cellValues</code> - the text values representing the Option/Parameters, to be displayed in tabular form</dd></dl>
</li>
</ul>
<a name="addOptions(java.util.List, picocli.CommandLine.Help.IParamLabelRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOptions</h4>
<pre>public void addOptions(java.util.List<java.lang.reflect.Field> fields,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</pre>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addOption(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)"><code>addOption(Field, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Options in the list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fields</code> - fields annotated with <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a> to add usage descriptions for</dd><dd><code>paramLabelRenderer</code> - object that knows how to render option parameters</dd></dl>
</li>
</ul>
<a name="addOption(java.lang.reflect.Field, picocli.CommandLine.Help.IParamLabelRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOption</h4>
<pre>public void addOption(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</pre>
<div class="block">Delegates to the <a href="../picocli/CommandLine.Help.Layout.html#optionRenderer"><code>option renderer</code></a> of this layout to obtain
text values for the specified <a href="../picocli/CommandLine.Option.html" title="annotation in picocli"><code>CommandLine.Option</code></a>, and then calls the <a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])"><code>layout(Field, CommandLine.Help.Ansi.Text[][])</code></a>
method to write these text values into the correct cells in the TextTable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field annotated with the specified Option</dd><dd><code>paramLabelRenderer</code> - knows how to render option parameters</dd></dl>
</li>
</ul>
<a name="addPositionalParameters(java.util.List, picocli.CommandLine.Help.IParamLabelRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPositionalParameters</h4>
<pre>public void addPositionalParameters(java.util.List<java.lang.reflect.Field> fields,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</pre>
<div class="block">Calls <a href="../picocli/CommandLine.Help.Layout.html#addPositionalParameter(java.lang.reflect.Field,%20picocli.CommandLine.Help.IParamLabelRenderer)"><code>addPositionalParameter(Field, CommandLine.Help.IParamLabelRenderer)</code></a> for all non-hidden Parameters in the list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fields</code> - fields annotated with <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a> to add usage descriptions for</dd><dd><code>paramLabelRenderer</code> - knows how to render option parameters</dd></dl>
</li>
</ul>
<a name="addPositionalParameter(java.lang.reflect.Field, picocli.CommandLine.Help.IParamLabelRenderer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPositionalParameter</h4>
<pre>public void addPositionalParameter(java.lang.reflect.Field field,
<a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli">CommandLine.Help.IParamLabelRenderer</a> paramLabelRenderer)</pre>
<div class="block">Delegates to the <a href="../picocli/CommandLine.Help.Layout.html#parameterRenderer"><code>parameter renderer</code></a> of this layout
to obtain text values for the specified <a href="../picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>CommandLine.Parameters</code></a>, and then calls
<a href="../picocli/CommandLine.Help.Layout.html#layout(java.lang.reflect.Field,%20picocli.CommandLine.Help.Ansi.Text[][])"><code>layout(Field, CommandLine.Help.Ansi.Text[][])</code></a> to write these text values into the correct cells in the TextTable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - the field annotated with the specified Parameters</dd><dd><code>paramLabelRenderer</code> - knows how to render option parameters</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns the section of the usage help message accumulated in the TextTable owned by this layout.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../picocli/CommandLine.Help.IParamLabelRenderer.html" title="interface in picocli"><span class="strong">Prev Class</span></a></li>
<li><a href="../picocli/CommandLine.Help.TextTable.html" title="class in picocli"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?picocli/CommandLine.Help.Layout.html" target="_top">Frames</a></li>
<li><a href="CommandLine.Help.Layout.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>