Top Description Fields Constructors Methods
com.calendarfx.view

public Class WeekTimeScaleView

extends TimeScaleView
Class Inheritance
Imports
impl.com.calendarfx.view.WeekTimeScaleViewSkin, javafx.beans.property.ObjectProperty, .ReadOnlyObjectProperty, .ReadOnlyObjectWrapper, .SimpleObjectProperty, javafx.collections.MapChangeListener, javafx.scene.control.Skin, java.time.format.DateTimeFormatter, .FormatStyle
A specialization of the regular TimeScaleView to support a reference to the WeekView where this scale is being used.

Field Summary

Modifier and TypeField and Description
private final ReadOnlyObjectWrapper<DetailedWeekView>
detailedWeekView

private final ObjectProperty<DateTimeFormatter>
formatter

Constructor Summary

AccessConstructor and Description
public
WeekTimeScaleView()

Constructs a new scale view.

Method Summary

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

Overrides com.calendarfx.view.TimeScaleView.createDefaultSkin.

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

public final ReadOnlyObjectProperty<DetailedWeekView>

Returns:

the week view
detailedWeekViewProperty()

The week view where this scale is being used.

public final DetailedWeekView

Returns:

the week view
getDetailedWeekView()

Returns the value of detailedWeekViewProperty().

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

Overrides com.calendarfx.view.TimeScaleView.setTimeFormatter.

Sets the value of timeFormatterProperty()

protected ObjectProperty<DateTimeFormatter>
timeFormatterProperty()

Overrides com.calendarfx.view.TimeScaleView.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.

Inherited from com.calendarfx.view.TimeScaleView:
dateFormatterPropertydateStyleProviderPropertygetDateFormattergetDateStyleProvidergetTimeFormattergetTimeStyleProvidersetDateFormattersetDateStyleProvidersetTimeStyleProvidertimeStyleProviderProperty

Field Detail

detailedWeekViewback to summary
private final ReadOnlyObjectWrapper<DetailedWeekView> detailedWeekView
formatterback to summary
private final ObjectProperty<DateTimeFormatter> formatter

Constructor Detail

WeekTimeScaleViewback to summary
public WeekTimeScaleView()

Constructs a new scale view.

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides com.calendarfx.view.TimeScaleView.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
detailedWeekViewPropertyback to summary
public final ReadOnlyObjectProperty<DetailedWeekView> detailedWeekViewProperty()

The week view where this scale is being used.

Returns:ReadOnlyObjectProperty<DetailedWeekView>

the week view

getDetailedWeekViewback to summary
public final DetailedWeekView getDetailedWeekView()

Returns the value of detailedWeekViewProperty().

Returns:DetailedWeekView

the week view

setTimeFormatterback to summary
public void setTimeFormatter(DateTimeFormatter formatter)

Overrides com.calendarfx.view.TimeScaleView.setTimeFormatter.

Doc from com.calendarfx.view.TimeScaleView.setTimeFormatter.

Sets the value of timeFormatterProperty()

Parameters
formatter:DateTimeFormatter

the time of day formatter, not null

Annotations
@Override
timeFormatterPropertyback to summary
protected ObjectProperty<DateTimeFormatter> timeFormatterProperty()

Overrides com.calendarfx.view.TimeScaleView.timeFormatterProperty.

Doc from com.calendarfx.view.TimeScaleView.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.

Annotations
@Override