Skip to content

Commit

Permalink
Described the project in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
hrj committed Nov 29, 2014
1 parent c49405e commit ea01445
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,40 @@
swing-htabs
===========

Hierarchical tabs for Swing
Hierarchical tabs for Swing.

![Screenshot of swing-htabs](https://gngr.info/media/img/misc/swing-htabs-0.0.png)

### Background
The Java Swing UI doesn't have support for creating hierarchical tabs (tabs that are shown as a tree).
We needed this for [gngr](https://gngr.info).
We couldn't find any existing libraries to achieve this, hence this project.

### Status
The current status of this library is a *proof-of-concept*. We are using a little hack to indent the tab components
in a custom JTabbedPane. It works fine in out tests, but we need more testing. Please see *contributing* section below.

The Metal LAF has a small, known issue. The tabs in this LAF have a little notch that overlaps with the next tab, making
it difficult to indent without looking odd. As a workaround we are indenting only the tab content.

The API will be stabilized after testing.

### Contributing
We need more testing to complete this matrix:

JRE v/s LAF | Metal | GTK2 | Nimbus | Motif | Windows | Windows Classic
----------------- | ------- | ------- | ------- | ------- | ------- | ---------------
Ubuntu + Oracle JVM 8u20 | ☑ | ☑ | ☑ | ☑ | - | -
Windows XP + Oracle JVM 7 | ☑ | - | ☑ | ☑ | ☑ | ☑
(TODO: Mac OSX, etc) | - | - | - | - | - | -

#### How to test
Testing is easy; download the latest jar from the `releases` page. After running the jar file, you will
see some randomly generated tabs, with the System LAF. Try swithching to other LAFs using the radio buttons
on the top. Append your report to [this issue](https://github.com/UprootLabs/swing-htabs/issues/1)

## Copyright and License

Copyright 2014 Uproot Labs India

Distributed under the [Apache v2 License](https://www.apache.org/licenses/LICENSE-2.0.html)

0 comments on commit ea01445

Please sign in to comment.