Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXDatePicker

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.TextInputControl

javafx.scene.control.TextField

io.github.palexdev.materialfx.controls.MFXTextField

io.github.palexdev.materialfx.controls.MFXDatePicker

All Implemented Interfaces:

MFXMenuControl, Validated, Styleable, EventTarget, Skinnable

public class MFXDatePicker
extends MFXTextField

A new, completely made from scratch, modern DatePicker for JavaFX.

A date picker is basically a text field which shows a popup containing a calendar for a specific month. For this reason, extends MFXTextField.

Compared to the previous implementation (that was just a wrapper for the original DatePicker), and the JavaFX's one, the new implementation is much simpler and customizable.

The main features of this new date picker are:

- Floating text (inherited from MFXTextField)

- Allows to fully control the popup (offset, alignment)

- Has three separate converters to convert LocalDate, Month and DayOfWeek to/from String. Those are specified with Suppliers. The default converters always take into account the date picker's localeProperty()

- Has a cell factory function to change the cells

- Allows specifying what to do when editing the text on confirm or cancel (by default, specifies in the skin, ENTER to commit and Ctrl+Shift+Z to cancel

- Allows to easily change the language by setting the localeProperty()

- Has a property to get the current date, plus it's possible to automatically or programmatically update it as days pass

- Allows to specify the range of years for the date picker

- Allows to specify the starting YearMonth of the calendar

- Also adds a new PseudoClass that activates when the popup opens

- Since inherits from MFXTextField, it can be also used as a Label, disabling edit and selection.

The next one is probably a very unique one. Unlike the old one or the JavaFX's one, this date picker allows you to easily change the way the calendar is filled by setting the gridAlgorithmProperty(). By default the date picker uses DateTimeUtils.fullIntMonthMatrix(Locale, YearMonth) to generate a 6x7 grid (rows x columns, it's a bi-dimensional array)

Property Summary

Properties

Type	Property	Description
ObjectProperty<Function<LocalDate,MFXDateCell>>	cellFactory	Specifies the function used to create the day cells in the grid.
SupplierProperty<StringConverter<LocalDate>>	converterSupplier	Specifies the Supplier used to create a StringConverter capable of converting LocalDates.
ReadOnlyObjectProperty<LocalDate>	currentDate	Specifies the current date.
SupplierProperty<StringConverter<DayOfWeek>>	dayOfWeekConverterSupplier	Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.
BiFunctionProperty<Locale,YearMonth,Integer[][]>	gridAlgorithm	Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.
ObjectProperty<Locale>	locale	Specifies the Locale used by this date picker.
SupplierProperty<StringConverter<Month>>	monthConverterSupplier	Specifies the Supplier used to create a StringConverter capable of converting Months.
ConsumerProperty<String>	onCancel	Specifies the action to perform on cancel(String).
ConsumerProperty<String>	onCommit	Specifies the action to perform on commit(String).
ObjectProperty<Alignment>	popupAlignment	Specifies the popup's alignment.
DoubleProperty	popupOffsetX	Specifies the popup's x offset.
DoubleProperty	popupOffsetY	Specifies the popup's y offset.
ReadOnlyBooleanProperty	showing	Specifies whether the popup is showing.
ObjectProperty<LocalDate>	value	Specifies the current selected date.
NumberRangeProperty<Integer>	yearsRange	Specifies the years range of the date picker.

Properties inherited from class io.github.palexdev.materialfx.controls.MFXTextField

allowEdit, animated, borderGap, caretVisible, delegateAnchor, delegateCaretPosition, delegateFocused, delegateRedoable, delegateSelectedText, delegateSelection, delegateTextFormatter, delegateUndoable, floating, floatingTextGap, floatingText, floatMode, graphicTextGap, leadingIcon, measureUnitGap, measureUnit, scaleOnAbove, selectable, textFill, textLimit, trailingIcon

Properties inherited from class javafx.scene.control.TextField

alignment, onAction, prefColumnCount

Properties inherited from class javafx.scene.control.TextInputControl

anchor, caretPosition, editable, font, length, promptText, redoable, selectedText, selection, textFormatter, text, undoable

Properties inherited from class javafx.scene.control.Control

contextMenu, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.control.TextInputControl

TextInputControl.Content

Field Summary

Fields

Modifier and Type	Field	Description
protected static final PseudoClass	POPUP_OPEN_PSEUDO_CLASS

Fields inherited from class io.github.palexdev.materialfx.controls.MFXTextField

boundField, contextMenu, DEFAULT_TEXT_COLOR, floating, validator

Fields inherited from class javafx.scene.control.TextField

DEFAULT_PREF_COLUMN_COUNT

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Fields inherited from interface io.github.palexdev.materialfx.validation.Validated

INVALID_PSEUDO_CLASS

Constructor Summary

Constructors

Constructor	Description
MFXDatePicker()
MFXDatePicker(Locale locale)
MFXDatePicker(Locale locale, YearMonth startingYearMonth)

Method Summary

Modifier and Type	Method	Description
void	cancel(String text)	If the date picker is editable and the text has been changed, this method is responsible for deciding what to do with the new text.
ObjectProperty<Function<LocalDate,MFXDateCell>>	cellFactoryProperty()	Specifies the function used to create the day cells in the grid.
void	commit(String text)	If the date picker is editable and the text has been changed, this method is responsible for deciding what to do with the new text.
SupplierProperty<StringConverter<LocalDate>>	converterSupplierProperty()	Specifies the Supplier used to create a StringConverter capable of converting LocalDates.
protected Skin<?>	createDefaultSkin()
ReadOnlyObjectProperty<LocalDate>	currentDateProperty()	Specifies the current date.
SupplierProperty<StringConverter<DayOfWeek>>	dayOfWeekConverterSupplierProperty()	Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.
void	defaultCellFactory()	Sets/Re-sets the default cell factory.
void	defaultConverters()	Sets/Re-sets the default converters for LocalDate, Month, DayOfWeek.
void	defaultIcon()	Sets/Re-sets the default icon to open the popup.
Function<LocalDate,MFXDateCell>	getCellFactory()	Gets the value of the property cellFactory.
Supplier<StringConverter<LocalDate>>	getConverterSupplier()	Gets the value of the property converterSupplier.
LocalDate	getCurrentDate()	Gets the value of the property currentDate.
Supplier<StringConverter<DayOfWeek>>	getDayOfWeekConverterSupplier()	Gets the value of the property dayOfWeekConverterSupplier.
BiFunction<Locale,YearMonth,Integer[][]>	getGridAlgorithm()	Gets the value of the property gridAlgorithm.
Locale	getLocale()	Gets the value of the property locale.
Supplier<StringConverter<Month>>	getMonthConverterSupplier()	Gets the value of the property monthConverterSupplier.
Consumer<String>	getOnCancel()	Gets the value of the property onCancel.
Consumer<String>	getOnCommit()	Gets the value of the property onCommit.
Alignment	getPopupAlignment()	Gets the value of the property popupAlignment.
double	getPopupOffsetX()	Gets the value of the property popupOffsetX.
double	getPopupOffsetY()	Gets the value of the property popupOffsetY.
YearMonth	getStartingYearMonth()
String	getUserAgentStylesheet()
LocalDate	getValue()	Gets the value of the property value.
NumberRange<Integer>	getYearsRange()	Gets the value of the property yearsRange.
BiFunctionProperty<Locale,YearMonth,Integer[][]>	gridAlgorithmProperty()	Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.
void	hide()	Hides the popup.
boolean	isClosePopupOnChange()
boolean	isShowing()	Gets the value of the property showing.
ObjectProperty<Locale>	localeProperty()	Specifies the Locale used by this date picker.
SupplierProperty<StringConverter<Month>>	monthConverterSupplierProperty()	Specifies the Supplier used to create a StringConverter capable of converting Months.
ConsumerProperty<String>	onCancelProperty()	Specifies the action to perform on cancel(String).
ConsumerProperty<String>	onCommitProperty()	Specifies the action to perform on commit(String).
ObjectProperty<Alignment>	popupAlignmentProperty()	Specifies the popup's alignment.
DoubleProperty	popupOffsetXProperty()	Specifies the popup's x offset.
DoubleProperty	popupOffsetYProperty()	Specifies the popup's y offset.
void	setCellFactory(Function<LocalDate,MFXDateCell> cellFactory)	Sets the value of the property cellFactory.
void	setClosePopupOnChange(boolean closePopupOnChange)
void	setConverterSupplier(Supplier<StringConverter<LocalDate>> converterSupplier)	Sets the value of the property converterSupplier.
void	setDayOfWeekConverterSupplier(Supplier<StringConverter<DayOfWeek>> dayOfWeekConverterSupplier)	Sets the value of the property dayOfWeekConverterSupplier.
void	setGridAlgorithm(BiFunction<Locale,YearMonth,Integer[][]> gridAlgorithm)	Sets the value of the property gridAlgorithm.
void	setLocale(Locale locale)	Sets the value of the property locale.
void	setMonthConverterSupplier(Supplier<StringConverter<Month>> monthConverterSupplier)	Sets the value of the property monthConverterSupplier.
void	setOnCancel(Consumer<String> onCancel)	Sets the value of the property onCancel.
void	setOnCommit(Consumer<String> onCommit)	Sets the value of the property onCommit.
void	setPopupAlignment(Alignment popupAlignment)	Sets the value of the property popupAlignment.
void	setPopupOffsetX(double popupOffsetX)	Sets the value of the property popupOffsetX.
void	setPopupOffsetY(double popupOffsetY)	Sets the value of the property popupOffsetY.
void	setStartingYearMonth(YearMonth startingYearMonth)	Sets the YearMonth at which the date picker will start.
void	setValue(LocalDate value)	Sets the value of the property value.
void	setYearsRange(NumberRange<Integer> yearsRange)	Sets the value of the property yearsRange.
void	show()	Shows the popup.
ReadOnlyBooleanProperty	showingProperty()	Specifies whether the popup is showing.
void	startCurrentDayUpdater()	Starts the executor responsible for updating the current day property once per day.
void	stopCurrentDayUpdater()	Stops the executor responsible for updating the current day property.
void	updateCurrentDate()	Updates the current date property with LocalDate.now()
ObjectProperty<LocalDate>	valueProperty()	Specifies the current selected date.
NumberRangeProperty<Integer>	yearsRangeProperty()	Specifies the years range of the date picker.

Methods inherited from class io.github.palexdev.materialfx.controls.MFXTextField

allowEditProperty, animatedProperty, asLabel, asLabel, asLabel, asLabel, backward, borderGapProperty, caretVisibleProperty, clear, copy, cut, defaultContextMenu, delegateAnchorProperty, delegateCaretPositionProperty, delegateFocusedProperty, delegateGetAnchor, delegateGetCaretPosition, delegateGetSelectedText, delegateGetSelection, delegateGetTextFormatter, delegateIsFocused, delegateIsRedoable, delegateIsUndoable, delegateRedoableProperty, delegateSelectedTextProperty, delegateSelectionProperty, delegateSetTextFormatter, delegateTextFormatterProperty, delegateUndoableProperty, deselect, end, endOfNextWord, extendSelection, floatingProperty, floatingTextGapProperty, floatingTextProperty, floatModeProperty, forward, getBorderGap, getCaretVisible, getClassCssMetaData, getControlCssMetaData, getFloatingText, getFloatingTextGap, getFloatMode, getGraphicTextGap, getLeadingIcon, getMeasureUnit, getMeasureUnitGap, getMFXContextMenu, getTextFill, getTextLimit, getTrailingIcon, getValidator, graphicTextGapProperty, home, isAllowEdit, isAnimated, isFloating, isSelectable, leadingIconProperty, measureUnitGapProperty, measureUnitProperty, nextWord, paste, positionCaret, previousWord, replaceSelection, scaleOnAbove, scaleOnAboveProperty, selectableProperty, selectAll, selectBackward, selectEnd, selectEndOfNextWord, selectForward, selectHome, selectNextWord, selectPositionCaret, selectPreviousWord, selectRange, setAllowEdit, setAnimated, setBorderGap, setCaretVisible, setFloatingText, setFloatingTextGap, setFloatMode, setGraphicTextGap, setLeadingIcon, setMeasureUnit, setMeasureUnitGap, setScaleOnAbove, setSelectable, setTextFill, setTextLimit, setTrailingIcon, textFillProperty, textLimitProperty, trailingIconProperty

Methods inherited from class javafx.scene.control.TextField

alignmentProperty, getAlignment, getCharacters, getOnAction, getPrefColumnCount, onActionProperty, prefColumnCountProperty, setAlignment, setOnAction, setPrefColumnCount

Methods inherited from class javafx.scene.control.TextInputControl

anchorProperty, appendText, cancelEdit, caretPositionProperty, commitValue, deleteNextChar, deletePreviousChar, deleteText, deleteText, editableProperty, executeAccessibleAction, fontProperty, getAnchor, getCaretPosition, getContent, getFont, getLength, getPromptText, getSelectedText, getSelection, getText, getText, getTextFormatter, insertText, isEditable, isRedoable, isUndoable, lengthProperty, promptTextProperty, queryAccessibleAttribute, redo, redoableProperty, replaceText, replaceText, selectedTextProperty, selectionProperty, setEditable, setFont, setPromptText, setText, setTextFormatter, textFormatterProperty, textProperty, undo, undoableProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.palexdev.materialfx.controls.base.MFXMenuControl

isContextMenuDisabled, setContextMenuDisabled

Methods inherited from interface javafx.css.Styleable

getStyleableNode

Methods inherited from interface io.github.palexdev.materialfx.validation.Validated

isValid, updateInvalid, validate

Property Details

showing

public ReadOnlyBooleanProperty showingProperty

Specifies whether the popup is showing.

See Also:

• isShowing()

popupAlignment

public ObjectProperty<Alignment> popupAlignmentProperty

Specifies the popup's alignment.

See Also:

• getPopupAlignment()
• setPopupAlignment(Alignment)

popupOffsetX

public DoubleProperty popupOffsetXProperty

Specifies the popup's x offset.

See Also:

• getPopupOffsetX()
• setPopupOffsetX(double)

popupOffsetY

public DoubleProperty popupOffsetYProperty

Specifies the popup's y offset.

See Also:

• getPopupOffsetY()
• setPopupOffsetY(double)

locale

public ObjectProperty<Locale> localeProperty

Specifies the Locale used by this date picker. The Locale is mainly responsible for changing the language and the grid disposition (different week start for example)

See Also:

• getLocale()
• setLocale(Locale)

value

public ObjectProperty<LocalDate> valueProperty

Specifies the current selected date.

See Also:

• getValue()
• setValue(LocalDate)

converterSupplier

public SupplierProperty<StringConverter<LocalDate>> converterSupplierProperty

Specifies the Supplier used to create a StringConverter capable of converting LocalDates.

See Also:

• getConverterSupplier()
• setConverterSupplier(Supplier)

monthConverterSupplier

public SupplierProperty<StringConverter<Month>> monthConverterSupplierProperty

Specifies the Supplier used to create a StringConverter capable of converting Months.

See Also:

• getMonthConverterSupplier()
• setMonthConverterSupplier(Supplier)

dayOfWeekConverterSupplier

public SupplierProperty<StringConverter<DayOfWeek>> dayOfWeekConverterSupplierProperty

Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.

See Also:

• getDayOfWeekConverterSupplier()
• setDayOfWeekConverterSupplier(Supplier)

onCommit

public ConsumerProperty<String> onCommitProperty

Specifies the action to perform on commit(String).

See Also:

• getOnCommit()
• setOnCommit(Consumer)

onCancel

public ConsumerProperty<String> onCancelProperty

Specifies the action to perform on cancel(String).

See Also:

• getOnCancel()
• setOnCancel(Consumer)

cellFactory

public ObjectProperty<Function<LocalDate,MFXDateCell>> cellFactoryProperty

Specifies the function used to create the day cells in the grid.

See Also:

• getCellFactory()
• setCellFactory(Function)

currentDate

public ReadOnlyObjectProperty<LocalDate> currentDateProperty

Specifies the current date.

See Also:

• getCurrentDate()

yearsRange

public NumberRangeProperty<Integer> yearsRangeProperty

Specifies the years range of the date picker.

See Also:

• getYearsRange()
• setYearsRange(NumberRange)

gridAlgorithm

public BiFunctionProperty<Locale,YearMonth,Integer[][]> gridAlgorithmProperty

Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.

See Also:

• getGridAlgorithm()
• setGridAlgorithm(BiFunction)

Field Details

POPUP_OPEN_PSEUDO_CLASS

protected static final PseudoClass POPUP_OPEN_PSEUDO_CLASS

Constructor Details

MFXDatePicker

public MFXDatePicker()

MFXDatePicker

public MFXDatePicker(Locale locale)

MFXDatePicker

public MFXDatePicker(Locale locale,
 YearMonth startingYearMonth)

Method Details

defaultCellFactory

public void defaultCellFactory()

Sets/Re-sets the default cell factory.

defaultConverters

public void defaultConverters()

Sets/Re-sets the default converters for LocalDate, Month, DayOfWeek.

For:

- LocalDate: uses DateStringConverter with FormatStyle.MEDIUM

- Month: uses MonthStringConverter with the date picker's locale and TextStyle.FULL

- DayOfWeek: uses DayOfWeekStringConverter with the date picker's locale and TextStyle.SHORT

defaultIcon

public void defaultIcon()

Sets/Re-sets the default icon to open the popup.

show

public void show()

Shows the popup.

hide

public void hide()

Hides the popup.

commit

public void commit(String text)

If the date picker is editable and the text has been changed, this method is responsible for deciding what to do with the new text.

By default this implementation calls the specified onCommitProperty() consumer to perform an action on commit. So, instead of overriding the method you can easily modify its behavior by changing the consumer.

cancel

public void cancel(String text)

If the date picker is editable and the text has been changed, this method is responsible for deciding what to do with the new text.

By default this implementation calls the specified onCancelProperty() consumer to perform an action on cancel. So, instead of overriding the method you can easily modify its behavior by changing the consumer.

startCurrentDayUpdater

public void startCurrentDayUpdater()

Starts the executor responsible for updating the current day property once per day.

stopCurrentDayUpdater

public void stopCurrentDayUpdater()

Stops the executor responsible for updating the current day property.

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class MFXTextField

getUserAgentStylesheet

public String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class MFXTextField

isShowing

public boolean isShowing()

Gets the value of the property showing.

Property description:

Specifies whether the popup is showing.

showingProperty

public ReadOnlyBooleanProperty showingProperty()

Specifies whether the popup is showing.

See Also:

• isShowing()

getPopupAlignment

public Alignment getPopupAlignment()

Gets the value of the property popupAlignment.

Property description:

Specifies the popup's alignment.

popupAlignmentProperty

public ObjectProperty<Alignment> popupAlignmentProperty()

Specifies the popup's alignment.

See Also:

• getPopupAlignment()
• setPopupAlignment(Alignment)

setPopupAlignment

public void setPopupAlignment(Alignment popupAlignment)

Sets the value of the property popupAlignment.

Property description:

Specifies the popup's alignment.

getPopupOffsetX

public double getPopupOffsetX()

Gets the value of the property popupOffsetX.

Property description:

Specifies the popup's x offset.

popupOffsetXProperty

public DoubleProperty popupOffsetXProperty()

Specifies the popup's x offset.

See Also:

• getPopupOffsetX()
• setPopupOffsetX(double)

setPopupOffsetX

public void setPopupOffsetX(double popupOffsetX)

Sets the value of the property popupOffsetX.

Property description:

Specifies the popup's x offset.

getPopupOffsetY

public double getPopupOffsetY()

Gets the value of the property popupOffsetY.

Property description:

Specifies the popup's y offset.

popupOffsetYProperty

public DoubleProperty popupOffsetYProperty()

Specifies the popup's y offset.

See Also:

• getPopupOffsetY()
• setPopupOffsetY(double)

setPopupOffsetY

public void setPopupOffsetY(double popupOffsetY)

Sets the value of the property popupOffsetY.

Property description:

Specifies the popup's y offset.

getLocale

public Locale getLocale()

Gets the value of the property locale.

Property description:

Specifies the Locale used by this date picker. The Locale is mainly responsible for changing the language and the grid disposition (different week start for example)

localeProperty

public ObjectProperty<Locale> localeProperty()

Specifies the Locale used by this date picker. The Locale is mainly responsible for changing the language and the grid disposition (different week start for example)

See Also:

• getLocale()
• setLocale(Locale)

setLocale

public void setLocale(Locale locale)

Sets the value of the property locale.

Property description:

Specifies the Locale used by this date picker. The Locale is mainly responsible for changing the language and the grid disposition (different week start for example)

getValue

public LocalDate getValue()

Gets the value of the property value.

Property description:

Specifies the current selected date.

valueProperty

public ObjectProperty<LocalDate> valueProperty()

Specifies the current selected date.

See Also:

• getValue()
• setValue(LocalDate)

setValue

public void setValue(LocalDate value)

Sets the value of the property value.

Property description:

Specifies the current selected date.

getConverterSupplier

public Supplier<StringConverter<LocalDate>> getConverterSupplier()

Gets the value of the property converterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting LocalDates.

converterSupplierProperty

public SupplierProperty<StringConverter<LocalDate>> converterSupplierProperty()

Specifies the Supplier used to create a StringConverter capable of converting LocalDates.

See Also:

• getConverterSupplier()
• setConverterSupplier(Supplier)

setConverterSupplier

public void setConverterSupplier(Supplier<StringConverter<LocalDate>> converterSupplier)

Sets the value of the property converterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting LocalDates.

getMonthConverterSupplier

public Supplier<StringConverter<Month>> getMonthConverterSupplier()

Gets the value of the property monthConverterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting Months.

monthConverterSupplierProperty

public SupplierProperty<StringConverter<Month>> monthConverterSupplierProperty()

Specifies the Supplier used to create a StringConverter capable of converting Months.

See Also:

• getMonthConverterSupplier()
• setMonthConverterSupplier(Supplier)

setMonthConverterSupplier

public void setMonthConverterSupplier(Supplier<StringConverter<Month>> monthConverterSupplier)

Sets the value of the property monthConverterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting Months.

getDayOfWeekConverterSupplier

public Supplier<StringConverter<DayOfWeek>> getDayOfWeekConverterSupplier()

Gets the value of the property dayOfWeekConverterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.

dayOfWeekConverterSupplierProperty

public SupplierProperty<StringConverter<DayOfWeek>> dayOfWeekConverterSupplierProperty()

Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.

See Also:

• getDayOfWeekConverterSupplier()
• setDayOfWeekConverterSupplier(Supplier)

setDayOfWeekConverterSupplier

public void setDayOfWeekConverterSupplier(Supplier<StringConverter<DayOfWeek>> dayOfWeekConverterSupplier)

Sets the value of the property dayOfWeekConverterSupplier.

Property description:

Specifies the Supplier used to create a StringConverter capable of converting DayOfWeeks.

getOnCommit

public Consumer<String> getOnCommit()

Gets the value of the property onCommit.

Property description:

Specifies the action to perform on commit(String).

onCommitProperty

public ConsumerProperty<String> onCommitProperty()

Specifies the action to perform on commit(String).

See Also:

• getOnCommit()
• setOnCommit(Consumer)

setOnCommit

public void setOnCommit(Consumer<String> onCommit)

Sets the value of the property onCommit.

Property description:

Specifies the action to perform on commit(String).

getOnCancel

public Consumer<String> getOnCancel()

Gets the value of the property onCancel.

Property description:

Specifies the action to perform on cancel(String).

onCancelProperty

public ConsumerProperty<String> onCancelProperty()

Specifies the action to perform on cancel(String).

See Also:

• getOnCancel()
• setOnCancel(Consumer)

setOnCancel

public void setOnCancel(Consumer<String> onCancel)

Sets the value of the property onCancel.

Property description:

Specifies the action to perform on cancel(String).

getCellFactory

public Function<LocalDate,MFXDateCell> getCellFactory()

Gets the value of the property cellFactory.

Property description:

Specifies the function used to create the day cells in the grid.

cellFactoryProperty

public ObjectProperty<Function<LocalDate,MFXDateCell>> cellFactoryProperty()

Specifies the function used to create the day cells in the grid.

See Also:

• getCellFactory()
• setCellFactory(Function)

setCellFactory

public void setCellFactory(Function<LocalDate,MFXDateCell> cellFactory)

Sets the value of the property cellFactory.

Property description:

Specifies the function used to create the day cells in the grid.

getCurrentDate

public LocalDate getCurrentDate()

Gets the value of the property currentDate.

Property description:

Specifies the current date.

currentDateProperty

public ReadOnlyObjectProperty<LocalDate> currentDateProperty()

Specifies the current date.

See Also:

• getCurrentDate()

updateCurrentDate

public void updateCurrentDate()

Updates the current date property with LocalDate.now()

getYearsRange

public NumberRange<Integer> getYearsRange()

Gets the value of the property yearsRange.

Property description:

Specifies the years range of the date picker.

yearsRangeProperty

public NumberRangeProperty<Integer> yearsRangeProperty()

Specifies the years range of the date picker.

See Also:

• getYearsRange()
• setYearsRange(NumberRange)

setYearsRange

public void setYearsRange(NumberRange<Integer> yearsRange)

Sets the value of the property yearsRange.

Property description:

Specifies the years range of the date picker.

getGridAlgorithm

public BiFunction<Locale,YearMonth,Integer[][]> getGridAlgorithm()

Gets the value of the property gridAlgorithm.

Property description:

Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.

gridAlgorithmProperty

public BiFunctionProperty<Locale,YearMonth,Integer[][]> gridAlgorithmProperty()

Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.

See Also:

• getGridAlgorithm()
• setGridAlgorithm(BiFunction)

setGridAlgorithm

public void setGridAlgorithm(BiFunction<Locale,YearMonth,Integer[][]> gridAlgorithm)

Sets the value of the property gridAlgorithm.

Property description:

Specifies the BiFunction used to generate the month grid which is a bi-dimensional array of integer values.

getStartingYearMonth

public YearMonth getStartingYearMonth()

Returns:

the date picker's starting YearMonth

setStartingYearMonth

public void setStartingYearMonth(YearMonth startingYearMonth)

Sets the YearMonth at which the date picker will start.

Note that this will be relevant only for the first initialization. Setting this afterwards won't take any effect.

isClosePopupOnChange

public boolean isClosePopupOnChange()

Returns:

whether the popup should stay open on value change or close

setClosePopupOnChange

public void setClosePopupOnChange(boolean closePopupOnChange)