Top Description Fields Constructors Methods
com.calendarfx.view

public Class RecurrenceView

extends CalendarFXControl
Class Inheritance
Imports
com.calendarfx.model.Entry, impl.com.calendarfx.view.RecurrenceViewSkin, javafx.beans.property.BooleanProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.scene.control.Skin, net.fortuna.ical4j.model.Recur, java.time.LocalDate, java.time.format.DateTimeParseException
A custom control used for editing recurrence rules according to RFC 2445. The image below shows the four configurations of the control depending on the currently selected frequency (daily, weekly, monthly, yearly). Recurrence Week

Field Summary

Modifier and TypeField and Description
private final StringProperty
recurrenceRule

private final BooleanProperty
showSummary

private final ObjectProperty<LocalDate>
startDate

Constructor Summary

AccessConstructor and Description
public
RecurrenceView()

Constructs a new recurrence 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 String

Returns:

the recurrence rule (e.g. "RRULE:FREQ=DAILY").
getRecurrenceRule()

Returns the value of recurrenceRuleProperty().

public final LocalDate

Returns:

the start date for the rule
getStartDate()

Returns the value of startDateProperty().

public final boolean

Returns:

true if the summary label will be shown
isShowSummary()

Returns the value of showSummaryProperty().

public final StringProperty

Returns:

the recurrence rule
recurrenceRuleProperty()

Stores the recurrence rule according to RFC 2445 syntax (e.g. "RRULE:FREQ=DAILY").

public final void
setRecurrenceRule(String
the recurrence rule (e.g. "RRULE:FREQ=DAILY").
rule)

Sets the value of recurrenceRuleProperty().

public final void
setShowSummary(boolean
if true the summary label will be shown
show)

Sets the value of showSummaryProperty().

public final void
setStartDate(LocalDate
the new start date
date)

Sets the value of startDateProperty().

public final BooleanProperty

Returns:

true if the summary label should be shown
showSummaryProperty()

A property used to control the visibility of the "summary" label.

public final ObjectProperty<LocalDate>

Returns:

the start date
startDateProperty()

A property used to store the start date for the recurrence rule.

Inherited from com.calendarfx.view.CalendarFXControl:
getPropertySheetItemsgetUserAgentStylesheet

Field Detail

recurrenceRuleback to summary
private final StringProperty recurrenceRule
showSummaryback to summary
private final BooleanProperty showSummary
startDateback to summary
private final ObjectProperty<LocalDate> startDate

Constructor Detail

RecurrenceViewback to summary
public RecurrenceView()

Constructs a new recurrence 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
getRecurrenceRuleback to summary
public final String getRecurrenceRule()

Returns the value of recurrenceRuleProperty().

Returns:String

the recurrence rule (e.g. "RRULE:FREQ=DAILY").

getStartDateback to summary
public final LocalDate getStartDate()

Returns the value of startDateProperty().

Returns:LocalDate

the start date for the rule

isShowSummaryback to summary
public final boolean isShowSummary()

Returns the value of showSummaryProperty().

Returns:boolean

true if the summary label will be shown

recurrenceRulePropertyback to summary
public final StringProperty recurrenceRuleProperty()

Stores the recurrence rule according to RFC 2445 syntax (e.g. "RRULE:FREQ=DAILY").

Returns:StringProperty

the recurrence rule

See Also
Entry#recurrenceRuleProperty()
setRecurrenceRuleback to summary
public final void setRecurrenceRule(String rule)

Sets the value of recurrenceRuleProperty().

Parameters
rule:String

the recurrence rule (e.g. "RRULE:FREQ=DAILY").

setShowSummaryback to summary
public final void setShowSummary(boolean show)

Sets the value of showSummaryProperty().

Parameters
show:boolean

if true the summary label will be shown

setStartDateback to summary
public final void setStartDate(LocalDate date)

Sets the value of startDateProperty().

Parameters
date:LocalDate

the new start date

showSummaryPropertyback to summary
public final BooleanProperty showSummaryProperty()

A property used to control the visibility of the "summary" label. The label interprets the recurrence rule and displays it in a human readable format, e.g. "Every week on Saturday and Sunday", or "Every 4 days, 5 times").

Returns:BooleanProperty

true if the summary label should be shown

See Also
Util#convertRFC2445ToText(String, LocalDate)
startDatePropertyback to summary
public final ObjectProperty<LocalDate> startDateProperty()

A property used to store the start date for the recurrence rule. The start date is relevant when creating rules that specify an entry to occure on a specific day of the month or the week.

Returns:ObjectProperty<LocalDate>

the start date