Top Description Fields Constructors Methods
com.calendarfx.view

public Class TimeScaleView

extends DayViewBase
Class Inheritance
Known Direct Subclasses
com.calendarfx.view.WeekTimeScaleView
Imports
impl.com.calendarfx.view.TimeScaleViewSkin, javafx.beans.property.ObjectProperty, .SimpleObjectProperty, javafx.scene.control.Skin, java.time.LocalDateTime, java.time.format.DateTimeFormatter, .FormatStyle, java.util.function.Function
A control used for displaying a vertical time scale. Time Scale View

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<DateTimeFormatter>
dateFormatter

private final ObjectProperty<Function<LocalDateTime, String>>
dateStyleProvider

private static final Function<LocalDateTime, String>
DEFAULT_STYLE_PROVIDER

private final ObjectProperty<DateTimeFormatter>
timeFormatter

private final ObjectProperty<Function<LocalDateTime, String>>
timeStyleProvider

Inherited from com.calendarfx.view.DayViewBase:
MILLIS_PER_HOUR

Constructor Summary

AccessConstructor and Description
public
TimeScaleView()

Constructs a new scale view.

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

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

public final ObjectProperty<DateTimeFormatter>

Returns:

the date formatter.
dateFormatterProperty()

Gets the DateTimeFormatter instance, which is used to provide the format on the TimeScale for those labels that are displaying a date.

public ObjectProperty<Function<LocalDateTime, String>>

Returns:

the style function for date labels
dateStyleProviderProperty()

Gets the function, which is used to provide additional styling for the labels used to display dates.

public final DateTimeFormatter

Returns:

the date formatter
getDateFormatter()

Returns the value of dateFormatterProperty()

public Function<LocalDateTime, String>

Returns:

the style function for date labels
getDateStyleProvider()

Returns the value of dateStyleProviderProperty().

public final DateTimeFormatter

Returns:

the time of day formatter
getTimeFormatter()

Returns the value of timeFormatterProperty()

public Function<LocalDateTime, String>

Returns:

the style provider
getTimeStyleProvider()

Returns the value of timeStyleProviderProperty().

public final void
setDateFormatter(DateTimeFormatter
the date formatter, not null
formatter)

Sets the value of dateFormatterProperty()

public void
setDateStyleProvider(Function<LocalDateTime, String>
date labels style provider, not null
styleProvider)

Sets the value of dateStyleProviderProperty().

public void
setTimeFormatter(DateTimeFormatter
the time of day formatter, not null
formatter)

Sets the value of timeFormatterProperty()

public void
setTimeStyleProvider(Function<LocalDateTime, String>
time labels style provider, not null
styleProvider)

Sets the value of timeStyleProviderProperty().

protected ObjectProperty<DateTimeFormatter>

Returns:

the time of day formatter.
timeFormatterProperty()

Gets the DateTimeFormatter instance, which is used to provide the format on the TimeScale for those labels that are displaying the time of day.

public ObjectProperty<Function<LocalDateTime, String>>

Returns:

the style provider
timeStyleProviderProperty()

Gets the function, which is used to provide additional style properties for the labels that will display the times of a day (01:00, 02:00, ...).

Inherited from com.calendarfx.view.DayViewBase:
bindearliestTimeUsedPropertyearlyLateHoursStrategyPropertyenableCurrentTimeCirclePropertyenableCurrentTimeMarkerPropertyenableStartAndEndTimesFlipPropertyentryViewAvailabilityEditingBehaviourPropertyentryViewAvailabilityEditingOpacityPropertyentryWidthPercentagePropertygetEarliestTimeUsedgetEarlyLateHoursStrategygetEntryViewAvailabilityEditingBehaviourgetEntryViewAvailabilityEditingOpacitygetEntryWidthPercentagegetGridLineColorgetGridLinesgetGridTypegetHourHeightgetHourHeightCompressedgetHoursLayoutStrategygetInstantAtgetInstantAtgetLassoColorgetLassoEndgetLassoStartgetLatestTimeUsedgetLocationgetLocationgetMaxHourHeightgetMinHourHeightgetOnLassoFinishedgetOverlapResolutionStrategygetPropertySheetItemsgetScrollTimegetVisibleHoursgetZonedDateTimegetZonedDateTimeAtgetZonedDateTimeAtgetZonedDateTimeEndgetZonedDateTimeMaxgetZonedDateTimeMingetZonedDateTimeStartgridLineColorPropertygridLinesPropertygridTypePropertyhourHeightCompressedPropertyhourHeightPropertyhoursLayoutStrategyPropertyinstallDefaultLassoFinishedBehaviourisEnableCurrentCircleMarkerisEnableCurrentTimeMarkerisEnableStartAndEndTimesFlipisScrollingEnabledisShowCurrentTimeMarkerisShowCurrentTimeTodayMarkerisTrimTimeBoundslassoColorPropertylassoEndPropertylassoStartPropertylatestTimeUsedPropertymaxHourHeightPropertyminHourHeightPropertyonLassoFinishedPropertyoverlapResolutionStrategyPropertyscrollingEnabledPropertyscrollTimePropertysetEarlyLateHoursStrategysetEnableCurrentTimeCirclesetEnableCurrentTimeMarkersetEnableStartAndEndTimesFlipsetEntryViewAvailabilityEditingBehavioursetEntryViewAvailabilityEditingOpacitysetEntryWidthPercentagesetGridLineColorsetGridLinessetGridTypesetHourHeightsetHourHeightCompressedsetHoursLayoutStrategysetLassoColorsetLassoEndsetLassoStartsetMaxHourHeightsetMinHourHeightsetOnLassoFinishedsetOverlapResolutionStrategysetScrollingEnabledsetScrollTimesetTrimTimeBoundssetVisibleHoursshowCurrentTimeMarkerPropertyshowCurrentTimeTodayMarkerPropertytrimTimeBoundsPropertyunbindvisibleHoursProperty

Field Detail

dateFormatterback to summary
private final ObjectProperty<DateTimeFormatter> dateFormatter
dateStyleProviderback to summary
private final ObjectProperty<Function<LocalDateTime, String>> dateStyleProvider
DEFAULT_STYLE_PROVIDERback to summary
private static final Function<LocalDateTime, String> DEFAULT_STYLE_PROVIDER
timeFormatterback to summary
private final ObjectProperty<DateTimeFormatter> timeFormatter
timeStyleProviderback to summary
private final ObjectProperty<Function<LocalDateTime, String>> timeStyleProvider

Constructor Detail

TimeScaleViewback to summary
public TimeScaleView()

Constructs a new scale view.

Method Detail

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
dateFormatterPropertyback to summary
public final ObjectProperty<DateTimeFormatter> dateFormatterProperty()

Gets the DateTimeFormatter instance, which is used to provide the format on the TimeScale for those labels that are displaying a date. By default it has a value of FormatStyle#SHORT.

Returns:ObjectProperty<DateTimeFormatter>

the date formatter.

dateStyleProviderPropertyback to summary
public ObjectProperty<Function<LocalDateTime, String>> dateStyleProviderProperty()

Gets the function, which is used to provide additional styling for the labels used to display dates.

Returns:ObjectProperty<Function<LocalDateTime, String>>

the style function for date labels

getDateFormatterback to summary
public final DateTimeFormatter getDateFormatter()

Returns the value of dateFormatterProperty()

Returns:DateTimeFormatter

the date formatter

getDateStyleProviderback to summary
public Function<LocalDateTime, String> getDateStyleProvider()

Returns the value of dateStyleProviderProperty().

Returns:Function<LocalDateTime, String>

the style function for date labels

getTimeFormatterback to summary
public final DateTimeFormatter getTimeFormatter()

Returns the value of timeFormatterProperty()

Returns:DateTimeFormatter

the time of day formatter

getTimeStyleProviderback to summary
public Function<LocalDateTime, String> getTimeStyleProvider()

Returns the value of timeStyleProviderProperty().

Returns:Function<LocalDateTime, String>

the style provider

setDateFormatterback to summary
public final void setDateFormatter(DateTimeFormatter formatter)

Sets the value of dateFormatterProperty()

Parameters
formatter:DateTimeFormatter

the date formatter, not null

setDateStyleProviderback to summary
public void setDateStyleProvider(Function<LocalDateTime, String> styleProvider)

Sets the value of dateStyleProviderProperty().

Parameters
styleProvider:Function<LocalDateTime, String>

date labels style provider, not null

setTimeFormatterback to summary
public void setTimeFormatter(DateTimeFormatter formatter)

Sets the value of timeFormatterProperty()

Parameters
formatter:DateTimeFormatter

the time of day formatter, not null

setTimeStyleProviderback to summary
public void setTimeStyleProvider(Function<LocalDateTime, String> styleProvider)

Sets the value of timeStyleProviderProperty().

Parameters
styleProvider:Function<LocalDateTime, String>

time labels style provider, not null

timeFormatterPropertyback to summary
protected ObjectProperty<DateTimeFormatter> timeFormatterProperty()

Gets the DateTimeFormatter instance, which is used to provide the format on the TimeScale for those labels that are displaying the time of day. By default it has a value of FormatStyle#SHORT.

Returns:ObjectProperty<DateTimeFormatter>

the time of day formatter.

timeStyleProviderPropertyback to summary
public ObjectProperty<Function<LocalDateTime, String>> timeStyleProviderProperty()

Gets the function, which is used to provide additional style properties for the labels that will display the times of a day (01:00, 02:00, ...).

Returns:ObjectProperty<Function<LocalDateTime, String>>

the style provider