Modifier and Type	Class and Description
public static enum	YearMonthView.ClickBehaviour An enumerator to control the behaviour of the control when the user clicks on a date.
public static class	YearMonthView.DateCell The base date cell implementation for month views.

Modifier and Type	Field and Description
private final ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>>	cellFactory
private final ObjectProperty<YearMonthView.ClickBehaviour>	clickBehaviour
private static final String	MONTH_VIEW_CATEGORY Hides com.calendarfx.view.MonthViewBase.MONTH_VIEW_CATEGORY.
private final BooleanProperty	showMonth
private final BooleanProperty	showMonthArrows
private final BooleanProperty	showTodayButton
private final BooleanProperty	showUsageColors
private final BooleanProperty	showYear
private final BooleanProperty	showYearArrows

Access	Constructor and Description
public	YearMonthView() Constructs a new view.

Method Summary

Modifier and Type	Method and Description
public final ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>>	Returns: the cell factory cellFactoryProperty() A factory for creating alternative content for the month view.
public final ObjectProperty<YearMonthView.ClickBehaviour>	Returns: the click behaviour clickBehaviourProperty() The behaviour used when the user clicks on a date.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final Callback<YearMonthView, YearMonthView.DateCell>	Returns: the cell factory getCellFactory() Returns the value of `cellFactoryProperty()`.
public final YearMonthView.ClickBehaviour	Returns: the click behaviour getClickBehaviour() Returns the value of `clickBehaviourProperty()`.
public ObservableList<PropertySheet.Item>	getPropertySheetItems() Overrides com.calendarfx.view.MonthViewBase.getPropertySheetItems. Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX.
public final boolean	Returns: true if the month name will be shown isShowMonth() Returns the value of `showMonthProperty()`.
public final boolean	Returns: true if the arrows will be shown isShowMonthArrows() Returns the value of the `showMonthArrowsProperty()`.
public final boolean	Returns: true if the button is shown isShowTodayButton() Returns the value of the `showTodayButtonProperty()`.
public final boolean	Returns: true if the colors will be shown isShowUsageColors() Returns the value of the `showUsageColorsProperty()`.
public final boolean	Returns: true if the year will be shown isShowYear() Returns the value of `showYearProperty()`.
public final boolean	Returns: true if the arrows will be shown isShowYearArrows() Returns the value of the `showYearArrowsProperty()`.
public final void	setCellFactory(Callback<YearMonthView, YearMonthView.DateCell> the cell factory factory) Sets the value of `cellFactoryProperty()`.
public final void	setClickBehaviour(YearMonthView.ClickBehaviour the click behaviour behaviour) Sets the value of `clickBehaviourProperty()`.
public final void	setShowMonth(boolean if true the month will be shown show) Sets the value of `showMonthProperty()`.
public final void	setShowMonthArrows(boolean if true will show the arrows show) Sets the value of the `showMonthArrowsProperty()`.
public final void	setShowTodayButton(boolean if true will show the button show) Sets the value of the `showTodayButtonProperty()`.
public final void	setShowUsageColors(boolean if true will show the colors show) Sets the value of `showUsageColorsProperty()`.
public final void	setShowYear(boolean if true the year will be shown show) Sets the value of `showYearProperty()`.
public final void	setShowYearArrows(boolean if true will show the arrows show) Sets the value of the `showYearArrowsProperty()`.
public final BooleanProperty	Returns: true if the arrows will be shown showMonthArrowsProperty() Shows or hides the arrows to change the month.
public final BooleanProperty	Returns: true if the month name will be shown showMonthProperty() Show or hide the name of the month.
public final BooleanProperty	Returns: true if the button will be shown showTodayButtonProperty() Show or hide a button to quickly go to today's date.
public final BooleanProperty	Returns: true if the usage colors will be shown showUsageColorsProperty() Show or hide usage colors that are based on the number of entries on a given date.
public final BooleanProperty	Returns: true if the arrows will be shown showYearArrowsProperty() Shows or hides the arrows to change the year.
public final BooleanProperty	Returns: true if the year will be shown showYearProperty() Show or hide the year.

Inherited from com.calendarfx.view.MonthViewBase:: getSelectedDates getYearMonth isShowWeekNumbers setShowWeekNumbers showWeekNumbersProperty yearMonthProperty

Field Detail

cellFactory	back to summary
private final ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>> cellFactory

clickBehaviour	back to summary
private final ObjectProperty<YearMonthView.ClickBehaviour> clickBehaviour

MONTH_VIEW_CATEGORY	back to summary
private static final String MONTH_VIEW_CATEGORY Hides com.calendarfx.view.MonthViewBase.MONTH_VIEW_CATEGORY.

showMonth	back to summary
private final BooleanProperty showMonth

showMonthArrows	back to summary
private final BooleanProperty showMonthArrows

showTodayButton	back to summary
private final BooleanProperty showTodayButton

showUsageColors	back to summary
private final BooleanProperty showUsageColors

showYear	back to summary
private final BooleanProperty showYear

showYearArrows	back to summary
private final BooleanProperty showYearArrows

Constructor Detail

YearMonthView	back to summary
public YearMonthView() Constructs a new view.

Method Detail

cellFactoryProperty back to summary

cellFactoryProperty	back to summary
public final ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>> cellFactoryProperty() A factory for creating alternative content for the month view. The image below shows the `YearMonthView` once with the default factory and once with an alternative factory that creates checkboxes. Returns:ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>> the cell factory

public final ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>> cellFactoryProperty()

A factory for creating alternative content for the month view. The image below shows the YearMonthView once with the default factory and once with an alternative factory that creates checkboxes. Month Cell Factory

Returns:ObjectProperty<Callback<YearMonthView, YearMonthView.DateCell>>: the cell factory

clickBehaviourProperty	back to summary
public final ObjectProperty<YearMonthView.ClickBehaviour> clickBehaviourProperty() The behaviour used when the user clicks on a date. Returns:ObjectProperty<YearMonthView.ClickBehaviour> the click behaviour

clickBehaviourProperty

back to summary

public final ObjectProperty<YearMonthView.ClickBehaviour> clickBehaviourProperty()

The behaviour used when the user clicks on a date.

Returns:ObjectProperty<YearMonthView.ClickBehaviour>: the click behaviour

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(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. 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(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

getCellFactory back to summary

getCellFactory	back to summary
public final Callback<YearMonthView, YearMonthView.DateCell> getCellFactory() Returns the value of `cellFactoryProperty()`. Returns:Callback<YearMonthView, YearMonthView.DateCell> the cell factory

public final Callback<YearMonthView, YearMonthView.DateCell> getCellFactory()

Returns the value of cellFactoryProperty().

Returns:Callback<YearMonthView, YearMonthView.DateCell>: the cell factory

getClickBehaviour back to summary

getClickBehaviour	back to summary
public final YearMonthView.ClickBehaviour getClickBehaviour() Returns the value of `clickBehaviourProperty()`. Returns:YearMonthView.ClickBehaviour the click behaviour

public final YearMonthView.ClickBehaviour getClickBehaviour()

Returns the value of clickBehaviourProperty().

Returns:YearMonthView.ClickBehaviour: the click behaviour

getPropertySheetItems back to summary

getPropertySheetItems	back to summary
public ObservableList<PropertySheet.Item> getPropertySheetItems() Overrides com.calendarfx.view.MonthViewBase.getPropertySheetItems. Doc from com.calendarfx.view.CalendarFXControl.getPropertySheetItems. Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX. Returns:ObservableList<PropertySheet.Item> the property sheet items Annotations @Override

public ObservableList<PropertySheet.Item> getPropertySheetItems()

Overrides com.calendarfx.view.MonthViewBase.getPropertySheetItems.

Doc from com.calendarfx.view.CalendarFXControl.getPropertySheetItems.

Returns a list of property items that can be shown by the PropertySheet of ControlsFX.

Returns:ObservableList<PropertySheet.Item>

the property sheet items

Annotations

@Override

isShowMonth back to summary

isShowMonth	back to summary
public final boolean isShowMonth() Returns the value of `showMonthProperty()`. Returns:boolean true if the month name will be shown

public final boolean isShowMonth()

Returns the value of showMonthProperty().

Returns:boolean: true if the month name will be shown

isShowMonthArrows back to summary

isShowMonthArrows	back to summary
public final boolean isShowMonthArrows() Returns the value of the `showMonthArrowsProperty()`. Returns:boolean true if the arrows will be shown

public final boolean isShowMonthArrows()

Returns the value of the showMonthArrowsProperty().

Returns:boolean: true if the arrows will be shown

isShowTodayButton back to summary

isShowTodayButton	back to summary
public final boolean isShowTodayButton() Returns the value of the `showTodayButtonProperty()`. Returns:boolean true if the button is shown

public final boolean isShowTodayButton()

Returns the value of the showTodayButtonProperty().

Returns:boolean: true if the button is shown

isShowUsageColors back to summary

isShowUsageColors	back to summary
public final boolean isShowUsageColors() Returns the value of the `showUsageColorsProperty()`. Returns:boolean true if the colors will be shown

public final boolean isShowUsageColors()

Returns the value of the showUsageColorsProperty().

Returns:boolean: true if the colors will be shown

isShowYear back to summary

isShowYear	back to summary
public final boolean isShowYear() Returns the value of `showYearProperty()`. Returns:boolean true if the year will be shown

public final boolean isShowYear()

Returns the value of showYearProperty().

Returns:boolean: true if the year will be shown

isShowYearArrows back to summary

isShowYearArrows	back to summary
public final boolean isShowYearArrows() Returns the value of the `showYearArrowsProperty()`. Returns:boolean true if the arrows will be shown

public final boolean isShowYearArrows()

Returns the value of the showYearArrowsProperty().

Returns:boolean: true if the arrows will be shown

setCellFactory back to summary

setCellFactory	back to summary
public final void setCellFactory(Callback<YearMonthView, YearMonthView.DateCell> factory) Sets the value of `cellFactoryProperty()`. Parameters factory:Callback<YearMonthView, YearMonthView.DateCell> the cell factory

public final void setCellFactory(Callback<YearMonthView, YearMonthView.DateCell> factory)

Sets the value of cellFactoryProperty().

Parameters

factory:Callback<YearMonthView, YearMonthView.DateCell>: the cell factory

setClickBehaviour back to summary

setClickBehaviour	back to summary
public final void setClickBehaviour(YearMonthView.ClickBehaviour behaviour) Sets the value of `clickBehaviourProperty()`. Parameters behaviour:YearMonthView.ClickBehaviour the click behaviour

public final void setClickBehaviour(YearMonthView.ClickBehaviour behaviour)

Sets the value of clickBehaviourProperty().

Parameters

behaviour:YearMonthView.ClickBehaviour: the click behaviour

setShowMonth back to summary

setShowMonth	back to summary
public final void setShowMonth(boolean show) Sets the value of `showMonthProperty()`. Parameters show:boolean if true the month will be shown

public final void setShowMonth(boolean show)

Sets the value of showMonthProperty().

Parameters

show:boolean: if true the month will be shown

setShowMonthArrows back to summary

setShowMonthArrows	back to summary
public final void setShowMonthArrows(boolean show) Sets the value of the `showMonthArrowsProperty()`. Parameters show:boolean if true will show the arrows

public final void setShowMonthArrows(boolean show)

Sets the value of the showMonthArrowsProperty().

Parameters

show:boolean: if true will show the arrows

setShowTodayButton back to summary

setShowTodayButton	back to summary
public final void setShowTodayButton(boolean show) Sets the value of the `showTodayButtonProperty()`. Parameters show:boolean if true will show the button

public final void setShowTodayButton(boolean show)

Sets the value of the showTodayButtonProperty().

Parameters

show:boolean: if true will show the button

setShowUsageColors back to summary

setShowUsageColors	back to summary
public final void setShowUsageColors(boolean show) Sets the value of `showUsageColorsProperty()`. Parameters show:boolean if true will show the colors

public final void setShowUsageColors(boolean show)

Sets the value of showUsageColorsProperty().

Parameters

show:boolean: if true will show the colors

setShowYear back to summary

setShowYear	back to summary
public final void setShowYear(boolean show) Sets the value of `showYearProperty()`. Parameters show:boolean if true the year will be shown

public final void setShowYear(boolean show)

Sets the value of showYearProperty().

Parameters

show:boolean: if true the year will be shown

setShowYearArrows back to summary

setShowYearArrows	back to summary
public final void setShowYearArrows(boolean show) Sets the value of the `showYearArrowsProperty()`. Parameters show:boolean if true will show the arrows

public final void setShowYearArrows(boolean show)

Sets the value of the showYearArrowsProperty().

Parameters

show:boolean: if true will show the arrows

showMonthArrowsProperty	back to summary
public final BooleanProperty showMonthArrowsProperty() Shows or hides the arrows to change the month. Returns:BooleanProperty true if the arrows will be shown

showMonthArrowsProperty

back to summary

public final BooleanProperty showMonthArrowsProperty()

Shows or hides the arrows to change the month.

Returns:BooleanProperty: true if the arrows will be shown

showMonthProperty	back to summary
public final BooleanProperty showMonthProperty() Show or hide the name of the month. Returns:BooleanProperty true if the month name will be shown

showMonthProperty

back to summary

public final BooleanProperty showMonthProperty()

Show or hide the name of the month.

Returns:BooleanProperty: true if the month name will be shown

showTodayButtonProperty	back to summary
public final BooleanProperty showTodayButtonProperty() Show or hide a button to quickly go to today's date. Returns:BooleanProperty true if the button will be shown

showTodayButtonProperty

back to summary

public final BooleanProperty showTodayButtonProperty()

Show or hide a button to quickly go to today's date.

Returns:BooleanProperty: true if the button will be shown

showUsageColorsProperty	back to summary
public final BooleanProperty showUsageColorsProperty() Show or hide usage colors that are based on the number of entries on a given date. The image below shows those colors in action: Returns:BooleanProperty true if the usage colors will be shown

showUsageColorsProperty

back to summary

public final BooleanProperty showUsageColorsProperty()

Show or hide usage colors that are based on the number of entries on a given date. The image below shows those colors in action:

Returns:BooleanProperty: true if the usage colors will be shown

showYearArrowsProperty	back to summary
public final BooleanProperty showYearArrowsProperty() Shows or hides the arrows to change the year. Returns:BooleanProperty true if the arrows will be shown

showYearArrowsProperty

back to summary

public final BooleanProperty showYearArrowsProperty()

Shows or hides the arrows to change the year.

Returns:BooleanProperty: true if the arrows will be shown

showYearProperty	back to summary
public final BooleanProperty showYearProperty() Show or hide the year. Returns:BooleanProperty true if the year will be shown

showYearProperty

back to summary

public final BooleanProperty showYearProperty()

Show or hide the year.

Returns:BooleanProperty: true if the year will be shown

com.calendarfx.view back to summary

public final Enum YearMonthView.ClickBehaviour

Class Inheritance

extends Enum<YearMonthView.ClickBehaviour>

java.lang.Object
java.lang.Enum
com.calendarfx.view.YearMonthView.ClickBehaviour

An enumerator to control the behaviour of the control when the user clicks on a date.

See Also: YearMonthView#clickBehaviourProperty()

Field Summary

Modifier and Type	Field and Description
public static final YearMonthView.ClickBehaviour	NONE Do nothing when the user clicks on a date.
public static final YearMonthView.ClickBehaviour	PERFORM_SELECTION A value used to make the control select the date on which the user clicked.
public static final YearMonthView.ClickBehaviour	SHOW_DETAILS A value used to make the control show some kind of dialog or popover to show details about the clicked date.

Constructor Summary

Access	Constructor and Description
private	ClickBehaviour()

Method Summary

Modifier and Type	Method and Description
public static YearMonthView.ClickBehaviour	valueOf(String name)
public static YearMonthView.ClickBehaviour[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NONE	back to summary
public static final YearMonthView.ClickBehaviour NONE Do nothing when the user clicks on a date.

PERFORM_SELECTION	back to summary
public static final YearMonthView.ClickBehaviour PERFORM_SELECTION A value used to make the control select the date on which the user clicked.

SHOW_DETAILS	back to summary
public static final YearMonthView.ClickBehaviour SHOW_DETAILS A value used to make the control show some kind of dialog or popover to show details about the clicked date.

Constructor Detail

ClickBehaviour	back to summary
private ClickBehaviour()

Method Detail

valueOf	back to summary
public static YearMonthView.ClickBehaviour valueOf(String name)

values	back to summary
public static YearMonthView.ClickBehaviour[] values()

Modifier and Type	Method and Description
public final LocalDate	getDate()
public final void	setDate(LocalDate date)
protected void	update(LocalDate date)

public Class YearMonthView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum YearMonthView.ClickBehaviour

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class YearMonthView.DateCell

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail