Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WeekView.WeekDayParameter The parameter object for the week day view factory.

Modifier and Type	Field and Description
private final BooleanProperty	adjustToFirstDayOfWeek
private static final String	DEFAULT_STYLE_CLASS
private final ReadOnlyObjectWrapper<LocalDate>	endDate
private final IntegerProperty	numberOfDays
private final ObjectProperty<Callback<WeekView, Region>>	separatorFactory
private final ReadOnlyObjectWrapper<LocalDate>	startDate
private static final String	WEEK_VIEW_CATEGORY
private final ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>>	weekDayViewFactory
private final ObservableList<WeekDayView>	weekDayViews

Constructor Summary

Access	Constructor and Description
public	WeekView() Constructs a new week view with seven days.
public	WeekView(int the number of days (day views) numberOfDays) Constructs a new week view with the given number of days.

Method Summary

Modifier and Type	Method and Description
public final BooleanProperty	Returns: true if the view always shows the first day of the week adjustToFirstDayOfWeekProperty() A flag used to indicate that the view should always show the first day of the week (e.g. "Monday") at its beginning even if the `dateProperty()` is set to another day (e.g. "Thursday").
private LocalDate	calculateStartDate()
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public final ReadOnlyObjectProperty<LocalDate>	Returns: the latest date shown endDateProperty() The latest date shown by the view.
public final LocalDate	Returns: the latest date shown getEndDate() Returns the value of `endDateProperty()`.
public final int	Returns: the number of days shown by the view getNumberOfDays() Returns the value of `numberOfDaysProperty()`.
public ObservableList<PropertySheet.Item>	getPropertySheetItems() Overrides com.calendarfx.view.DayViewBase.getPropertySheetItems. Returns a list of property items that can be shown by the `PropertySheet` of ControlsFX.
public final Callback<WeekView, Region>	getSeparatorFactory()
public final LocalDate	Returns: the earliest date shown getStartDate() Returns the value of `startDateProperty()`.
private WeekDayView	getWeekDayViewAt(double x)
public final Callback<WeekView.WeekDayParameter, WeekDayView>	Returns: the week day view factory getWeekDayViewFactory() Returns the value of `weekDayViewFactoryProperty()`.
public final ObservableList<WeekDayView>	Returns: the currently used list of week day views (please note that this list is very volatile and will be updated very often. getWeekDayViews() A list of the `WeekDayView` instances that the view created via the factory.
public ZonedDateTime	getZonedDateTimeAt(double the x coordinate of the input event x, double the y coordinate of the input event y, ZoneId the zoneID for which we query the time zoneId) Overrides com.calendarfx.view.DayViewBase.getZonedDateTimeAt. Implements com.calendarfx.view.ZonedDateTimeProvider.getZonedDateTimeAt. Returns the time at the given location.
public final boolean	Returns: true if the view always shows the first day of the week isAdjustToFirstDayOfWeek() Returns the value of `adjustToFirstDayOfWeekProperty()`.
public final IntegerProperty	Returns: the number of days shown by the view numberOfDaysProperty() Stores the number of days that will be shown by this view.
public final ObjectProperty<Callback<WeekView, Region>>	Returns: the separator factory separatorFactoryProperty() A factory used for creating (optional) vertical separators between the week days.
public final void	setAdjustToFirstDayOfWeek(boolean if true the view will always show the first day of the week adjust) Sets the value of `adjustToFirstDayOfWeekProperty()`.
public final void	setNumberOfDays(int the new number of days shown by the view number) Sets the value of `numberOfDaysProperty()`.
public final void	setSeparatorFactory(Callback<WeekView, Region> separatorFactory)
public final void	setWeekDayViewFactory(Callback<WeekView.WeekDayParameter, WeekDayView> the new factory factory) Sets the value of `weekDayViewFactoryProperty()`.
public final ReadOnlyObjectProperty<LocalDate>	Returns: the earliest date shown startDateProperty() The earliest date shown by the view.
private void	updateStartAndEndDates()
public final ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>>	Returns: the week day view factory weekDayViewFactoryProperty() A factory used for creating instances of `WeekDayView` on the fly as required.

Inherited from com.calendarfx.view.DayViewBase:: bind earliestTimeUsedProperty earlyLateHoursStrategyProperty enableCurrentTimeCircleProperty enableCurrentTimeMarkerProperty enableStartAndEndTimesFlipProperty entryViewAvailabilityEditingBehaviourProperty entryViewAvailabilityEditingOpacityProperty entryWidthPercentageProperty getEarliestTimeUsed getEarlyLateHoursStrategy getEntryViewAvailabilityEditingBehaviour getEntryViewAvailabilityEditingOpacity getEntryWidthPercentage getGridLineColor getGridLines getGridType getHourHeight getHourHeightCompressed getHoursLayoutStrategy getInstantAt getInstantAt getLassoColor getLassoEnd getLassoStart getLatestTimeUsed getLocation getLocation getMaxHourHeight getMinHourHeight getOnLassoFinished getOverlapResolutionStrategy getScrollTime getVisibleHours getZonedDateTime getZonedDateTimeAt getZonedDateTimeEnd getZonedDateTimeMax getZonedDateTimeMin getZonedDateTimeStart gridLineColorProperty gridLinesProperty gridTypeProperty hourHeightCompressedProperty hourHeightProperty hoursLayoutStrategyProperty installDefaultLassoFinishedBehaviour isEnableCurrentCircleMarker isEnableCurrentTimeMarker isEnableStartAndEndTimesFlip isScrollingEnabled isShowCurrentTimeMarker isShowCurrentTimeTodayMarker isTrimTimeBounds lassoColorProperty lassoEndProperty lassoStartProperty latestTimeUsedProperty maxHourHeightProperty minHourHeightProperty onLassoFinishedProperty overlapResolutionStrategyProperty scrollingEnabledProperty scrollTimeProperty setEarlyLateHoursStrategy setEnableCurrentTimeCircle setEnableCurrentTimeMarker setEnableStartAndEndTimesFlip setEntryViewAvailabilityEditingBehaviour setEntryViewAvailabilityEditingOpacity setEntryWidthPercentage setGridLineColor setGridLines setGridType setHourHeight setHourHeightCompressed setHoursLayoutStrategy setLassoColor setLassoEnd setLassoStart setMaxHourHeight setMinHourHeight setOnLassoFinished setOverlapResolutionStrategy setScrollingEnabled setScrollTime setTrimTimeBounds setVisibleHours showCurrentTimeMarkerProperty showCurrentTimeTodayMarkerProperty trimTimeBoundsProperty unbind visibleHoursProperty

Field Detail

adjustToFirstDayOfWeek	back to summary
private final BooleanProperty adjustToFirstDayOfWeek

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

endDate	back to summary
private final ReadOnlyObjectWrapper<LocalDate> endDate

numberOfDays	back to summary
private final IntegerProperty numberOfDays

separatorFactory	back to summary
private final ObjectProperty<Callback<WeekView, Region>> separatorFactory

startDate	back to summary
private final ReadOnlyObjectWrapper<LocalDate> startDate

WEEK_VIEW_CATEGORY	back to summary
private static final String WEEK_VIEW_CATEGORY

weekDayViewFactory	back to summary
private final ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>> weekDayViewFactory

weekDayViews	back to summary
private final ObservableList<WeekDayView> weekDayViews

Constructor Detail

WeekView	back to summary
public WeekView() Constructs a new week view with seven days.

WeekView	back to summary
public WeekView(int numberOfDays) Constructs a new week view with the given number of days. Parameters numberOfDays:int the number of days (day views)

WeekView

back to summary

public WeekView(int numberOfDays)

Constructs a new week view with the given number of days.

Parameters

numberOfDays:int: the number of days (day views)

Method Detail

adjustToFirstDayOfWeekProperty back to summary

adjustToFirstDayOfWeekProperty	back to summary
public final BooleanProperty adjustToFirstDayOfWeekProperty() A flag used to indicate that the view should always show the first day of the week (e.g. "Monday") at its beginning even if the `dateProperty()` is set to another day (e.g. "Thursday"). Returns:BooleanProperty true if the view always shows the first day of the week

public final BooleanProperty adjustToFirstDayOfWeekProperty()

A flag used to indicate that the view should always show the first day of the week (e.g. "Monday") at its beginning even if the dateProperty() is set to another day (e.g. "Thursday").

Returns:BooleanProperty: true if the view always shows the first day of the week

calculateStartDate	back to summary
private LocalDate calculateStartDate()

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

endDateProperty	back to summary
public final ReadOnlyObjectProperty<LocalDate> endDateProperty() The latest date shown by the view. Returns:ReadOnlyObjectProperty<LocalDate> the latest date shown

endDateProperty

back to summary

public final ReadOnlyObjectProperty<LocalDate> endDateProperty()

The latest date shown by the view.

Returns:ReadOnlyObjectProperty<LocalDate>: the latest date shown

getEndDate back to summary

getEndDate	back to summary
public final LocalDate getEndDate() Returns the value of `endDateProperty()`. Returns:LocalDate the latest date shown

public final LocalDate getEndDate()

Returns the value of endDateProperty().

Returns:LocalDate: the latest date shown

getNumberOfDays back to summary

getNumberOfDays	back to summary
public final int getNumberOfDays() Returns the value of `numberOfDaysProperty()`. Returns:int the number of days shown by the view

public final int getNumberOfDays()

Returns the value of numberOfDaysProperty().

Returns:int: the number of days shown by the view

getPropertySheetItems back to summary

getPropertySheetItems	back to summary
public ObservableList<PropertySheet.Item> getPropertySheetItems() Overrides com.calendarfx.view.DayViewBase.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.DayViewBase.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

getSeparatorFactory	back to summary
public final Callback<WeekView, Region> getSeparatorFactory()

getStartDate back to summary

getStartDate	back to summary
public final LocalDate getStartDate() Returns the value of `startDateProperty()`. Returns:LocalDate the earliest date shown

public final LocalDate getStartDate()

Returns the value of startDateProperty().

Returns:LocalDate: the earliest date shown

getWeekDayViewAt	back to summary
private WeekDayView getWeekDayViewAt(double x)

getWeekDayViewFactory back to summary

getWeekDayViewFactory	back to summary
public final Callback<WeekView.WeekDayParameter, WeekDayView> getWeekDayViewFactory() Returns the value of `weekDayViewFactoryProperty()`. Returns:Callback<WeekView.WeekDayParameter, WeekDayView> the week day view factory

public final Callback<WeekView.WeekDayParameter, WeekDayView> getWeekDayViewFactory()

Returns the value of weekDayViewFactoryProperty().

Returns:Callback<WeekView.WeekDayParameter, WeekDayView>: the week day view factory

getWeekDayViews back to summary

getWeekDayViews	back to summary
public final ObservableList<WeekDayView> getWeekDayViews() A list of the `WeekDayView` instances that the view created via the factory. Returns:ObservableList<WeekDayView> the currently used list of week day views (please note that this list is very volatile and will be updated very often. See Also `setWeekDayViewFactory(Callback)`

public final ObservableList<WeekDayView> getWeekDayViews()

A list of the WeekDayView instances that the view created via the factory.

Returns:ObservableList<WeekDayView>: the currently used list of week day views (please note that this list is very volatile and will be updated very often.
See Also: setWeekDayViewFactory(Callback)

getZonedDateTimeAt	back to summary
public ZonedDateTime getZonedDateTimeAt(double x, double y, ZoneId zoneId) Overrides com.calendarfx.view.DayViewBase.getZonedDateTimeAt. Implements com.calendarfx.view.ZonedDateTimeProvider.getZonedDateTimeAt. Doc from com.calendarfx.view.ZonedDateTimeProvider.getZonedDateTimeAt. Returns the time at the given location. Parameters x:double the x coordinate of the input event y:double the y coordinate of the input event zoneId:ZoneId the zoneID for which we query the time Returns:ZonedDateTime the time at the given location Annotations @Override

getZonedDateTimeAt

back to summary

public ZonedDateTime getZonedDateTimeAt(double x, double y, ZoneId zoneId)

Overrides com.calendarfx.view.DayViewBase.getZonedDateTimeAt.

Implements com.calendarfx.view.ZonedDateTimeProvider.getZonedDateTimeAt.

Doc from com.calendarfx.view.ZonedDateTimeProvider.getZonedDateTimeAt.

Returns the time at the given location.

Parameters

x:double: the x coordinate of the input event
y:double: the y coordinate of the input event
zoneId:ZoneId: the zoneID for which we query the time

Returns:ZonedDateTime

the time at the given location

Annotations

@Override

isAdjustToFirstDayOfWeek back to summary

isAdjustToFirstDayOfWeek	back to summary
public final boolean isAdjustToFirstDayOfWeek() Returns the value of `adjustToFirstDayOfWeekProperty()`. Returns:boolean true if the view always shows the first day of the week

public final boolean isAdjustToFirstDayOfWeek()

Returns the value of adjustToFirstDayOfWeekProperty().

Returns:boolean: true if the view always shows the first day of the week

numberOfDaysProperty back to summary

numberOfDaysProperty	back to summary
public final IntegerProperty numberOfDaysProperty() Stores the number of days that will be shown by this view. This value will be 1 if the view is used in combination with the `DayView` and 7 if used together with the `DetailedWeekView`. Returns:IntegerProperty the number of days shown by the view

public final IntegerProperty numberOfDaysProperty()

Stores the number of days that will be shown by this view. This value will be 1 if the view is used in combination with the DayView and 7 if used together with the DetailedWeekView.

Returns:IntegerProperty: the number of days shown by the view

separatorFactoryProperty	back to summary
public final ObjectProperty<Callback<WeekView, Region>> separatorFactoryProperty() A factory used for creating (optional) vertical separators between the week days. Returns:ObjectProperty<Callback<WeekView, Region>> the separator factory

separatorFactoryProperty

back to summary

public final ObjectProperty<Callback<WeekView, Region>> separatorFactoryProperty()

A factory used for creating (optional) vertical separators between the week days.

Returns:ObjectProperty<Callback<WeekView, Region>>: the separator factory

setAdjustToFirstDayOfWeek back to summary

setAdjustToFirstDayOfWeek	back to summary
public final void setAdjustToFirstDayOfWeek(boolean adjust) Sets the value of `adjustToFirstDayOfWeekProperty()`. Parameters adjust:boolean if true the view will always show the first day of the week

public final void setAdjustToFirstDayOfWeek(boolean adjust)

Sets the value of adjustToFirstDayOfWeekProperty().

Parameters

adjust:boolean: if true the view will always show the first day of the week

setNumberOfDays back to summary

setNumberOfDays	back to summary
public final void setNumberOfDays(int number) Sets the value of `numberOfDaysProperty()`. Parameters number:int the new number of days shown by the view

public final void setNumberOfDays(int number)

Sets the value of numberOfDaysProperty().

Parameters

number:int: the new number of days shown by the view

setSeparatorFactory	back to summary
public final void setSeparatorFactory(Callback<WeekView, Region> separatorFactory)

setWeekDayViewFactory back to summary

setWeekDayViewFactory	back to summary
public final void setWeekDayViewFactory(Callback<WeekView.WeekDayParameter, WeekDayView> factory) Sets the value of `weekDayViewFactoryProperty()`. Parameters factory:Callback<WeekView.WeekDayParameter, WeekDayView> the new factory

public final void setWeekDayViewFactory(Callback<WeekView.WeekDayParameter, WeekDayView> factory)

Sets the value of weekDayViewFactoryProperty().

Parameters

factory:Callback<WeekView.WeekDayParameter, WeekDayView>: the new factory

startDateProperty	back to summary
public final ReadOnlyObjectProperty<LocalDate> startDateProperty() The earliest date shown by the view. Returns:ReadOnlyObjectProperty<LocalDate> the earliest date shown

startDateProperty

back to summary

public final ReadOnlyObjectProperty<LocalDate> startDateProperty()

The earliest date shown by the view.

Returns:ReadOnlyObjectProperty<LocalDate>: the earliest date shown

updateStartAndEndDates	back to summary
private void updateStartAndEndDates()

weekDayViewFactoryProperty back to summary

weekDayViewFactoryProperty	back to summary
public final ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>> weekDayViewFactoryProperty() A factory used for creating instances of `WeekDayView` on the fly as required. Returns:ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>> the week day view factory

public final ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>> weekDayViewFactoryProperty()

A factory used for creating instances of WeekDayView on the fly as required.

Returns:ObjectProperty<Callback<WeekView.WeekDayParameter, WeekDayView>>: the week day view factory

com.calendarfx.view back to summary

public final Class WeekView.WeekDayParameter

Class Inheritance

extends Object

java.lang.Object
com.calendarfx.view.WeekView.WeekDayParameter

The parameter object for the week day view factory.

See Also: weekDayViewFactoryProperty()

Field Summary

Modifier and Type	Field and Description
private final WeekView	weekView

Constructor Summary

Access	Constructor and Description
public	WeekDayParameter(WeekView the week view for which the week day view will be used weekView) Constructs a new parameter object.

Method Summary

Modifier and Type	Method and Description
public WeekView	Returns: the week view getWeekView() Returns the week view where the day view will be used.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

weekView	back to summary
private final WeekView weekView

Constructor Detail

WeekDayParameter	back to summary
public WeekDayParameter(WeekView weekView) Constructs a new parameter object. Parameters weekView:WeekView the week view for which the week day view will be used

WeekDayParameter

back to summary

public WeekDayParameter(WeekView weekView)

Constructs a new parameter object.

Parameters

weekView:WeekView: the week view for which the week day view will be used

Method Detail

getWeekView	back to summary
public WeekView getWeekView() Returns the week view where the day view will be used. Returns:WeekView the week view

getWeekView

back to summary

public WeekView getWeekView()

Returns the week view where the day view will be used.

Returns:WeekView: the week view

public Class WeekView

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class WeekView.WeekDayParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail