jfxtras.scene.control

Class CalendarTextField

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

jfxtras.scene.control.CalendarTextField

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class CalendarTextField
extends javafx.scene.control.Control

CalendarTextField

A textField which displays a Calendar (date) with a icon to pop up a CalendarPicker. Features relative mutation options, like typing -1 or -1d for plus or minus a day, -1m for minus one month, +1w, +2y, etc. Typing # will set now / today.

This control allows selecting of one calendar. A lot of the properties are mirrors of the ones in the CalendarPicker.

• The calendar property holds the selected Calendar.

• The control can be set to allow no selection at all through the allowNull property.

• There is a disabledCalendars list that will allow specifying calendars that are not selectable (see callback below).

• There is a highlightedCalendars list that will allow specifying calendars that are hightlighted (see callback below).

• The displayedcalendar property indicates what moment in time is displayed by the control.

• The locale property configures which language but also first day of week, etc is used.

• The dateFormat property specifies how a date is rendered in the textfield.

• The dateFormats list contains all formats how a typed text is interpreted to convert to a Calendar

• The pickerShowing property is an indicator if the picker is currently active or not.

• The promptText property specifies the text that is shown when nothing is typed in the textfield.

• The text property returns the content of the textfield as-is (as opposed to the calendar property). The textField can also show time by specifying a DateFormat accordingly, e.g. setDateFormat(SimpleDateFormat.getDateTimeInstance());

Callback

A lot of the callbacks are mirrors of the ones in the CalendarPicker.

calendarRangeCallback

The user is allowed to navigate through all eternity. So if there are many possible meaningful dates, all have to be fetched and populated in the calendars, disabledCalenders and highlightedCalendars lists. This could become quite a performance and memory issue. In order to deal with this situation, the calendarRangeCallback property can be used.

The calendarRangeCallback is called each time a different range is shown in the picker and the CalendarRange parameter has the begin and end of the range that is going to be shown. By registering to the calendarRangeCallback, it is possible to populate the lists with the values relevant to the range.

Example

    calendarTextField.setCalendarRangeCallback( (range) -> {
        calendarPicker.disabledCalenders().clear;
        calendarPicker.disabledCalenders.addAll( BusinessModel.findDisabledCalendarsIn(range.getStartCalendar(), range.getEndCalendar() );
    });

valueValidationCallback

Using the disabledCalendars collection only makes sense in non-time mode. When time is shown, a lot of possibles times (up to milliseconds) can be selected on a single date, so populating the disabledCalendars list with all possible values is practically impossible. To still be able to prevent certain Calendars to be selected, the valueValidationCallback is an alternative. It allows, prior to a Calendar being selected, to check if it is allowed.

Example

    calendarTextField.valueValidationCallback( (calendar) -> {
        if (some_condition(calendar)) {
            return false; // not allowed
        }
        return true; // allowed
    });

parseErrorCallback

The parseErrorCallback can be used to react to typed text that is not interpretable by the {dataFormats}. The control normally will print a stack dump on the console, but the callback can be used to show an error message.

Example

    calendarTextField.parseErrorCallback( (throwable) -> {
        // show error here
    });

Icon

To change the icon use:

    .CalendarTextField .icon  {
        -fx-image: url("AlternateCalendarIcon.jpg");
    }

Immutability

Important note: The calendar is treated (and should have been implemented in Java) as immutable. That means the properties of Calendar are not used to modify its value or listen for changes. CalendarTextField will create a new instance (clone) each time a new value is put in the calendar property.

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	allowNull AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.
javafx.beans.property.ObjectProperty<java.util.Calendar>	calendar Calendar: the selected date.
javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void>>	calendarRangeCallback calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections.
javafx.beans.property.ObjectProperty<java.text.DateFormat>	dateFormat The DateFormat used to render/parse the date in the textfield.
javafx.beans.property.ListProperty<java.text.DateFormat>	dateFormats DateFormats: a list of alternate dateFormats used for parsing only
javafx.beans.property.ObjectProperty<java.util.Locale>	locale Locale: the locale is used to determine first-day-of-week, weekday labels, etc
javafx.beans.property.ObjectProperty<javafx.util.Callback<java.lang.Throwable,java.lang.Void>>	parseErrorCallback parse error callback: If something did not parse correctly, you may handle it.
javafx.beans.property.BooleanProperty	pickerShowing Represents the current state of the Picker popup, and whether it is currently visible on screen.
javafx.beans.property.ObjectProperty<java.lang.String>	promptText PromptText:
javafx.beans.property.ObjectProperty<java.lang.Boolean>	showTime ShowTime
javafx.beans.property.ObjectProperty<java.lang.String>	text Text:
javafx.beans.property.ObjectProperty<javafx.util.Callback<java.util.Calendar,java.lang.Boolean>>	valueValidationCallback valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
CalendarTextField()

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	allowNullProperty() AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.
javafx.beans.property.ObjectProperty<java.util.Calendar>	calendarProperty() Calendar: the selected date.
javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void>>	calendarRangeCallbackProperty() calendarRangeCallback: This callback allows a developer to limit the amount of calendars put in any of the collections.
javafx.scene.control.Skin<?>	createDefaultSkin()
javafx.beans.property.ObjectProperty<java.text.DateFormat>	dateFormatProperty() The DateFormat used to render/parse the date in the textfield.
javafx.beans.property.ListProperty<java.text.DateFormat>	dateFormatsProperty() DateFormats: a list of alternate dateFormats used for parsing only
javafx.collections.ObservableList<java.util.Calendar>	disabledCalendars() disabledCalendars: a list of dates that cannot be selected.
javafx.beans.property.ObjectProperty<java.util.Calendar>	displayedCalendar() DisplayedCalendar: You may set this value, but it is also overwritten by other logic and the skin.
boolean	getAllowNull()
java.util.Calendar	getCalendar()
javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void>	getCalendarRangeCallback()
java.text.DateFormat	getDateFormat()
javafx.collections.ObservableList<java.text.DateFormat>	getDateFormats()
java.util.Calendar	getDisplayedCalendar()
java.util.Locale	getLocale()
javafx.util.Callback<java.lang.Throwable,java.lang.Void>	getParseErrorCallback()
java.lang.String	getPromptText()
java.lang.Boolean	getShowTime()
java.lang.String	getText()
java.lang.String	getUserAgentStylesheet() Return the path to the CSS file so things are setup right
javafx.util.Callback<java.util.Calendar,java.lang.Boolean>	getValueValidationCallback()
javafx.collections.ObservableList<java.util.Calendar>	highlightedCalendars() highlightedCalendars: a list of dates that are rendered with the highlight class added.
boolean	isPickerShowing()
javafx.beans.property.ObjectProperty<java.util.Locale>	localeProperty() Locale: the locale is used to determine first-day-of-week, weekday labels, etc
javafx.beans.property.ObjectProperty<javafx.util.Callback<java.lang.Throwable,java.lang.Void>>	parseErrorCallbackProperty() parse error callback: If something did not parse correctly, you may handle it.
javafx.beans.property.BooleanProperty	pickerShowingProperty() Represents the current state of the Picker popup, and whether it is currently visible on screen.
javafx.beans.property.ObjectProperty<java.lang.String>	promptTextProperty() PromptText:
void	setAllowNull(boolean allowNull)
void	setCalendar(java.util.Calendar value)
void	setCalendarRangeCallback(javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void> value)
void	setDateFormat(java.text.DateFormat value)
void	setDateFormats(javafx.collections.ObservableList<java.text.DateFormat> value)
void	setDisplayedCalendar(java.util.Calendar value)
void	setLocale(java.util.Locale value)
void	setParseErrorCallback(javafx.util.Callback<java.lang.Throwable,java.lang.Void> value)
void	setPickerShowing(boolean value)
void	setPromptText(java.lang.String value)
void	setShowTime(java.lang.Boolean value)
void	setText(java.lang.String value)
void	setValueValidationCallback(javafx.util.Callback<java.util.Calendar,java.lang.Boolean> value)
javafx.beans.property.ObjectProperty<java.lang.Boolean>	showTimeProperty() ShowTime
javafx.beans.property.ObjectProperty<java.lang.String>	textProperty() Text:
javafx.beans.property.ObjectProperty<javafx.util.Callback<java.util.Calendar,java.lang.Boolean>>	valueValidationCallbackProperty() valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added.
CalendarTextField	withAllowNull(boolean value)
CalendarTextField	withCalendar(java.util.Calendar value)
CalendarTextField	withCalendarRangeCallback(javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void> value)
CalendarTextField	withDateFormat(java.text.DateFormat value)
CalendarTextField	withDateFormat(javafx.collections.ObservableList<java.text.DateFormat> value)
CalendarTextField	withDisplayedCalendar(java.util.Calendar value)
CalendarTextField	withId(java.lang.String value) Id
CalendarTextField	withLocale(java.util.Locale value)
CalendarTextField	withParseErrorCallback(javafx.util.Callback<java.lang.Throwable,java.lang.Void> value)
CalendarTextField	withPickerShowing(boolean value)
CalendarTextField	withPromptText(java.lang.String value)
CalendarTextField	withShowTime(java.lang.Boolean value)
CalendarTextField	withText(java.lang.String value)
CalendarTextField	withValueValidationCallback(javafx.util.Callback<java.util.Calendar,java.lang.Boolean> value)

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, 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, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, 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, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, 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, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, 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, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, 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, screenToLocal, screenToLocal, screenToLocal, 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, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

calendar

public javafx.beans.property.ObjectProperty<java.util.Calendar> calendarProperty

Calendar: the selected date.

See Also:

getCalendar(), setCalendar(Calendar)

locale

public javafx.beans.property.ObjectProperty<java.util.Locale> localeProperty

Locale: the locale is used to determine first-day-of-week, weekday labels, etc

See Also:

getLocale(), setLocale(Locale)

showTime

public javafx.beans.property.ObjectProperty<java.lang.Boolean> showTimeProperty

ShowTime

See Also:

getShowTime(), setShowTime(Boolean)

dateFormat

public javafx.beans.property.ObjectProperty<java.text.DateFormat> dateFormatProperty

The DateFormat used to render/parse the date in the textfield. It is allow to show time as well for example by SimpleDateFormat.getDateTimeInstance().

See Also:

getDateFormat(), setDateFormat(DateFormat)

promptText

public javafx.beans.property.ObjectProperty<java.lang.String> promptTextProperty

PromptText:

See Also:

getPromptText(), setPromptText(String)

dateFormats

public javafx.beans.property.ListProperty<java.text.DateFormat> dateFormatsProperty

DateFormats: a list of alternate dateFormats used for parsing only

See Also:

getDateFormats(), setDateFormats(ObservableList)

parseErrorCallback

public javafx.beans.property.ObjectProperty<javafx.util.Callback<java.lang.Throwable,java.lang.Void>> parseErrorCallbackProperty

parse error callback: If something did not parse correctly, you may handle it. Otherwise the exception will be logged on the console.

See Also:

getParseErrorCallback(), setParseErrorCallback(Callback)

calendarRangeCallback

public javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void>> calendarRangeCallbackProperty

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.

See Also:

getCalendarRangeCallback(), setCalendarRangeCallback(Callback)

valueValidationCallback

public javafx.beans.property.ObjectProperty<javafx.util.Callback<java.util.Calendar,java.lang.Boolean>> valueValidationCallbackProperty

valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value.

See Also:

getValueValidationCallback(), setValueValidationCallback(Callback)

allowNull

public javafx.beans.property.BooleanProperty allowNullProperty

AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.

See Also:

getAllowNull(), setAllowNull(boolean)

text

public javafx.beans.property.ObjectProperty<java.lang.String> textProperty

Text:

See Also:

getText(), setText(String)

pickerShowing

public javafx.beans.property.BooleanProperty pickerShowingProperty

Represents the current state of the Picker popup, and whether it is currently visible on screen.

See Also:

isPickerShowing(), setPickerShowing(boolean)

Constructor Detail

CalendarTextField

public CalendarTextField()

Method Detail

getUserAgentStylesheet

public java.lang.String getUserAgentStylesheet()

Return the path to the CSS file so things are setup right

Overrides:

getUserAgentStylesheet in class javafx.scene.control.Control

createDefaultSkin

public javafx.scene.control.Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class javafx.scene.control.Control

withId

public CalendarTextField withId(java.lang.String value)

Id

calendarProperty

public javafx.beans.property.ObjectProperty<java.util.Calendar> calendarProperty()

Calendar: the selected date.

See Also:

getCalendar(), setCalendar(Calendar)

getCalendar

public java.util.Calendar getCalendar()

setCalendar

public void setCalendar(java.util.Calendar value)

withCalendar

public CalendarTextField withCalendar(java.util.Calendar value)

localeProperty

public javafx.beans.property.ObjectProperty<java.util.Locale> localeProperty()

Locale: the locale is used to determine first-day-of-week, weekday labels, etc

See Also:

getLocale(), setLocale(Locale)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale value)

withLocale

public CalendarTextField withLocale(java.util.Locale value)

showTimeProperty

public javafx.beans.property.ObjectProperty<java.lang.Boolean> showTimeProperty()

ShowTime

See Also:

getShowTime(), setShowTime(Boolean)

getShowTime

public java.lang.Boolean getShowTime()

setShowTime

public void setShowTime(java.lang.Boolean value)

withShowTime

public CalendarTextField withShowTime(java.lang.Boolean value)

dateFormatProperty

public javafx.beans.property.ObjectProperty<java.text.DateFormat> dateFormatProperty()

The DateFormat used to render/parse the date in the textfield. It is allow to show time as well for example by SimpleDateFormat.getDateTimeInstance().

See Also:

getDateFormat(), setDateFormat(DateFormat)

getDateFormat

public java.text.DateFormat getDateFormat()

setDateFormat

public void setDateFormat(java.text.DateFormat value)

withDateFormat

public CalendarTextField withDateFormat(java.text.DateFormat value)

promptTextProperty

public javafx.beans.property.ObjectProperty<java.lang.String> promptTextProperty()

PromptText:

See Also:

getPromptText(), setPromptText(String)

getPromptText

public java.lang.String getPromptText()

setPromptText

public void setPromptText(java.lang.String value)

withPromptText

public CalendarTextField withPromptText(java.lang.String value)

dateFormatsProperty

public javafx.beans.property.ListProperty<java.text.DateFormat> dateFormatsProperty()

DateFormats: a list of alternate dateFormats used for parsing only

See Also:

getDateFormats(), setDateFormats(ObservableList)

getDateFormats

public javafx.collections.ObservableList<java.text.DateFormat> getDateFormats()

setDateFormats

public void setDateFormats(javafx.collections.ObservableList<java.text.DateFormat> value)

withDateFormat

public CalendarTextField withDateFormat(javafx.collections.ObservableList<java.text.DateFormat> value)

parseErrorCallbackProperty

public javafx.beans.property.ObjectProperty<javafx.util.Callback<java.lang.Throwable,java.lang.Void>> parseErrorCallbackProperty()

parse error callback: If something did not parse correctly, you may handle it. Otherwise the exception will be logged on the console.

See Also:

getParseErrorCallback(), setParseErrorCallback(Callback)

getParseErrorCallback

public javafx.util.Callback<java.lang.Throwable,java.lang.Void> getParseErrorCallback()

setParseErrorCallback

public void setParseErrorCallback(javafx.util.Callback<java.lang.Throwable,java.lang.Void> value)

withParseErrorCallback

public CalendarTextField withParseErrorCallback(javafx.util.Callback<java.lang.Throwable,java.lang.Void> value)

highlightedCalendars

public javafx.collections.ObservableList<java.util.Calendar> highlightedCalendars()

highlightedCalendars: a list of dates that are rendered with the highlight class added. This can then be styled using CSS.

disabledCalendars

public javafx.collections.ObservableList<java.util.Calendar> disabledCalendars()

disabledCalendars: a list of dates that cannot be selected.

calendarRangeCallbackProperty

public javafx.beans.property.ObjectProperty<javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void>> calendarRangeCallbackProperty()

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.

See Also:

getCalendarRangeCallback(), setCalendarRangeCallback(Callback)

getCalendarRangeCallback

public javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void> getCalendarRangeCallback()

setCalendarRangeCallback

public void setCalendarRangeCallback(javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void> value)

withCalendarRangeCallback

public CalendarTextField withCalendarRangeCallback(javafx.util.Callback<CalendarPicker.CalendarRange,java.lang.Void> value)

valueValidationCallbackProperty

public javafx.beans.property.ObjectProperty<javafx.util.Callback<java.util.Calendar,java.lang.Boolean>> valueValidationCallbackProperty()

valueValidationCallback: This callback allows a developer deny or accept a value just prior before it gets added. Returning true will allow the value.

See Also:

getValueValidationCallback(), setValueValidationCallback(Callback)

getValueValidationCallback

public javafx.util.Callback<java.util.Calendar,java.lang.Boolean> getValueValidationCallback()

setValueValidationCallback

public void setValueValidationCallback(javafx.util.Callback<java.util.Calendar,java.lang.Boolean> value)

withValueValidationCallback

public CalendarTextField withValueValidationCallback(javafx.util.Callback<java.util.Calendar,java.lang.Boolean> value)

displayedCalendar

public javafx.beans.property.ObjectProperty<java.util.Calendar> displayedCalendar()

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)

getDisplayedCalendar

public java.util.Calendar getDisplayedCalendar()

setDisplayedCalendar

public void setDisplayedCalendar(java.util.Calendar value)

withDisplayedCalendar

public CalendarTextField withDisplayedCalendar(java.util.Calendar value)

allowNullProperty

public javafx.beans.property.BooleanProperty allowNullProperty()

AllowNull: indicates if no selected date (resulting in null in the calendar property) is an allowed state.

See Also:

getAllowNull(), setAllowNull(boolean)

getAllowNull

public boolean getAllowNull()

setAllowNull

public void setAllowNull(boolean allowNull)

withAllowNull

public CalendarTextField withAllowNull(boolean value)

textProperty

public javafx.beans.property.ObjectProperty<java.lang.String> textProperty()

Text:

See Also:

getText(), setText(String)

getText

public java.lang.String getText()

setText

public void setText(java.lang.String value)

withText

public CalendarTextField withText(java.lang.String value)

pickerShowingProperty

public javafx.beans.property.BooleanProperty pickerShowingProperty()

Represents the current state of the Picker popup, and whether it is currently visible on screen.

See Also:

isPickerShowing(), setPickerShowing(boolean)

isPickerShowing

public boolean isPickerShowing()

setPickerShowing

public void setPickerShowing(boolean value)

withPickerShowing

public CalendarTextField withPickerShowing(boolean value)