Project icon

com.io7m.jwheatsheaf

Build status Maven Central Codecov

The jwheatsheaf package provides a configurable JavaFX non-native file chooser dialog component capable of traversing any Java NIO filesystem.

Contents

Features

  • Configurable, styleable (CSS), consistent, non-native JavaFX file chooser.
  • Compatible with any JSR 203 filesystem.
  • Directory creation.
  • Configurable, extensible file/directory filtering.
  • Simple case-insensitive directory searching.
  • Written in pure Java 17.
  • OSGi-ready
  • JPMS-ready
  • ISC license
  • High-coverage automated test suite

Releases

The most recently published version of the software is 4.0.0.

Source code and binaries are available from the repository.

Documentation

Documentation for the 4.0.0 release is available for reading online.

Documentation for current and older releases is archived in the repository.

User documentation

See the README.md for documentation.

Maven

The following is a complete list of the project's modules expressed as Maven dependencies: 

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.api</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.examples</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.filter.glob</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.oxygen</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.tests</artifactId>
  <version>4.0.0</version>
</dependency>

<dependency>
  <groupId>com.io7m.jwheatsheaf</groupId>
  <artifactId>com.io7m.jwheatsheaf.ui</artifactId>
  <version>4.0.0</version>
</dependency>

Each release of the project is made available on Maven Central within ten minutes of the release announcement.

Changes

Subscribe to the releases atom feed.

2024-05-16 Release: com.io7m.jwheatsheaf 4.0.0
2022-02-13 Change: (Backwards incompatible) Require JDK 17
2022-02-13 Change: Fix a silently failing OK button (tickets: 34 )
2023-04-17 Change: Update org.openjfx:javafx-controls 19 → 20.
2023-04-17 Change: Update org.openjfx:javafx-fxml 19 → 20.
2023-04-17 Change: Update org.openjfx:javafx-graphics 19 → 20.
2023-04-17 Change: Update org.openjfx:javafx-swing 19 → 20.
2023-04-17 Change: Update org.junit.jupiter:junit-jupiter-api 5.9.1 → 5.9.2.
2023-04-17 Change: Update org.junit.jupiter:junit-jupiter-engine 5.9.1 → 5.9.2.
2023-04-17 Change: Update nl.jqno.equalsverifier:equalsverifier 3.12.3 → 3.14.1.
2023-04-17 Change: Update org.slf4j:slf4j-api 2.0.6 → 2.0.7.
2023-04-17 Change: Update ch.qos.logback:logback-classic 1.4.5 → 1.4.6.
2023-04-17 Change: Update org.mockito:mockito-core 4.10.0 → 5.3.0.
2023-04-17 Change: Update com.github.marschall:memoryfilesystem 2.4.0 → 2.5.0.
2023-05-20 Change: Update com.github.marschall:memoryfilesystem 2.6.0 → 2.6.1.
2023-05-20 Change: Update com.io7m.primogenitor:com.io7m.primogenitor.support 7.5.0 → 7.7.0.
2023-05-20 Change: Update org.junit.jupiter:junit-jupiter-api 5.9.2 → 5.9.3.
2023-05-20 Change: Update org.junit.jupiter:junit-jupiter-engine 5.9.2 → 5.9.3.
2023-05-25 Change: Refactored test suite to use xoanon instead of TestFX.
2023-05-26 Change: (Backwards incompatible) File choosers no longer require a Stage argument.
2024-05-13 Change: Update org.mockito:mockito-core:5.8.0 → 5.12.0.
2024-05-15 Change: Update com.io7m.jaffirm:com.io7m.jaffirm.core:4.0.0 → 4.0.1
2024-05-15 Change: Update com.io7m.junreachable:com.io7m.junreachable.core:4.0.0 → 4.0.2
2024-05-15 Change: Update nl.jqno.equalsverifier:equalsverifier:3.15.5 → 3.16.1
2024-05-15 Change: Update org.slf4j:slf4j-api:2.0.10 → 2.0.13
2024-05-15 Change: Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6
2024-05-15 Change: Update com.github.marschall:memoryfilesystem:2.7.0 → 2.8.0
2024-05-15 Change: Update org.junit:junit-bom:5.10.1 → 5.10.2
2024-05-15 Change: Update org.immutables:value:2.10.0 → 2.10.1
2024-05-15 Change: Update org.openjfx:javafx-controls:21.0.3 → 22.0.1
2024-05-15 Change: Update org.openjfx:javafx-fxml:21.0.3 → 22.0.1
2024-05-15 Change: Update org.openjfx:javafx-graphics:21.0.3 → 22.0.1
2024-05-15 Change: Update org.openjfx:javafx-swing:21.0.3 → 22.0.1
2024-05-15 Change: Update com.io7m.xoanon:com.io7m.xoanon.extension:1.0.0 → 1.0.1
2024-05-16 Change: (Backwards incompatible) Require JDK 21.
2021-05-18 Release: com.io7m.jwheatsheaf 3.0.0
2021-04-10 Change: Allow the escape key to close file choosers (tickets: 14 )
2021-04-10 Change: Allow for specifying an initial filename in choosers (tickets: 15 )
2021-04-10 Change: Allow for specifying custom dialog titles (tickets: 8 )
2021-04-10 Change: Make the default filters part of the public API (tickets: 10 )
2021-04-11 Change: Add an optional home directory button (tickets: 12 )
2021-04-11 Change: Enable sorting of directory items (tickets: 22 )
2021-04-11 Change: Allow for setting a default file filter (tickets: 9 )
2021-04-29 Change: Add support for glob-based filters (tickets: 19 )
2021-04-29 Change: Improve filename field behaviour (tickets: 28 )
2021-05-01 Change: Allow for including ".." in directory listings (tickets: 23 )
2021-05-01 Change: Improve "select directly" dialog behaviour (tickets: 29 )
2021-05-01 Change: Fix the size formatter (tickets: 30 )
2021-05-01 Change: Use the default filesystem by default (tickets: 21 )
2021-05-02 Change: Add the ability to specify custom strings (tickets: 7 )
2021-05-02 Change: Add the ability to confirm file selections (tickets: 17 )
2020-04-10 Release: com.io7m.jwheatsheaf 2.0.1
2020-04-10 Change: Enable CheckStyle to enforce code style
2020-04-04 Release: com.io7m.jwheatsheaf 2.0.0
2020-04-04 Change: (Backwards incompatible) Move implementation classes in the ui module into an internal non-exported package
2020-03-29 Release: com.io7m.jwheatsheaf 1.0.3
2020-03-29 Change: Show the full paths of files/directories in tooltips (tickets: 5 )
2020-03-28 Release: com.io7m.jwheatsheaf 1.0.2
2020-03-28 Change: Ensure CSS stylesheets are passed to any dialogs opened by the chooser (tickets: 4 )
2020-03-28 Release: com.io7m.jwheatsheaf 1.0.1
2020-03-28 Change: Add missing package exports to module descriptors
2020-03-28 Release: com.io7m.jwheatsheaf 1.0.0
2020-03-28 Change: Initial public release

Sources

This project uses Git to manage source code.

Repository: https://www.github.com/io7m-com/jwheatsheaf

$ git clone https://www.github.com/io7m-com/jwheatsheaf

License

Copyright © 2024 Mark Raynsford <code@io7m.com> https://www.io7m.com

Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

Bug Tracker

The project uses GitHub Issues to track issues.