Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmkyr20/tables4j
Java-Cli-Table-Builder makes it easy to create flexible command-line tables. You haven't need to write your classes and methods to decorate console output anymore. Just use this flexible tool for positioning.
https://github.com/dmkyr20/tables4j
builder cli command-line command-line-tool console console-app console-application console-log console-tool easy-to-use java java-11 java-8 java-library library maven repository
Last synced: 24 days ago
JSON representation
Java-Cli-Table-Builder makes it easy to create flexible command-line tables. You haven't need to write your classes and methods to decorate console output anymore. Just use this flexible tool for positioning.
- Host: GitHub
- URL: https://github.com/dmkyr20/tables4j
- Owner: dmkyr20
- License: mit
- Created: 2020-03-01T14:37:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-18T17:29:41.000Z (over 1 year ago)
- Last Synced: 2024-09-30T14:11:02.420Z (about 1 month ago)
- Topics: builder, cli, command-line, command-line-tool, console, console-app, console-application, console-log, console-tool, easy-to-use, java, java-11, java-8, java-library, library, maven, repository
- Language: Java
- Homepage:
- Size: 667 KB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Java-Cli-Table-Builder
Thank you for choosing Java-Cli-Table-Builder - an **easy** to use **command-line interface** tool.
[](https://github.com/dmkyr20/Java-Cli-Table-Builder/blob/master/LICENSE)
[]()
## Overview
Java-Cli-Table-Builder makes it easy to create flexible command-line tables.
You haven't need to write your classes and methods to decorate console output anymore.
Just use this flexible tool for positioning.
### Examples
#### Example 1
**Creating simple CLI game interface.**
You haven't need make formatting output by yourself anymore. Use already created methods for creating independent
blocks on screen.
##### Code
```
public void simpleOutput() throws CellContentException {
TableBuilder tableBuilder = new TableBuilder();
tableBuilder.setDefaultCellBorderStyle(CellBorderTemplate.SOLID.getBorderStyle());
tableBuilder.addCell(HEADER, new CellPosition(0, 0, 100, 12));
tableBuilder.addCell("1 - Start", new CellPosition(0, 12, 25, 15));
tableBuilder.addCell("2 - Load", new CellPosition(25, 12, 50, 15));
tableBuilder.addCell("5 - Settings", new CellPosition(50, 12, 75, 15));
tableBuilder.addCell("6 - Exit", new CellPosition(75, 12, 100, 15));
tableBuilder.print();
}
```
##### Output
```
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ │
│ │
│ █▀▀ █░░ ░▀░ █▀▀▀ █▀▀█ █▀▄▀█ █▀▀ │
│ █░░ █░░ ▀█▀ █░▀█ █▄▄█ █░▀░█ █▀▀ │
│ ▀▀▀ ▀▀▀ ▀▀▀ ▀▀▀▀ ▀░░▀ ▀░░░▀ ▀▀▀ │
│ │
│ │
│ │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
┌───────────────────────┐┌───────────────────────┐┌───────────────────────┐┌───────────────────────┐
│ 1 - Start ││ 2 - Load ││ 5 - Settings ││ 6 - Exit │
└───────────────────────┘└───────────────────────┘└───────────────────────┘└───────────────────────┘
```
#### Example 2
**Easy and fast changes in any completed output.**
You can add a block of content in any place on screen. You shouldn't care about previously created content anymore.
##### Code
```
public void simpleOutputWithNote() throws CellContentException {
TableBuilder tableBuilder = new TableBuilder();
tableBuilder.setDefaultCellBorderStyle(CellBorderTemplate.SOLID.getBorderStyle());
tableBuilder.addCell(HEADER, new CellPosition(0, 0, 100, 12));
tableBuilder.addCell("1 - Start", new CellPosition(0, 12, 25, 15));
tableBuilder.addCell("2 - Load", new CellPosition(25, 12, 50, 15));
tableBuilder.addCell("5 - Settings", new CellPosition(50, 12, 75, 15));
tableBuilder.addCell("6 - Exit", new CellPosition(75, 12, 100, 15));
Cell note = new Cell(new CellPosition(1, 8, 90, 11), NOTE);
note.setCellBorderStyle(CellBorderTemplate.NO_BORDERS.getBorderStyle());
note.setHorizontalAlignment(CellHorizontalAlignment.LEFT);
tableBuilder.addCell(note);
tableBuilder.print();
}
```
##### Output
```
┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
│ │
│ │
│ │
│ █▀▀ █░░ ░▀░ █▀▀▀ █▀▀█ █▀▄▀█ █▀▀ │
│ █░░ █░░ ▀█▀ █░▀█ █▄▄█ █░▀░█ █▀▀ │
│ ▀▀▀ ▀▀▀ ▀▀▀ ▀▀▀▀ ▀░░▀ ▀░░░▀ ▀▀▀ │
│ │
│ │
│ Note: Pres number key to choose. │
│ │
└──────────────────────────────────────────────────────────────────────────────────────────────────┘
┌───────────────────────┐┌───────────────────────┐┌───────────────────────┐┌───────────────────────┐
│ 1 - Start ││ 2 - Load ││ 5 - Settings ││ 6 - Exit │
└───────────────────────┘└───────────────────────┘└───────────────────────┘└───────────────────────┘
```
### Requirements
* Java 8 JDK or later.
## How to start?
You can use the library as ```.jar``` file. Or run it using the CLI as executable ```.jar``` file.
Copy the project. Then go to a folder with project and run ```gradle``` ```gradle clean build``` command.
Ready to use ```.jar``` file located in ```target``` folder.
Or include it using `maven` or `gradle`:
**Maven**
```
org.dmkyr20.Java-Cli-Table-Builder
java-cli-table-builder
1.0.2
```
**Gradle**
```
implement 'org.dmkyr20.Java-Cli-Table-Builder.java-cli-table-builder:1.0.2'
```
> See [Package](https://github.com/dmkyr20/Java-Cli-Table-Builder/packages/328302).
## Documentation
You could find all documentation for project in JavaDoc.
Or in [Documentation](https://github.com/dmkyr20/Java-Cli-Table-Builder/wiki). (Not Allowed yet)
## License
Distributed under the MIT License. See LICENSE for more information.