Top Description Fields Constructors Methods
com.calendarfx.view

public Class DetailedWeekView

extends DayViewBase
Class Inheritance
Imports
com.calendarfx.model.Calendar, impl.com.calendarfx.view.DetailedWeekViewSkin, javafx.beans.binding.Bindings, javafx.beans.property.BooleanProperty, .IntegerProperty, .ReadOnlyObjectProperty, .ReadOnlyObjectWrapper, .SimpleBooleanProperty, .SimpleIntegerProperty, javafx.beans.value.ObservableValue, javafx.collections.ObservableList, javafx.scene.control.Skin, org.controlsfx.control.PropertySheet.Item, java.time.LocalDate, java.util.Optional

A view for showing several week days in a row, normally seven. However the view can be configured to show any number of days. The view consists of several larger sub controls: a week view, an all day view, a calendar header view, a week day header view, and a time scale view. The image below shows the appearance of this view. Detailed Week View
See Also
WeekView

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private final AllDayView
private final CalendarHeaderView
private static final String
private final ReadOnlyObjectWrapper<LocalDate>
private final IntegerProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final ReadOnlyObjectWrapper<LocalDate>
private final WeekTimeScaleView
private static final String
private final WeekDayHeaderView
private final WeekView
Inherited from com.calendarfx.view.DayViewBase:
MILLIS_PER_HOUR

Constructor Summary

AccessConstructor and Description
public
DetailedWeekView()

Constructs a new view with seven days.

public
DetailedWeekView(int
the number of days to show in the view
numberOfDays
)

Constructs a new view with the given number of days.

Method Summary

Modifier and TypeMethod 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").

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 AllDayView

Returns:

the all day view
getAllDayView
()

Returns the all day view child control.

public final CalendarHeaderView

Returns:

the calendar header view control
getCalendarHeaderView
()

Returns the header view control that gets shown when the layout of the control is set to com.calendarfx.view.DateControl.Layout#SWIMLANE .

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 LocalDate

Returns:

the earliest date shown
getStartDate
()

Returns the value of startDateProperty().

public final WeekTimeScaleView

Returns:

the time scale view
getTimeScaleView
()

Returns the time scale child control.

public final WeekDayHeaderView

Returns:

the week day header view
getWeekDayHeaderView
()

Returns the header view that is used to display the names of the week days (Mon, Tue, Wed, ...).

public final WeekView

Returns:

the week view
getWeekView
()

Returns the week view child control.

public void
goBack()

Overrides com.calendarfx.view.DateControl.goBack.

Makes the control go forward in time by removing one or more days from the current date.

public void
goForward()

Overrides com.calendarfx.view.DateControl.goForward.

Makes the control go forward in time by adding one or more days to the current date.

public final boolean

Returns:

true if the view always shows the first day of the week
isAdjustToFirstDayOfWeek
()

Returns the value of adjustToFirstDayOfWeekProperty().

public final boolean

Returns:

true if the all day view will be visible
isShowAllDayView
()

Returns the value of showAllDayViewProperty().

public final boolean

Returns:

true if the scrollbar will be visible
isShowScrollBar
()

Returns the value of showScrollBarProperty().

public final boolean

Returns:

true if the time scale will be shown to the user
isShowTimeScaleView
()

Returns the value of showTimeScaleViewProperty().

public final boolean

Returns:

true if the week day header should be visible
isShowWeekDayHeaderView
()

Returns the value of showWeekDayHeaderViewProperty().

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 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
setShowAllDayView(boolean
if true the all day view will be visible
show
)

Sets the value of showAllDayViewProperty().

public final void
setShowScrollBar(boolean
if true the scrollbar will be visible
show
)

Sets the value of showScrollBarProperty().

public final void
setShowTimeScaleView(boolean
if true the time scale will be shown to the user
show
)

Sets the value of showTimeScaleViewProperty().

public final void
setShowWeekDayHeaderView(boolean
if true the week day header will be visible
show
)

Sets the value of showWeekDayHeaderViewProperty().

public final BooleanProperty

Returns:

true if the all day view will be shown to the user
showAllDayViewProperty
()

A property used to control the visibility of the all day view.

public final BooleanProperty

Returns:

true if the scrollbar should be shown to the user
showScrollBarProperty
()

A property used to control the visibility of the vertical scrollbar.

public final BooleanProperty

Returns:

true if the scale will be visible
showTimeScaleViewProperty
()

A property used to control the visibility of the time scale on the left-hand side.

public final BooleanProperty

Returns:

true if the week day header should be visible
showWeekDayHeaderViewProperty
()

A property used to control the visibility of the week day header.

public final ReadOnlyObjectProperty<LocalDate>

Returns:

the earliest date shown
startDateProperty
()

The earliest date shown by the view.

Inherited from com.calendarfx.view.DayViewBase:
bindearliestTimeUsedPropertyearlyLateHoursStrategyPropertyenableCurrentTimeCirclePropertyenableCurrentTimeMarkerPropertyenableStartAndEndTimesFlipPropertyentryViewAvailabilityEditingBehaviourPropertyentryViewAvailabilityEditingOpacityPropertyentryWidthPercentagePropertygetEarliestTimeUsedgetEarlyLateHoursStrategygetEntryViewAvailabilityEditingBehaviourgetEntryViewAvailabilityEditingOpacitygetEntryWidthPercentagegetGridLineColorgetGridLinesgetGridTypegetHourHeightgetHourHeightCompressedgetHoursLayoutStrategygetInstantAtgetInstantAtgetLassoColorgetLassoEndgetLassoStartgetLatestTimeUsedgetLocationgetLocationgetMaxHourHeightgetMinHourHeightgetOnLassoFinishedgetOverlapResolutionStrategygetScrollTimegetVisibleHoursgetZonedDateTimegetZonedDateTimeAtgetZonedDateTimeAtgetZonedDateTimeEndgetZonedDateTimeMaxgetZonedDateTimeMingetZonedDateTimeStartgridLineColorPropertygridLinesPropertygridTypePropertyhourHeightCompressedPropertyhourHeightPropertyhoursLayoutStrategyPropertyinstallDefaultLassoFinishedBehaviourisEnableCurrentCircleMarkerisEnableCurrentTimeMarkerisEnableStartAndEndTimesFlipisScrollingEnabledisShowCurrentTimeMarkerisShowCurrentTimeTodayMarkerisTrimTimeBoundslassoColorPropertylassoEndPropertylassoStartPropertylatestTimeUsedPropertymaxHourHeightPropertyminHourHeightPropertyonLassoFinishedPropertyoverlapResolutionStrategyPropertyscrollingEnabledPropertyscrollTimePropertysetEarlyLateHoursStrategysetEnableCurrentTimeCirclesetEnableCurrentTimeMarkersetEnableStartAndEndTimesFlipsetEntryViewAvailabilityEditingBehavioursetEntryViewAvailabilityEditingOpacitysetEntryWidthPercentagesetGridLineColorsetGridLinessetGridTypesetHourHeightsetHourHeightCompressedsetHoursLayoutStrategysetLassoColorsetLassoEndsetLassoStartsetMaxHourHeightsetMinHourHeightsetOnLassoFinishedsetOverlapResolutionStrategysetScrollingEnabledsetScrollTimesetTrimTimeBoundssetVisibleHoursshowCurrentTimeMarkerPropertyshowCurrentTimeTodayMarkerPropertytrimTimeBoundsPropertyunbindvisibleHoursProperty

Field Detail

adjustToFirstDayOfWeekback to summary
private final BooleanProperty adjustToFirstDayOfWeek
allDayViewback to summary
private final AllDayView allDayView
calendarHeaderViewback to summary
private final CalendarHeaderView calendarHeaderView
DEFAULT_STYLE_CLASSback to summary
private static final String DEFAULT_STYLE_CLASS
endDateback to summary
private final ReadOnlyObjectWrapper<LocalDate> endDate
numberOfDaysback to summary
private final IntegerProperty numberOfDays
showAllDayViewback to summary
private final BooleanProperty showAllDayView
showScrollBarback to summary
private final BooleanProperty showScrollBar
showTimeScaleViewback to summary
private final BooleanProperty showTimeScaleView
showWeekDayHeaderViewback to summary
private final BooleanProperty showWeekDayHeaderView
startDateback to summary
private final ReadOnlyObjectWrapper<LocalDate> startDate
timeScaleViewback to summary
private final WeekTimeScaleView timeScaleView
WEEK_VIEW_CATEGORYback to summary
private static final String WEEK_VIEW_CATEGORY
weekDayHeaderViewback to summary
private final WeekDayHeaderView weekDayHeaderView
weekViewback to summary
private final WeekView weekView

Constructor Detail

DetailedWeekViewback to summary
public DetailedWeekView()

Constructs a new view with seven days.

DetailedWeekViewback to summary
public DetailedWeekView(int numberOfDays)

Constructs a new view with the given number of days.

Parameters
numberOfDays:int

the number of days to show in the view

Method Detail

adjustToFirstDayOfWeekPropertyback 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

createDefaultSkinback 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
endDatePropertyback to summary
public final ReadOnlyObjectProperty<LocalDate> endDateProperty()

The latest date shown by the view.

Returns:ReadOnlyObjectProperty<LocalDate>

the latest date shown

getAllDayViewback to summary
public final AllDayView getAllDayView()

Returns the all day view child control.

Returns:AllDayView

the all day view

getCalendarHeaderViewback to summary
public final CalendarHeaderView getCalendarHeaderView()

Returns the header view control that gets shown when the layout of the control is set to com.calendarfx.view.DateControl.Layout#SWIMLANE . The header view displays the short name of each calendar that is currently visible.

Returns:CalendarHeaderView

the calendar header view control

See Also
Calendar#getShortName()
getEndDateback to summary
public final LocalDate getEndDate()

Returns the value of endDateProperty().

Returns:LocalDate

the latest date shown

getNumberOfDaysback to summary
public final int getNumberOfDays()

Returns the value of numberOfDaysProperty().

Returns:int

the number of days shown by the view

getPropertySheetItemsback 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
getStartDateback to summary
public final LocalDate getStartDate()

Returns the value of startDateProperty().

Returns:LocalDate

the earliest date shown

getTimeScaleViewback to summary
public final WeekTimeScaleView getTimeScaleView()

Returns the time scale child control.

Returns:WeekTimeScaleView

the time scale view

getWeekDayHeaderViewback to summary
public final WeekDayHeaderView getWeekDayHeaderView()

Returns the header view that is used to display the names of the week days (Mon, Tue, Wed, ...).

Returns:WeekDayHeaderView

the week day header view

getWeekViewback to summary
public final WeekView getWeekView()

Returns the week view child control.

Returns:WeekView

the week view

goBackback to summary
public void goBack()

Overrides com.calendarfx.view.DateControl.goBack.

Doc from com.calendarfx.view.DateControl.goBack.

Makes the control go forward in time by removing one or more days from the current date. Subclasses override this method to adjust it to their needs, e.g. the DetailedWeekView removes the number of days found in DetailedWeekView#getNumberOfDays().

Annotations
@Override
goForwardback to summary
public void goForward()

Overrides com.calendarfx.view.DateControl.goForward.

Doc from com.calendarfx.view.DateControl.goForward.

Makes the control go forward in time by adding one or more days to the current date. Subclasses override this method to adjust it to their needs, e.g. the DetailedWeekView adds the number of days found in DetailedWeekView#getNumberOfDays().

Annotations
@Override
isAdjustToFirstDayOfWeekback 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

isShowAllDayViewback to summary
public final boolean isShowAllDayView()

Returns the value of showAllDayViewProperty().

Returns:boolean

true if the all day view will be visible

isShowScrollBarback to summary
public final boolean isShowScrollBar()

Returns the value of showScrollBarProperty().

Returns:boolean

true if the scrollbar will be visible

isShowTimeScaleViewback to summary
public final boolean isShowTimeScaleView()

Returns the value of showTimeScaleViewProperty().

Returns:boolean

true if the time scale will be shown to the user

isShowWeekDayHeaderViewback to summary
public final boolean isShowWeekDayHeaderView()

Returns the value of showWeekDayHeaderViewProperty().

Returns:boolean

true if the week day header should be visible

numberOfDaysPropertyback 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

setAdjustToFirstDayOfWeekback 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

setNumberOfDaysback 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

setShowAllDayViewback to summary
public final void setShowAllDayView(boolean show)

Sets the value of showAllDayViewProperty().

Parameters
show:boolean

if true the all day view will be visible

setShowScrollBarback to summary
public final void setShowScrollBar(boolean show)

Sets the value of showScrollBarProperty().

Parameters
show:boolean

if true the scrollbar will be visible

setShowTimeScaleViewback to summary
public final void setShowTimeScaleView(boolean show)

Sets the value of showTimeScaleViewProperty().

Parameters
show:boolean

if true the time scale will be shown to the user

setShowWeekDayHeaderViewback to summary
public final void setShowWeekDayHeaderView(boolean show)

Sets the value of showWeekDayHeaderViewProperty().

Parameters
show:boolean

if true the week day header will be visible

showAllDayViewPropertyback to summary
public final BooleanProperty showAllDayViewProperty()

A property used to control the visibility of the all day view. The all day view displays those calendar entries that do not have a specific start and end time but that are valid for the entire day or day range.

Returns:BooleanProperty

true if the all day view will be shown to the user

showScrollBarPropertyback to summary
public final BooleanProperty showScrollBarProperty()

A property used to control the visibility of the vertical scrollbar.

Returns:BooleanProperty

true if the scrollbar should be shown to the user

showTimeScaleViewPropertyback to summary
public final BooleanProperty showTimeScaleViewProperty()

A property used to control the visibility of the time scale on the left-hand side. The timescale displays the time of day.

Returns:BooleanProperty

true if the scale will be visible

showWeekDayHeaderViewPropertyback to summary
public final BooleanProperty showWeekDayHeaderViewProperty()

A property used to control the visibility of the week day header. The header displays the weekday names (Mo., Tu., ....).

Returns:BooleanProperty

true if the week day header should be visible

startDatePropertyback to summary
public final ReadOnlyObjectProperty<LocalDate> startDateProperty()

The earliest date shown by the view.

Returns:ReadOnlyObjectProperty<LocalDate>

the earliest date shown