jfxtras.scene.control.LocalDateTextField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfxtras-controls Show documentation
Show all versions of jfxtras-controls Show documentation
Miscellaneous components for JavaFX
/**
* LocalDateTextField.java
*
* Copyright (c) 2011-2014, JFXtras
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the organization nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package jfxtras.scene.control;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Locale;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ListProperty;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleListProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.ObservableList;
import javafx.scene.control.Control;
import javafx.scene.control.Skin;
import javafx.util.Callback;
import jfxtras.internal.scene.control.skin.LocalDateTextFieldSkin;
import jfxtras.scene.control.LocalDatePicker.LocalDateRange;
/**
* LocalDate (JSR-310) text field component.
* This component allows selecting of one date.
*
* @author Tom Eugelink
*/
public class LocalDateTextField extends Control
{
// ==================================================================================================================
// CONSTRUCTOR
/**
*
*/
public LocalDateTextField()
{
construct();
}
/**
*
* @param localDate
*/
public LocalDateTextField(LocalDate localDate)
{
construct();
setLocalDate(localDate);
}
/*
*
*/
private void construct()
{
}
@Override public Skin createDefaultSkin() {
return new LocalDateTextFieldSkin(this);
}
// ==================================================================================================================
// PROPERTIES
/** LocalDate: */
public ObjectProperty localDateProperty() { return localDateObjectProperty; }
private final ObjectProperty localDateObjectProperty = new SimpleObjectProperty(this, "localDate");
public LocalDate getLocalDate() { return localDateObjectProperty.getValue(); }
public void setLocalDate(LocalDate value) { localDateObjectProperty.setValue(value); }
public LocalDateTextField withLocalDate(LocalDate value) { setLocalDate(value); return this; }
/** Locale: the locale is used to determine first-day-of-week, weekday labels, etc */
public ObjectProperty localeProperty() { return localeObjectProperty; }
final private ObjectProperty localeObjectProperty = new SimpleObjectProperty(Locale.getDefault())
{
public void set(Locale value)
{
super.set(value);
if (dateFormatManual == false) {
setDateTimeFormatter( DateTimeFormatter.ofLocalizedDate(FormatStyle.LONG).withLocale(getLocale()) );
}
}
};
public Locale getLocale() { return localeObjectProperty.getValue(); }
public void setLocale(Locale value) { localeObjectProperty.setValue(value); }
public LocalDateTextField withLocale(Locale value) { setLocale(value); return this; }
/**
* The DateTimeFormatter used to render/parse the date in the textfield.
*/
public ObjectProperty dateTimeFormatterProperty() { return dateTimeFormatterObjectProperty; }
final private ObjectProperty dateTimeFormatterObjectProperty = new SimpleObjectProperty(this, "dateTimeFormatter", DateTimeFormatter.ofLocalizedDate(FormatStyle.MEDIUM).withLocale(getLocale()) )
{
public void set(DateTimeFormatter value)
{
super.set( value != null ? value : DateTimeFormatter.ofLocalizedDate(FormatStyle.MEDIUM).withLocale(getLocale()));
dateFormatManual = (value !=null);
}
};
private boolean dateFormatManual = false;
public DateTimeFormatter getDateTimeFormatter() { return dateTimeFormatterObjectProperty.getValue(); }
public void setDateTimeFormatter(DateTimeFormatter value) { dateTimeFormatterObjectProperty.setValue(value); }
public LocalDateTextField withDateTimeFormatter(DateTimeFormatter value) { setDateTimeFormatter(value); return this; }
/** DateTimeFormatters: a list of alternate dateFormats used for parsing only */
public ListProperty dateTimeFormattersProperty() { return dateTimeFormattersProperty; }
ListProperty dateTimeFormattersProperty = new SimpleListProperty(javafx.collections.FXCollections.observableList(new ArrayList()));
public ObservableList getDateTimeFormatters() { return dateTimeFormattersProperty.getValue(); }
public void setDateTimeFormatters(ObservableList value) { dateTimeFormattersProperty.setValue(value); }
public LocalDateTextField withDateTimeFormatter(ObservableList value) { setDateTimeFormatters(value); return this; }
/** PromptText: */
public ObjectProperty promptTextProperty() { return promptTextObjectProperty; }
final private ObjectProperty promptTextObjectProperty = new SimpleObjectProperty(this, "promptText", null);
public String getPromptText() { return promptTextObjectProperty.get(); }
public void setPromptText(String value) { promptTextObjectProperty.set(value); }
public LocalDateTextField withPromptText(String value) { setPromptText(value); return this; }
/** parse error callback:
* If something did not parse correctly, you may handle it.
* Otherwise the exception will be logged on the console.
*/
public ObjectProperty> parseErrorCallbackProperty() { return parseErrorCallbackObjectProperty; }
final private ObjectProperty> parseErrorCallbackObjectProperty = new SimpleObjectProperty>(this, "parseErrorCallback", null);
public Callback getParseErrorCallback() { return this.parseErrorCallbackObjectProperty.getValue(); }
public void setParseErrorCallback(Callback value) { this.parseErrorCallbackObjectProperty.setValue(value); }
public LocalDateTextField withParseErrorCallback(Callback value) { setParseErrorCallback(value); return this; }
/** highlightedLocalDateTimes: */
public ObservableList highlightedLocalDates() { return highlightedLocalDates; }
private final ObservableList highlightedLocalDates = javafx.collections.FXCollections.observableArrayList();
/** disabledLocalDates: */
public ObservableList disabledLocalDates() { return disabledLocalDates; }
private final ObservableList disabledLocalDates = javafx.collections.FXCollections.observableArrayList();
/** localDateRangeCallback:
* This callback allows a developer to limit the amount of calendars put in any of the collections.
* It is called just before a new range is being displayed, so the developer can change the values in the collections like highlighted or disabled.
*/
public ObjectProperty> LocalDateRangeCallbackProperty() { return localDateRangeCallbackObjectProperty; }
final private ObjectProperty> localDateRangeCallbackObjectProperty = new SimpleObjectProperty>(this, "localDateRangeCallback", null);
public Callback getLocalDateRangeCallback() { return this.localDateRangeCallbackObjectProperty.getValue(); }
public void setLocalDateRangeCallback(Callback value) { this.localDateRangeCallbackObjectProperty.setValue(value); }
public LocalDateTextField withLocalDateRangeCallback(Callback value) { setLocalDateRangeCallback(value); return this; }
/** is null allowed */
volatile private BooleanProperty allowNullProperty = new SimpleBooleanProperty(this, "allowNull", true);
public BooleanProperty allowNullProperty() { return allowNullProperty; }
public boolean getAllowNull() { return allowNullProperty.get(); }
public void setAllowNull(boolean allowNull) { allowNullProperty.set(allowNull); }
public LocalDateTextField withAllowNull(boolean value) { setAllowNull(value); return this; }
/** Text: */
public ObjectProperty textProperty() { return textObjectProperty; }
final private ObjectProperty textObjectProperty = new SimpleObjectProperty(this, "text", null);
public String getText() { return textObjectProperty.get(); }
public void setText(String value) { textObjectProperty.set(value); }
public LocalDateTextField withText(String value) { setText(value); return this; }
// ==================================================================================================================
// SUPPORT
}