| <!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 (1.8.0_144) on Sun May 10 12:47:45 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CommandLine.Help.TextTable (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CommandLine.Help.TextTable (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="class-use/CommandLine.Help.TextTable.html">Use</a></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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.Cell.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.TextTable.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><a href="#nested.class.summary">Nested</a> | </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">org.apache.logging.log4j.core.tools.picocli</div> |
| <h2 title="Class CommandLine.Help.TextTable" class="title">Class CommandLine.Help.TextTable</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.TextTable</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.html#line.3893">CommandLine.Help.TextTable</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block"><p>Responsible for spacing out <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Ansi.Text</code></a> values according to the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli"><code>CommandLine.Help.Column</code></a> definitions the table was |
| created with. Columns have a width, indentation, and an overflow policy that decides what to do if a value is |
| longer than the column's width.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.Cell.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable.Cell</a></span></code> |
| <div class="block">Helper class to index positions in a <code>Help.TextTable</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" 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><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#columns">columns</a></span></code> |
| <div class="block">The column definitions of this table.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#columnValues">columnValues</a></span></code> |
| <div class="block">The <code>char[]</code> slots of the <code>TextTable</code> to copy text values into.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#indentWrappedLines">indentWrappedLines</a></span></code> |
| <div class="block">By default, indent wrapped lines by 2 spaces.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-">TextTable</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</code> |
| <div class="block">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) |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column...-">TextTable</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>... columns)</code> |
| <div class="block">Constructs a <code>TextTable</code> with the specified columns.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-int...-">TextTable</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi, |
| int... columnWidths)</code> |
| <div class="block">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.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addEmptyRow--">addEmptyRow</a></span>()</code> |
| <div class="block">Adds the required <code>char[]</code> slots for a new row to the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#columnValues"><code>columnValues</code></a> field.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addRowValues-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text...-">addRowValues</a></span>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a>... values)</code> |
| <div class="block">Adds a new <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addEmptyRow--">empty row</a>, then calls <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#putValue-int-int-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text-"><code>putValue</code></a> for each of the specified values, adding more empty rows |
| if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addRowValues-java.lang.String...-">addRowValues</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... values)</code> |
| <div class="block">Delegates to <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addRowValues-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text...-"><code>addRowValues(CommandLine.Help.Ansi.Text...)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#cellAt-int-int-">cellAt</a></span>(int row, |
| int col)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#textAt-int-int-"><code>textAt(int, int)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.Cell.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable.Cell</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#putValue-int-int-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text-">putValue</a></span>(int row, |
| int col, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a> value)</code> |
| <div class="block">Writes the specified value into the cell at the specified row and column and returns the last row and |
| column written to.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#rowCount--">rowCount</a></span>()</code> |
| <div class="block">Returns the current number of rows of this <code>TextTable</code>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#textAt-int-int-">textAt</a></span>(int row, |
| int col)</code> |
| <div class="block">Returns the <code>Text</code> slot at the specified row and column to write a text value into.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#toString-java.lang.StringBuilder-">toString</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> text)</code> |
| <div class="block">Copies the text representation that we built up from the options into the specified StringBuilder.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="columns"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columns</h4> |
| <pre>public final <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>[] <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3910">columns</a></pre> |
| <div class="block">The column definitions of this table.</div> |
| </li> |
| </ul> |
| <a name="columnValues"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>columnValues</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a>> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3913">columnValues</a></pre> |
| <div class="block">The <code>char[]</code> slots of the <code>TextTable</code> to copy text values into.</div> |
| </li> |
| </ul> |
| <a name="indentWrappedLines"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>indentWrappedLines</h4> |
| <pre>public int <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3916">indentWrappedLines</a></pre> |
| <div class="block">By default, indent wrapped lines by 2 spaces.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextTable</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3930">TextTable</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi)</pre> |
| <div class="block">Constructs a TextTable with five columns as follows: |
| <ol> |
| <li>required option/parameter marker (width: 2, indent: 0, TRUNCATE on overflow)</li> |
| <li>short option name (width: 2, indent: 0, TRUNCATE on overflow)</li> |
| <li>comma separator (width: 1, indent: 0, TRUNCATE on overflow)</li> |
| <li>long option name(s) (width: 24, indent: 1, SPAN multiple columns on overflow)</li> |
| <li>description line(s) (width: 51, indent: 1, WRAP to next row on overflow)</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ansi</code> - whether to emit ANSI escape codes or not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-int...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TextTable</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3946">TextTable</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi, |
| int... columnWidths)</pre> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ansi</code> - whether to emit ANSI escape codes or not</dd> |
| <dd><code>columnWidths</code> - the width of the table columns (all columns have zero indent)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="TextTable-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Column...-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TextTable</h4> |
| <pre>public <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3956">TextTable</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.html" title="enum in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi</a> ansi, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Column</a>... columns)</pre> |
| <div class="block">Constructs a <code>TextTable</code> with the specified columns.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ansi</code> - whether to emit ANSI escape codes or not</dd> |
| <dd><code>columns</code> - columns to construct this TextTable with</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="textAt-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>textAt</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3966">textAt</a>(int row, |
| int col)</pre> |
| <div class="block">Returns the <code>Text</code> slot at the specified row and column to write a text value into.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>row</code> - the row of the cell whose Text to return</dd> |
| <dd><code>col</code> - the column of the cell whose Text to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Text object at the specified row and column</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="cellAt-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cellAt</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3974">cellAt</a>(int row, |
| int col)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#textAt-int-int-"><code>textAt(int, int)</code></a> instead</span></div> |
| <div class="block">Returns the <code>Text</code> slot at the specified row and column to write a text value into.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>row</code> - the row of the cell whose Text to return</dd> |
| <dd><code>col</code> - the column of the cell whose Text to return</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Text object at the specified row and column</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rowCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rowCount</h4> |
| <pre>public int <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3978">rowCount</a>()</pre> |
| <div class="block">Returns the current number of rows of this <code>TextTable</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current number of rows in this TextTable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addEmptyRow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addEmptyRow</h4> |
| <pre>public void <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3981">addEmptyRow</a>()</pre> |
| <div class="block">Adds the required <code>char[]</code> slots for a new row to the <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#columnValues"><code>columnValues</code></a> field.</div> |
| </li> |
| </ul> |
| <a name="addRowValues-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRowValues</h4> |
| <pre>public void <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.3989">addRowValues</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... values)</pre> |
| <div class="block">Delegates to <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addRowValues-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text...-"><code>addRowValues(CommandLine.Help.Ansi.Text...)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the text values to display in each column of the current row</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addRowValues-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addRowValues</h4> |
| <pre>public void <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.4003">addRowValues</a>(<a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a>... values)</pre> |
| <div class="block">Adds a new <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#addEmptyRow--">empty row</a>, then calls <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#putValue-int-int-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text-"><code>putValue</code></a> for each of the specified values, adding more empty rows |
| if the return value indicates that the value spanned multiple columns or was wrapped to multiple rows.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>values</code> - the values to write into a new row in this TextTable</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the number of values exceeds the number of Columns in this table</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="putValue-int-int-org.apache.logging.log4j.core.tools.picocli.CommandLine.Help.Ansi.Text-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>putValue</h4> |
| <pre>public <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.Cell.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.TextTable.Cell</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.4031">putValue</a>(int row, |
| int col, |
| <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Ansi.Text.html" title="class in org.apache.logging.log4j.core.tools.picocli">CommandLine.Help.Ansi.Text</a> value)</pre> |
| <div class="block">Writes the specified value into the cell at the specified row and column and returns the last row and |
| column written to. Depending on the Column's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Column.html#overflow"><code>Overflow</code></a> policy, the value may span |
| multiple columns or wrap to multiple rows when larger than the column width.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>row</code> - the target row in the table</dd> |
| <dd><code>col</code> - the target column in the table to write to</dd> |
| <dd><code>value</code> - the value to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a Cell indicating the position in the table that was last written to (since 2.0)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the specified row exceeds the table's <a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#rowCount--">row count</a></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0 (previous versions returned a <code>java.awt.Point</code> object)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-java.lang.StringBuilder-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.4108">toString</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a> text)</pre> |
| <div class="block">Copies the text representation that we built up from the options into the specified StringBuilder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>text</code> - the StringBuilder to write into</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the specified StringBuilder object (to allow method chaining and a more fluid API)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../../../src-html/org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html#line.4127">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="class-use/CommandLine.Help.TextTable.html">Use</a></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="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.Layout.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.Cell.html" title="class in org.apache.logging.log4j.core.tools.picocli"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/logging/log4j/core/tools/picocli/CommandLine.Help.TextTable.html" target="_top">Frames</a></li> |
| <li><a href="CommandLine.Help.TextTable.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><a href="#nested.class.summary">Nested</a> | </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 ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p> |
| </body> |
| </html> |
