https://github.com/alipsa/fx-yearmonth-picker
A year-month date picker component for java fx
https://github.com/alipsa/fx-yearmonth-picker
datepicker java javafx
Last synced: 3 months ago
JSON representation
A year-month date picker component for java fx
- Host: GitHub
- URL: https://github.com/alipsa/fx-yearmonth-picker
- Owner: Alipsa
- License: mit
- Created: 2020-07-25T10:32:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-27T15:44:49.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T11:27:01.421Z (about 1 year ago)
- Topics: datepicker, java, javafx
- Language: Java
- Homepage:
- Size: 146 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# fx-yearmonth-picker
[](https://maven-badges.herokuapp.com/maven-central/se.alipsa/fx-yearmonth-picker)
[](https://javadoc.io/doc/se.alipsa/fx-yearmonth-picker)
A year-month date picker component for java fx. Requires java 11 and javafx 11 or higher (tested with jdk 11 and jfx 17.02)
There are two versions:
1. YearMonthPickerCombo - a combobox that return a YearMonth.
2. YearMonthPicker - A custom control that resembles DatePicker where the user can click a calendar and then pick the
desired year month.
See test.alipsa.ymp.YearMonthPickerExample for a simple example of both. Here's an example screenshot:
Both works similar to a combo box i.e. you do getValue() to get the value and
setOnAction() to capture a value change e.g.
```java
YearMonthPicker ymp = new YearMonthPicker();
ymp.setOnAction(a -> System.out.println("Default YearMonthPicker, Value picked was " + ymp.getValue()));
```
There are no external dependencies, and the jar file is about 40kb so nice and small. You can download the jar file from
the release section or add the following to your maven file:
```xml
se.alipsa
fx-yearmonth-picker
1.1.0
```
...or the equivalent to you favorite build tool.
Note that the dependency on java fx is set to "provided" meaning that you need to add
a dependency to javafx explicitly in your project or use a jvm where javafx is bundled
(such as Bellsofts liberica full)
The module name for this library is `se.alipsa.ymp`
## se.alipsa.ymp.YearMonthPickerCombo
There are 5 constructors:
__YearMonthPickerCombo()__
This gives you YearMonths 3 year back and 3 years into the future from now.
__YearMonthPickerCombo(YearMonth initial)__
This gives you YearMonths 3 year back and 3 years into the future from initial.
__YearMonthPickerCombo(YearMonth from, YearMonth to, YearMonth initial)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected.
__YearMonthPickerCombo(YearMonth from, YearMonth to, YearMonth initial, Locale locale)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected displayed in the locale specified formatted as "yyyy-MM".
__YearMonthPickerCombo(YearMonth from, YearMonth to, YearMonth initial, Locale locale, String format)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected, displayed in the locale specified in the format specified.
## se.alipsa.ymp.YearMonthPicker
There are 5 constructors:
__YearMonthPicker()__ This gives you YearMonths 3 year back and 3 years into the future from now in
the system default locale.
__YearMonthPicker(YearMonth initial)__
This gives you YearMonths 3 year back and 3 years into the future from initial in
the system default locale.
__YearMonthPicker(YearMonth initial, Locale locale)__
This gives you YearMonths 3 year back and 3 years into the future from initial in
the specified locale. Month names are in full (long) format.
__YearMonthPicker(YearMonth from, YearMonth to, YearMonth initial)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected in the default locale.
The display value (when a year month is chosen) will be displayed in the
format "yyyy-MM".
__YearMonthPicker(YearMonth from, YearMonth to, YearMonth initial, String monthNameFormat)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected in the default locale. MonthNameFormat is how the
month names will be displayed in the popup. Set it to "MMM" for the letter short style
or include the year with "yyyy-MMM" or whatever.
The display value (when a year month is chosen) will be displayed in the
format "yyyy-MM".
__YearMonthPicker(YearMonth from, YearMonth to, YearMonth initial, Locale locale, String monthNameFormat)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected in the locale specified. MonthNameFormat is how the
month names will be displayed in the popup. Default is "MMMM" (long format), set to "MMM" for the letter short style
or include the year with "yyyy-MMM" or whatever. The display value (when a year month is chosen) will be displayed in the
format "yyyy-MM".
__YearMonthPicker(YearMonth from, YearMonth to, YearMonth initial, Locale locale, String monthPattern, String yearMonthPattern)__
This gives you all yearmonths between from and to (both from and to included) with the
initial value as the default selected in the locale specified. MonthNameFormat is how the
month names will be displayed in the popup. Default is "MMMM" (long format), set to "MMM" for the letter short style
or include the year with "yyyy-MMM" or whatever. The display value (when a year month is chosen) will be displayed in the
format provided with the yearMonthPattern argument.
## Customization
The YearMonthPicker has a style class called "year-month-picker", and the YearMonthPickerCombo a style class called
"year-month-picker-combo" which can be used to specify specific css styling for the components.
Both components are styled like a default combobox.