GemsFX 3.10.1 · com.dlsc.gemsfx.daterange.DateRangeView

Modifier and Type	Class and Description
private static class	DateRangeView.StyleableProperties

Modifier and Type	Field and Description
private final StringProperty	applyText
private final StringProperty	cancelText
private CalendarView	endCalendarView
private static final PseudoClass	HORIZONTAL_PSEUDOCLASS_STATE
private final ObjectProperty<Runnable>	onClose
private ObjectProperty<Orientation>	orientation
private final ObservableList<DateRangePreset>	presets
private final ObjectProperty<Side>	presetsLocation
private final StringProperty	presetTitle
private final CalendarView.SelectionModel	selectionModel
private final BooleanProperty	showCancelAndApplyButton
private final BooleanProperty	showPresets
private CalendarView	startCalendarView
private final StringProperty	toText
private final ObjectProperty<DateRange>	value
private static final PseudoClass	VERTICAL_PSEUDOCLASS_STATE

Access	Constructor and Description
public	DateRangeView() Constructs a new date range view.

Method Summary

Modifier and Type	Method and Description
public final StringProperty	Returns: the text for the apply button applyTextProperty() The text used for the apply button.
public final StringProperty	Returns: the text for the cancel button cancelTextProperty() The text used for the cancel button.
private CalendarView	createCalendar()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
private DateRangePreset	createLastMonthPreset()
private DateRangePreset	createThisMonthPreset()
private DateRangePreset	createThisWeekPreset()
private DateRangePreset	createTodayRangePreset()
private DateRangePreset	createYesterdayPreset()
public final String	getApplyText()
public final String	getCancelText()
public static List<CssMetaData<? extends Styleable, ?>>	Returns: the `CssMetaData` getClassCssMetaData() Hides javafx.scene.control.Control.getClassCssMetaData. Gets the `CssMetaData` associated with this class, which may include the `CssMetaData` of its superclasses.
public List<CssMetaData<? extends Styleable, ?>>	getControlCssMetaData() Overrides javafx.scene.control.Control.getControlCssMetaData. Gets the unmodifiable list of the control's CSS-styleable properties.
public CalendarView	Returns: the calendar view for the end date selection getEndCalendarView() Returns the `CalendarView` that is being used for the end date selection.
public final Runnable	getOnClose()
public final Orientation	getOrientation()
public final ObservableList<DateRangePreset>	Returns: the presets getPresets() The list of currently available presets.
public final Side	getPresetsLocation()
public final String	getPresetTitle()
public final CalendarView.SelectionModel	Returns: the shared calendar selection model getSelectionModel() Returns the selection model used and shared by the two calendar picker instances.
public CalendarView	Returns: the calendar view for the start date selection getStartCalendarView() Returns the `CalendarView` that is being used for the start date selection.
public final String	getToText()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final DateRange	getValue()
public final boolean	isShowCancelAndApplyButton()
public final boolean	isShowPresets()
public final ObjectProperty<Runnable>	Returns: the closing callback onCloseProperty() A runnable callback that will be invoked when the user closes the control.
public final ObjectProperty<Orientation>	Returns: the layout orientation of the two calendar views orientationProperty() Determines how the start and end calendars will be laid out, either next to each other (horizontal), or one on top of the other (vertical).
public final ObjectProperty<Side>	Returns: the location of the presets presetsLocationProperty() Defines where the presets will be shown relative to the two calendar views.
public final StringProperty	Returns: the title for the preset section presetTitleProperty() The name used for the title label of the presets section.
public final void	setApplyText(String applyText)
public final void	setCancelText(String cancelText)
public final void	setOnClose(Runnable onClose)
public final void	setOrientation(Orientation value)
public final void	setPresetsLocation(Side presetsLocation)
public final void	setPresetTitle(String presetTitle)
public final void	setShowCancelAndApplyButton(boolean showCancelAndApplyButton)
public final void	setShowPresets(boolean showPresets)
public final void	setToText(String toText)
public final void	setValue(DateRange value)
public final BooleanProperty	Returns: true if the buttons will be shown showCancelAndApplyButtonProperty() Shows or hides the cancel and the apply buttons.
public final BooleanProperty	Returns: controls visibility of the presets section showPresetsProperty() Controls whether the presets will be shown by the control
public final StringProperty	Returns: the text for the "to" label toTextProperty() The text shown on the label between the two calendar views.
public final ObjectProperty<DateRange>	Returns: the current date range valueProperty() Stores the currently selected / defined date range.

applyText	back to summary
private final StringProperty applyText

cancelText	back to summary
private final StringProperty cancelText

endCalendarView	back to summary
private CalendarView endCalendarView

HORIZONTAL_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass HORIZONTAL_PSEUDOCLASS_STATE

onClose	back to summary
private final ObjectProperty<Runnable> onClose

orientation	back to summary
private ObjectProperty<Orientation> orientation

presets	back to summary
private final ObservableList<DateRangePreset> presets

presetsLocation	back to summary
private final ObjectProperty<Side> presetsLocation

presetTitle	back to summary
private final StringProperty presetTitle

selectionModel	back to summary
private final CalendarView.SelectionModel selectionModel

showCancelAndApplyButton	back to summary
private final BooleanProperty showCancelAndApplyButton

showPresets	back to summary
private final BooleanProperty showPresets

startCalendarView	back to summary
private CalendarView startCalendarView

toText	back to summary
private final StringProperty toText

value	back to summary
private final ObjectProperty<DateRange> value

VERTICAL_PSEUDOCLASS_STATE	back to summary
private static final PseudoClass VERTICAL_PSEUDOCLASS_STATE

DateRangeView	back to summary
public DateRangeView() Constructs a new date range view.

Method Detail

applyTextProperty	back to summary
public final StringProperty applyTextProperty() The text used for the apply button. Returns:StringProperty the text for the apply button

applyTextProperty

back to summary

public final StringProperty applyTextProperty()

The text used for the apply button.

Returns:StringProperty: the text for the apply button

cancelTextProperty	back to summary
public final StringProperty cancelTextProperty() The text used for the cancel button. Returns:StringProperty the text for the cancel button

cancelTextProperty

back to summary

public final StringProperty cancelTextProperty()

The text used for the cancel button.

Returns:StringProperty: the text for the cancel button

createCalendar	back to summary
private CalendarView createCalendar()

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

createLastMonthPreset	back to summary
private DateRangePreset createLastMonthPreset()

createThisMonthPreset	back to summary
private DateRangePreset createThisMonthPreset()

createThisWeekPreset	back to summary
private DateRangePreset createThisWeekPreset()

createTodayRangePreset	back to summary
private DateRangePreset createTodayRangePreset()

createYesterdayPreset	back to summary
private DateRangePreset createYesterdayPreset()

getApplyText	back to summary
public final String getApplyText()

getCancelText	back to summary
public final String getCancelText()

getClassCssMetaData back to summary

public static List<CssMetaData<? extends Styleable, ?>> getClassCssMetaData()

Hides javafx.scene.control.Control.getClassCssMetaData.

Gets the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

Returns:List<CssMetaData<? extends Styleable, ?>>: the CssMetaData
Since: JavaFX 8.0

getControlCssMetaData

back to summary

public List<CssMetaData<? extends Styleable, ?>> getControlCssMetaData()

Overrides javafx.scene.control.Control.getControlCssMetaData.

Doc from javafx.scene.control.Control.getControlCssMetaData.

Gets the unmodifiable list of the control's CSS-styleable properties.

Annotations

@Override

Since

JavaFX 8.0

getEndCalendarView back to summary

getEndCalendarView	back to summary
public CalendarView getEndCalendarView() Returns the `CalendarView` that is being used for the end date selection. Returns:CalendarView the calendar view for the end date selection

public CalendarView getEndCalendarView()

Returns the CalendarView that is being used for the end date selection.

Returns:CalendarView: the calendar view for the end date selection

getOnClose	back to summary
public final Runnable getOnClose()

getOrientation	back to summary
public final Orientation getOrientation()

getPresets	back to summary
public final ObservableList<DateRangePreset> getPresets() The list of currently available presets. Returns:ObservableList<DateRangePreset> the presets

getPresets

back to summary

public final ObservableList<DateRangePreset> getPresets()

The list of currently available presets.

Returns:ObservableList<DateRangePreset>: the presets

getPresetsLocation	back to summary
public final Side getPresetsLocation()

getPresetTitle	back to summary
public final String getPresetTitle()

getSelectionModel back to summary

getSelectionModel	back to summary
public final CalendarView.SelectionModel getSelectionModel() Returns the selection model used and shared by the two calendar picker instances. Returns:CalendarView.SelectionModel the shared calendar selection model See Also `getStartCalendarView()`, `getEndCalendarView()`

public final CalendarView.SelectionModel getSelectionModel()

Returns the selection model used and shared by the two calendar picker instances.

Returns:CalendarView.SelectionModel: the shared calendar selection model
See Also: getStartCalendarView(), getEndCalendarView()

getStartCalendarView back to summary

getStartCalendarView	back to summary
public CalendarView getStartCalendarView() Returns the `CalendarView` that is being used for the start date selection. Returns:CalendarView the calendar view for the start date selection

public CalendarView getStartCalendarView()

Returns the CalendarView that is being used for the start date selection.

Returns:CalendarView: the calendar view for the start date selection

getToText	back to summary
public final String getToText()

getUserAgentStylesheet back to summary

getUserAgentStylesheet	back to summary
public String getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. Doc from javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls. The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath. Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called. `package com.example.javafx.app; import javafx.application.Application; import javafx.scene.Group; import javafx.scene.Scene; import javafx.stage.Stage; public class MyApp extends Application { @Override public void start(Stage stage) { Scene scene = new Scene(new Group()); scene.getStylesheets().add("/com/example/javafx/app/mystyles.css"); stage.setScene(scene); stage.show(); } public static void main(String[] args) { launch(args); } }` For additional information about using CSS with the scene graph, see the CSS Reference Guide. Annotations @Override

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

getValue	back to summary
public final DateRange getValue()

isShowCancelAndApplyButton	back to summary
public final boolean isShowCancelAndApplyButton()

isShowPresets	back to summary
public final boolean isShowPresets()

onCloseProperty	back to summary
public final ObjectProperty<Runnable> onCloseProperty() A runnable callback that will be invoked when the user closes the control. Returns:ObjectProperty<Runnable> the closing callback

onCloseProperty

back to summary

public final ObjectProperty<Runnable> onCloseProperty()

A runnable callback that will be invoked when the user closes the control.

Returns:ObjectProperty<Runnable>: the closing callback

orientationProperty	back to summary
public final ObjectProperty<Orientation> orientationProperty() Determines how the start and end calendars will be laid out, either next to each other (horizontal), or one on top of the other (vertical). Returns:ObjectProperty<Orientation> the layout orientation of the two calendar views

orientationProperty

back to summary

public final ObjectProperty<Orientation> orientationProperty()

Determines how the start and end calendars will be laid out, either next to each other (horizontal), or one on top of the other (vertical).

Returns:ObjectProperty<Orientation>: the layout orientation of the two calendar views

presetsLocationProperty	back to summary
public final ObjectProperty<Side> presetsLocationProperty() Defines where the presets will be shown relative to the two calendar views. Supports left and right side values. Returns:ObjectProperty<Side> the location of the presets

presetsLocationProperty

back to summary

public final ObjectProperty<Side> presetsLocationProperty()

Defines where the presets will be shown relative to the two calendar views. Supports left and right side values.

Returns:ObjectProperty<Side>: the location of the presets

presetTitleProperty

back to summary

public final StringProperty presetTitleProperty()

The name used for the title label of the presets section. E.g. "Quick Selection".

Returns:StringProperty: the title for the preset section

setApplyText	back to summary
public final void setApplyText(String applyText)

setCancelText	back to summary
public final void setCancelText(String cancelText)

setOnClose	back to summary
public final void setOnClose(Runnable onClose)

setOrientation	back to summary
public final void setOrientation(Orientation value)

setPresetsLocation	back to summary
public final void setPresetsLocation(Side presetsLocation)

setPresetTitle	back to summary
public final void setPresetTitle(String presetTitle)

setShowCancelAndApplyButton	back to summary
public final void setShowCancelAndApplyButton(boolean showCancelAndApplyButton)

setShowPresets	back to summary
public final void setShowPresets(boolean showPresets)

setToText	back to summary
public final void setToText(String toText)

setValue	back to summary
public final void setValue(DateRange value)

showCancelAndApplyButtonProperty

back to summary

public final BooleanProperty showCancelAndApplyButtonProperty()

Shows or hides the cancel and the apply buttons.

Returns:BooleanProperty: true if the buttons will be shown

showPresetsProperty

back to summary

public final BooleanProperty showPresetsProperty()

Controls whether the presets will be shown by the control

Returns:BooleanProperty: controls visibility of the presets section

toTextProperty

back to summary

public final StringProperty toTextProperty()

The text shown on the label between the two calendar views.

Returns:StringProperty: the text for the "to" label

valueProperty

back to summary

public final ObjectProperty<DateRange> valueProperty()

Stores the currently selected / defined date range.

Returns:ObjectProperty<DateRange>: the current date range

Modifier and Type	Field and Description
private static final CssMetaData<DateRangeView, Orientation>	ORIENTATION
private static final List<CssMetaData<? extends Styleable, ?>>	STYLEABLES

public Class DateRangeView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DateRangeView.StyleableProperties

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail