TableBuilder (nf-commons 20.04.1 API)

nextflow.ui.TableBuilder

Used to render text based table for UI purpose. Example:

     def table = new TableBuilder().head('col1').head('col2').head('col3', 10)
     table << x << y << z << table.closeRow()
     table << p << q << w << table.closeRow()

     :
     println table.toString()

Authors:: Paolo Di Tommaso

Properties Summary

Properties
Type	Name and description
`java.util.List<java.util.List<TextLabel>>`	`allRows` All the rows
`java.lang.String`	`cellSeparator`
`java.util.List<TextLabel.Align>`	`colsAlign`
`java.util.List<TextLabel>`	`currentRow`
`java.util.List<java.lang.Integer>`	`dim`
`java.util.List<TextLabel>`	`headers` The list defining the table header
`java.util.List<java.lang.Integer>`	`maxColsWidth`
`java.lang.String`	`rowSeparator`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`TableBuilder`	`append(java.lang.Object... values)`
	`TableBuilder`	`append(java.util.List values)` Append the specified list of values as the next row in the table, the columns width are adapted accordingly
	`TableBuilder`	`closeRow()` Close a row in the @return
	`TableBuilder`	`head(java.lang.String name, int maxWidth = 0 )` Defines a single column header, for example: def table = new TableBuilder().head('col1').head('col2').head('col3', 10) table << x << y << z
	`TableBuilder`	`head(java.lang.String name, Align align)`
	`TableBuilder`	`leftShift(java.lang.Object value)` Defines the left-shift operator useful to build the table using the following syntax def table = new TableBuilder() table << col1 << col2 << col3 << table.closeRow() :
	`TableBuilder`	`setHeaders(java.lang.String... cols)` Use the specific string array as the table header definition
	`TableBuilder`	`setHeaders(TextLabel... cols)`
	`TableBuilder`	`setMaxColsWidth(int... colsWidth)`
	`java.lang.String`	`toString()` @return Render the final table and return the string
	`protected void`	`trackWidths(java.util.List<java.lang.Integer> newDim)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.util.List<java.util.List<TextLabel>> allRows
    
    All the rows
  - java.lang.String cellSeparator
  - java.util.List<TextLabel.Align> colsAlign
  - java.util.List<TextLabel> currentRow
  - java.util.List<java.lang.Integer> dim
  - java.util.List<TextLabel> headers
    
    The list defining the table header
  - java.util.List<java.lang.Integer> maxColsWidth
  - java.lang.String rowSeparator
- Method Detail
  - TableBuilder append(java.lang.Object... values)
  - TableBuilder append(java.util.List values)
    
    Append the specified list of values as the next row in the table, the columns width are adapted accordingly
    Parameters:
    values
    Returns:
  - TableBuilder closeRow()
    
    Close a row in the
    Returns:
  - TableBuilder head(java.lang.String name, int maxWidth = 0 )
    
    Defines a single column header, for example:
```
     def table = new TableBuilder().head('col1').head('col2').head('col3', 10)
     table << x << y << z
     
```
    Parameters:
    name - The string value to be used as column header
    maxWidth - The column max width
    Returns:
    The table itself, to enable method chaining
  - TableBuilder head(java.lang.String name, Align align)
  - TableBuilder leftShift(java.lang.Object value)
    
    Defines the left-shift operator useful to build the table using the following syntax
```
      def table = new TableBuilder()
      table << col1 << col2 << col3 << table.closeRow()
      :
     
```
    Parameters:
    value - The value to be added in the table at the current row
    Returns:
    The table instance itself
  - TableBuilder setHeaders(java.lang.String... cols)
    
    Use the specific string array as the table header definition
    Parameters:
    cols
    Returns:
  - TableBuilder setHeaders(TextLabel... cols)
  - TableBuilder setMaxColsWidth(int... colsWidth)
  - java.lang.String toString()
    
    Returns:
    Render the final table and return the string
  - protected void trackWidths(java.util.List<java.lang.Integer> newDim)

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class TableBuilder

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.List<java.util.List<TextLabel>> allRows

java.lang.String cellSeparator

java.util.List<TextLabel.Align> colsAlign

java.util.List<TextLabel> currentRow

java.util.List<java.lang.Integer> dim

java.util.List<TextLabel> headers

java.util.List<java.lang.Integer> maxColsWidth

java.lang.String rowSeparator

Method Detail

TableBuilder append(java.lang.Object... values)

TableBuilder append(java.util.List values)

TableBuilder closeRow()

TableBuilder head(java.lang.String name, int maxWidth = 0 )

TableBuilder head(java.lang.String name, Align align)

TableBuilder leftShift(java.lang.Object value)

TableBuilder setHeaders(java.lang.String... cols)

TableBuilder setHeaders(TextLabel... cols)

TableBuilder setMaxColsWidth(int... colsWidth)

java.lang.String toString()

protected void trackWidths(java.util.List<java.lang.Integer> newDim)