jfxtras.scene.control.CalendarTextField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation
Show all versions of jfxtras-all Show documentation
Miscellaneous components for JavaFX
The newest version!
/**
* CalendarTextField.java
*
* Copyright (c) 2011-2016, 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.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Locale;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
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.CalendarTextFieldSkin;
import jfxtras.internal.scene.control.skin.TextFieldSkin;
import jfxtras.scene.control.CalendarPicker.CalendarRange;
/**
* // These are used for the includes
* :control: CalendarTextField
* :control_instance: calendarTextField
* :calendar: calendar
* :calendars: calendars
* :calendar_class: Calendar
* :calendars_class: Calendars
* :dateFormat: dateFormat
* :dateFormats: dateFormats
*
* = CalendarTextField
*include::src/main/asciidoc/scene/control/CalendarTextField_properties.adoc[]
* The textField can also show time by specifying a DateFormat accordingly, e.g. setDateFormat(SimpleDateFormat.getDateTimeInstance());
*
* == Callback
*include::src/main/asciidoc/scene/control/CalendarTextField_callbacks.adoc[]
*
* == Icon
*include::src/main/asciidoc/scene/control/CalendarTextField_icon.adoc[]
*
* == Immutability
*include::src/main/asciidoc/scene/control/Calendar_immutability.adoc[]
*/
public class CalendarTextField extends Control
{
// ==================================================================================================================
// CONSTRUCTOR
/**
*
*/
public CalendarTextField()
{
construct();
}
/*
*
*/
private void construct()
{
// setup the CSS
// the -fx-skin attribute in the CSS sets which Skin class is used
this.getStyleClass().add(CalendarTextField.class.getSimpleName());
// this is apparently needed for good focus behavior
setFocusTraversable(false);
// forward certain information from the skin to this
skinProperty().addListener( (observable, oldValue, newValue) -> {
if (oldValue instanceof CalendarTextFieldSkin) {
((CalendarTextFieldSkin)oldValue).focusForwardingProperty.removeListener(focusInvalidationListener);
}
if (newValue instanceof CalendarTextFieldSkin) {
((CalendarTextFieldSkin)newValue).focusForwardingProperty.addListener(focusInvalidationListener);
}
});
constructDisplayedCalendar();
}
final private InvalidationListener focusInvalidationListener = new InvalidationListener() {
@Override
public void invalidated(Observable observable) {
CalendarTextField.this.setFocused(((CalendarTextFieldSkin)getSkin()).focusForwardingProperty.get());
}
};
/**
* Return the path to the CSS file so things are setup right
*/
@Override public String getUserAgentStylesheet()
{
return CalendarTextField.class.getResource("/jfxtras/internal/scene/control/" + CalendarTextField.class.getSimpleName() + ".css").toExternalForm();
}
@Override public Skin createDefaultSkin() {
return new jfxtras.internal.scene.control.skin.CalendarTextFieldSkin(this);
}
/**
* Make the call to {@link TextField#selectAll() }.
*/
public void selectAll() {
//Verify the skin is there and implement our interface.
if (getSkin() != null && getSkin() instanceof TextFieldSkin) {
((TextFieldSkin) getSkin()).selectAll();
}
}
// ==================================================================================================================
// PROPERTIES
/** Id */
public CalendarTextField withId(String value) { setId(value); return this; }
/** Calendar: the selected date. */
public ObjectProperty calendarProperty() { return calendarObjectProperty; }
final private ObjectProperty calendarObjectProperty = new SimpleObjectProperty(this, "calendar", null);
public Calendar getCalendar() { return calendarObjectProperty.getValue(); }
public void setCalendar(Calendar value) { calendarObjectProperty.setValue(value); }
public CalendarTextField withCalendar(Calendar value) { setCalendar(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)
{
setDateFormat( getShowTime() ? SimpleDateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.LONG, value) : SimpleDateFormat.getDateInstance(DateFormat.LONG, value) );
}
}
};
public Locale getLocale() { return localeObjectProperty.getValue(); }
public void setLocale(Locale value) { localeObjectProperty.setValue(value); }
public CalendarTextField withLocale(Locale value) { setLocale(value); return this; }
/** ShowTime */
public ObjectProperty showTimeProperty() { return showTimeObjectProperty; }
volatile private ObjectProperty showTimeObjectProperty = new SimpleObjectProperty(this, "showTime", false)
{
public void set(Boolean value)
{
super.set(value);
if (dateFormatManual == false)
{
setDateFormat( getShowTime() ? SimpleDateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.LONG, getLocale()) : SimpleDateFormat.getDateInstance(DateFormat.LONG, getLocale()) );
}
}
};
public Boolean getShowTime() { return showTimeObjectProperty.getValue(); }
public void setShowTime(Boolean value) { showTimeObjectProperty.setValue(value); }
public CalendarTextField withShowTime(Boolean value) { setShowTime(value); return this; }
/**
* The DateFormat used to render/parse the date in the textfield.
* It is allow to show time as well for example by SimpleDateFormat.getDateTimeInstance().
*/
public ObjectProperty dateFormatProperty() { return dateFormatObjectProperty; }
final private ObjectProperty dateFormatObjectProperty = new SimpleObjectProperty(this, "dateFormat", SimpleDateFormat.getDateInstance(DateFormat.LONG, getLocale()))
{
public void set(DateFormat value)
{
super.set( value != null ? value : getShowTime() ? SimpleDateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.LONG, getLocale()) : (SimpleDateFormat.getDateInstance(DateFormat.LONG, getLocale())));
dateFormatManual = (value != null);
}
};
public DateFormat getDateFormat() { return dateFormatObjectProperty.getValue(); }
public void setDateFormat(DateFormat value) { dateFormatObjectProperty.setValue(value); }
public CalendarTextField withDateFormat(DateFormat value) { setDateFormat(value); return this; }
private boolean dateFormatManual = false;
/** 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 CalendarTextField withPromptText(String value) { setPromptText(value); return this; }
/** DateFormats: a list of alternate dateFormats used for parsing only */
public ListProperty dateFormatsProperty() { return dateFormatsProperty; }
ListProperty dateFormatsProperty = new SimpleListProperty(javafx.collections.FXCollections.observableList(new ArrayList()));
public ObservableList getDateFormats() { return dateFormatsProperty.getValue(); }
public void setDateFormats(ObservableList value) { dateFormatsProperty.setValue(value); }
public CalendarTextField withDateFormat(ObservableList value) { setDateFormats(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 CalendarTextField withParseErrorCallback(Callback value) { setParseErrorCallback(value); return this; }
/** highlightedCalendars: a list of dates that are rendered with the highlight class added. This can then be styled using CSS. */
public ObservableList highlightedCalendars() { return highlightedCalendars; }
final private ObservableList highlightedCalendars = javafx.collections.FXCollections.observableArrayList();
/** disabledCalendars: a list of dates that cannot be selected. */
public ObservableList disabledCalendars() { return disabledCalendars; }
final private ObservableList disabledCalendars = javafx.collections.FXCollections.observableArrayList();
/** calendarRangeCallback:
* 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> calendarRangeCallbackProperty() { return calendarRangeCallbackObjectProperty; }
final private ObjectProperty> calendarRangeCallbackObjectProperty = new SimpleObjectProperty>(this, "calendarRangeCallback", null);
public Callback getCalendarRangeCallback() { return this.calendarRangeCallbackObjectProperty.getValue(); }
public void setCalendarRangeCallback(Callback value) { this.calendarRangeCallbackObjectProperty.setValue(value); }
public CalendarTextField withCalendarRangeCallback(Callback value) { setCalendarRangeCallback(value); return this; }
/** valueValidationCallback:
* This callback allows a developer deny or accept a value just prior before it gets added.
* Returning true will allow the value.
*/
public ObjectProperty> valueValidationCallbackProperty() { return valueValidationCallbackObjectProperty; }
final private ObjectProperty> valueValidationCallbackObjectProperty = new SimpleObjectProperty>(this, "valueValidationCallback", null);
public Callback getValueValidationCallback() { return this.valueValidationCallbackObjectProperty.getValue(); }
public void setValueValidationCallback(Callback value) { this.valueValidationCallbackObjectProperty.setValue(value); }
public CalendarTextField withValueValidationCallback(Callback value) { setValueValidationCallback(value); return this; }
/**
* DisplayedCalendar:
* You may set this value, but it is also overwritten by other logic and the skin. Do not assume you have total control.
* The calendar should not be modified using any of its add or set methods (it should be considered immutable)
*/
public ObjectProperty displayedCalendar() { return displayedCalendarObjectProperty; }
volatile private ObjectProperty displayedCalendarObjectProperty = new SimpleObjectProperty(this, "displayedCalendar");
public Calendar getDisplayedCalendar() { return displayedCalendarObjectProperty.getValue(); }
public void setDisplayedCalendar(Calendar value) { displayedCalendarObjectProperty.setValue(value); }
public CalendarTextField withDisplayedCalendar(Calendar value) { setDisplayedCalendar(value); return this; }
private void constructDisplayedCalendar()
{
// init here, so deriveDisplayedCalendar in the skin will modify it accordingly
setDisplayedCalendar(Calendar.getInstance(getLocale()));
}
/** AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state. */
public BooleanProperty allowNullProperty() { return allowNullProperty; }
volatile private BooleanProperty allowNullProperty = new SimpleBooleanProperty(this, "allowNull", true)
{
public void set(boolean value)
{
super.set(value);
if (value == false && getCalendar() == null)
{
setCalendar(Calendar.getInstance(getLocale()));
}
}
};
public boolean getAllowNull() { return allowNullProperty.get(); }
public void setAllowNull(boolean allowNull) { allowNullProperty.set(allowNull); }
public CalendarTextField 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 CalendarTextField withText(String value) { setText(value); return this; }
/**
* Represents the current state of the Picker popup, and whether it is
* currently visible on screen.
*/
public BooleanProperty pickerShowingProperty() { return pickerShowingProperty; }
final private BooleanProperty pickerShowingProperty = new SimpleBooleanProperty(false);
public boolean isPickerShowing() { return pickerShowingProperty.get(); }
public void setPickerShowing(boolean value) { pickerShowingProperty.set(value); }
public CalendarTextField withPickerShowing(boolean value) { setPickerShowing(value); return this; }
/**
* Is the text field editable
*/
public BooleanProperty editableProperty() { return editableProperty; }
final private BooleanProperty editableProperty = new SimpleBooleanProperty(true);
public boolean isEditable() { return editableProperty.get(); }
public void setEditable(boolean value) { editableProperty.set(value); }
public CalendarTextField withEditable(boolean value) { setEditable(value); return this; }
/**
* Immediately set a value entered in the popup into the text field (of use in showTime mode)
*/
public BooleanProperty immediateProperty() { return immediateProperty; }
final private BooleanProperty immediateProperty = new SimpleBooleanProperty(false);
public boolean isImmediate() { return immediateProperty.get(); }
public void setImmediate(boolean value) { immediateProperty.set(value); }
public CalendarTextField withImmediate(boolean value) { setImmediate(value); return this; }
}