Top Description Inners Fields Constructors Methods
com.calendarfx.view

public Class AllDayView

extends DateControl
implements ZonedDateTimeProvider
Class Inheritance
All Implemented Interfaces
com.calendarfx.view.ZonedDateTimeProvider
Imports
com.calendarfx.model.Entry, impl.com.calendarfx.view.AllDayViewSkin, impl.com.calendarfx.view.util.Util, javafx.beans.property.BooleanProperty, .DoubleProperty, .IntegerProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleIntegerProperty, .SimpleObjectProperty, javafx.beans.value.ObservableValue, javafx.collections.ObservableList, javafx.css.CssMetaData, .StyleConverter, .Styleable, .StyleableDoubleProperty, .StyleableObjectProperty, .StyleableProperty, javafx.geometry.Insets, javafx.scene.control.Skin, javafx.scene.layout.Region, javafx.util.Callback, org.controlsfx.control.PropertySheet.Item, java.time.LocalDate, .LocalTime, .ZoneId, .ZonedDateTime, java.util.ArrayList, .Collections, .List, .Optional

A date control used on top of a DayView or a DetailedWeekView for showing "full day" calendar entries. This view can be configured to span a given number of days. One day is sufficient when used with a DayView and seven days when used with a DetailedWeekView. All Day View
See Also
Entry#isFullDay()

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private static final String
private static final String
private StyleableDoubleProperty
private final ObjectProperty<Callback<Entry<?>, AllDayEntryView>>
private StyleableObjectProperty<Insets>
private final IntegerProperty
private StyleableDoubleProperty
private StyleableDoubleProperty
private final ObjectProperty<Callback<AllDayView, Region>>
Inherited from com.calendarfx.view.DateControl:
usagePolicy

Constructor Summary

AccessConstructor and Description
public
AllDayView(int
the number of days to be shown by this view
numberOfDays
)

Constructs a new view for the given number of days.

public
AllDayView()

Constructs a new view for seven 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").

public final DoubleProperty

Returns:

the spacing between columns in pixels
columnSpacingProperty
()

Stores the spacing between columns in the view.

protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

public final ObjectProperty<Callback<Entry<?>, AllDayEntryView>>

Returns:

the entry view factory
entryViewFactoryProperty
()

A callback used for producing views for entries.

public final ObjectProperty<Insets>

Returns:

insets for extra padding
extraPaddingProperty
()

Extra padding to be used inside of the view above and below the full day entries.

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.

public final double

Returns:

the row spacing in pixels
getColumnSpacing
()

Returns the value of columnSpacingProperty().

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

Overrides javafx.scene.control.Control.getControlCssMetaData.

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

public final Callback<Entry<?>, AllDayEntryView>

Returns:

the entry view factory callback
getEntryViewFactory
()

Returns the value of entryViewFactoryProperty().

public final Insets

Returns:

extra padding insets
getExtraPadding
()

Returns the value of extraPaddingProperty().

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.DateControl.getPropertySheetItems.

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

public final double

Returns:

the row height
getRowHeight
()

Returns the value of rowHeightProperty().

public final double

Returns:

the row spacing in pixels
getRowSpacing
()

Returns the value of rowSpacingProperty().

public final Callback<AllDayView, Region>
public final 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
)

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 DoubleProperty

Returns:

the row height property
rowHeightProperty
()

The height for each row shown by the view.

public final DoubleProperty

Returns:

the spacing between rows in pixels
rowSpacingProperty
()

Stores the spacing between rows in the view.

public final ObjectProperty<Callback<AllDayView, Region>>

Returns:

the separator factory
separatorFactoryProperty
()

A factory used for creating (optional) vertical separators between the all day 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
setColumnSpacing(double
the space between columns in pixel
space
)

Sets the value of columnSpacingProperty().

public final void
setEntryViewFactory(Callback<Entry<?>, AllDayEntryView>
the new entry view factory
factory
)

Sets the value of entryViewFactoryProperty().

public final void
setExtraPadding(Insets
padding insets
padding
)

Sets the value of extraPaddingProperty().

public final void
setNumberOfDays(int
the new number of days shown by the view
number
)

Sets the value of numberOfDaysProperty().

public final void
setRowHeight(double
the new row height
height
)

Sets the value of the rowHeightProperty().

public final void
setRowSpacing(double
the space between rows in pixel
space
)

Sets the value of rowSpacingProperty().

public final void
Inherited from com.calendarfx.view.DateControl:
availabilityCalendarPropertyavailabilityFillPropertyavailabilityGridPropertybindcalendarSourceFactoryPropertycalendarsPropertyclearSelectioncontextMenuCallbackPropertycreateCalendarSourcecreateEntryAtcreateEntryAtcreateEntryAtcreateEntryClickCountPropertydateDetailsCallbackPropertydatePropertydefaultCalendarProviderPropertydeselectdraggedEntryPropertyeditAvailabilityPropertyeditEntryeditEntryenableHyperlinksPropertyenableTimeZoneSupportPropertyendTimePropertyentryContextMenuCallbackPropertyentryDetailsCallbackPropertyentryDetailsPopOverContentCallbackPropertyentryEditPolicyPropertyentryFactoryPropertyfindEntryViewgetAvailabilityCalendargetAvailabilityFillgetAvailabilityGridgetAvailableZoneIdsgetBoundDateControlsgetCalendarAtgetCalendarsgetCalendarSourceFactorygetCalendarSourcesgetCalendarVisibilityMapgetCalendarVisibilityPropertygetContextMenuCallbackgetCreateEntryClickCountgetDategetDateDetailsCallbackgetDefaultCalendarProvidergetDraggedEntrygetEndTimegetEntryContextMenuCallbackgetEntryDetailsCallbackgetEntryDetailsPopOverContentCallbackgetEntryEditPolicygetEntryFactorygetFirstDayOfWeekgetLayoutgetRequestedTimegetSelectionModegetSelectionsgetStartTimegetTimegetTodaygetUsagePolicygetVirtualGridgetWeekendDaysgetWeekFieldsgetZonedDateTimegetZoneIdgoBackgoForwardgoTodayisCalendarVisibleisEditAvailabilityisEnableHyperlinksisEnableTimeZoneSupportisShowDetailsUponEntryCreationisShowNoonMarkerisShowTodayisSuspendUpdateslayoutPropertyrefreshDatarequestedTimePropertyselectselectionModePropertysetAvailabilityCalendarsetAvailabilityFillsetAvailabilityGridsetCalendarSourceFactorysetCalendarVisibilitysetContextMenuCallbacksetCreateEntryClickCountsetDatesetDateDetailsCallbacksetDefaultCalendarProvidersetDraggedEntrysetEditAvailabilitysetEnableHyperlinkssetEnableTimeZoneSupportsetEndTimesetEntryContextMenuCallbacksetEntryDetailsCallbacksetEntryDetailsPopOverContentCallbacksetEntryEditPolicysetEntryFactorysetLayoutsetRequestedTimesetSelectionModesetShowDetailsUponEntryCreationsetShowNoonMarkersetShowTodaysetStartTimesetSuspendUpdatessetTimesetTodaysetUsagePolicysetVirtualGridsetWeekFieldssetZoneIdshowDateDetailsshowDetailsUponEntryCreationPropertyshowEntryshowNoonMarkerPropertyshowTodayPropertystartTimePropertysuspendUpdatesPropertytimePropertytodayPropertyunbindunbindAllusagePolicyPropertyvirtualGridPropertyvisibleLayersPropertyweekFieldsPropertyzoneIdProperty

Field Detail

adjustToFirstDayOfWeekback to summary
private final BooleanProperty adjustToFirstDayOfWeek
ALL_DAY_VIEWback to summary
private static final String ALL_DAY_VIEW
ALL_DAY_VIEW_CATEGORYback to summary
private static final String ALL_DAY_VIEW_CATEGORY
columnSpacingback to summary
private StyleableDoubleProperty columnSpacing
entryViewFactoryback to summary
private final ObjectProperty<Callback<Entry<?>, AllDayEntryView>> entryViewFactory
extraPaddingback to summary
private StyleableObjectProperty<Insets> extraPadding
numberOfDaysback to summary
private final IntegerProperty numberOfDays
rowHeightback to summary
private StyleableDoubleProperty rowHeight
rowSpacingback to summary
private StyleableDoubleProperty rowSpacing
separatorFactoryback to summary
private final ObjectProperty<Callback<AllDayView, Region>> separatorFactory

Constructor Detail

AllDayViewback to summary
public AllDayView(int numberOfDays)

Constructs a new view for the given number of days.

Parameters
numberOfDays:int

the number of days to be shown by this view

AllDayViewback to summary
public AllDayView()

Constructs a new view for seven days.

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"). The adjustment is normally needed if the view is used in combination with the DetailedWeekView. It is not needed if the view is used together with the DayView.

Returns:BooleanProperty

true if the view always shows the first day of the week

columnSpacingPropertyback to summary
public final DoubleProperty columnSpacingProperty()

Stores the spacing between columns in the view.

Returns:DoubleProperty

the spacing between columns in pixels

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
entryViewFactoryPropertyback to summary
public final ObjectProperty<Callback<Entry<?>, AllDayEntryView>> entryViewFactoryProperty()

A callback used for producing views for entries. The views have to be of type AllDayEntryView.

Returns:ObjectProperty<Callback<Entry<?>, AllDayEntryView>>

the entry view factory

extraPaddingPropertyback to summary
public final ObjectProperty<Insets> extraPaddingProperty()

Extra padding to be used inside of the view above and below the full day entries. This is required as the regular padding is already used for other styling purposes.

Returns:ObjectProperty<Insets>

insets for extra padding

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

Hides javafx.scene.control.Control.getClassCssMetaData.

Doc from 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

getColumnSpacingback to summary
public final double getColumnSpacing()

Returns the value of columnSpacingProperty().

Returns:double

the row spacing in pixels

getControlCssMetaDataback to summary
public final 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.

Returns:List<CssMetaData<? extends Styleable, ?>>

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

Annotations
@Override
getEntryViewFactoryback to summary
public final Callback<Entry<?>, AllDayEntryView> getEntryViewFactory()

Returns the value of entryViewFactoryProperty().

Returns:Callback<Entry<?>, AllDayEntryView>

the entry view factory callback

getExtraPaddingback to summary
public final Insets getExtraPadding()

Returns the value of extraPaddingProperty().

Returns:Insets

extra padding insets

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.DateControl.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
getRowHeightback to summary
public final double getRowHeight()

Returns the value of rowHeightProperty().

Returns:double

the row height

getRowSpacingback to summary
public final double getRowSpacing()

Returns the value of rowSpacingProperty().

Returns:double

the row spacing in pixels

getSeparatorFactoryback to summary
public final Callback<AllDayView, Region> getSeparatorFactory()
getZonedDateTimeAtback to summary
public final ZonedDateTime getZonedDateTimeAt(double x, double y, ZoneId zoneId)

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
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

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

rowHeightPropertyback to summary
public final DoubleProperty rowHeightProperty()

The height for each row shown by the view. This value determines the total height of the view.

Returns:DoubleProperty

the row height property

rowSpacingPropertyback to summary
public final DoubleProperty rowSpacingProperty()

Stores the spacing between rows in the view.

Returns:DoubleProperty

the spacing between rows in pixels

separatorFactoryPropertyback to summary
public final ObjectProperty<Callback<AllDayView, Region>> separatorFactoryProperty()

A factory used for creating (optional) vertical separators between the all day view.

Returns:ObjectProperty<Callback<AllDayView, Region>>

the separator factory

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

setColumnSpacingback to summary
public final void setColumnSpacing(double space)

Sets the value of columnSpacingProperty().

Parameters
space:double

the space between columns in pixel

setEntryViewFactoryback to summary
public final void setEntryViewFactory(Callback<Entry<?>, AllDayEntryView> factory)

Sets the value of entryViewFactoryProperty().

Parameters
factory:Callback<Entry<?>, AllDayEntryView>

the new entry view factory

setExtraPaddingback to summary
public final void setExtraPadding(Insets padding)

Sets the value of extraPaddingProperty().

Parameters
padding:Insets

padding insets

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

setRowHeightback to summary
public final void setRowHeight(double height)

Sets the value of the rowHeightProperty().

Parameters
height:double

the new row height

setRowSpacingback to summary
public final void setRowSpacing(double space)

Sets the value of rowSpacingProperty().

Parameters
space:double

the space between rows in pixel

setSeparatorFactoryback to summary
public final void setSeparatorFactory(Callback<AllDayView, Region> separatorFactory)
com.calendarfx.view back to summary

private Class AllDayView.StyleableProperties

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final CssMetaData<AllDayView, Number>
private static final CssMetaData<AllDayView, Insets>
private static final CssMetaData<AllDayView, Number>
private static final CssMetaData<AllDayView, Number>
private static final List<CssMetaData<? extends Styleable, ?>>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

COLUMN_SPACINGback to summary
private static final CssMetaData<AllDayView, Number> COLUMN_SPACING
EXTRA_PADDINGback to summary
private static final CssMetaData<AllDayView, Insets> EXTRA_PADDING
ROW_HEIGHTback to summary
private static final CssMetaData<AllDayView, Number> ROW_HEIGHT
ROW_SPACINGback to summary
private static final CssMetaData<AllDayView, Number> ROW_SPACING
STYLEABLESback to summary
private static final List<CssMetaData<? extends Styleable, ?>> STYLEABLES

Constructor Detail

StyleablePropertiesback to summary
private StyleableProperties()