| Modifier and Type | Class and Description |
|---|---|
| public static class | AgendaView.
Agenda entries are model objects that reference a collection of calendar entries for a specific date. |
| public static class | AgendaView.
A specialized list cell that is capable of displaying all entries currently assigned to a given day. |
| Modifier and Type | Field and Description |
|---|---|
| private static final String | |
| private final ObjectProperty | |
| private static final String | |
| private final ObjectProperty | |
| private final ListView | |
| private final IntegerProperty | |
| private final IntegerProperty | |
| private final BooleanProperty |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| private ContextMenu | |
| public final ObjectProperty | |
| protected Skin | createDefaultSkin()
Overrides javafx. Create a new instance of the default skin for this control. |
| public final ObjectProperty | Returns: the date formatter.Gets the DateTimeFormatter property, which is use to provide the format on the TimeScale Labels. |
| public final Callback | |
| public final DateTimeFormatter | Returns: a date time formatterReturns the value of |
| public final ListView | Returns: the list view used by this controlReturns the list view that will be used to display one cell for each day that contains at least one calendar entry. |
| public final int | Returns: the number of days to look aheadReturns the value of |
| public final int | Returns: the number of days to look backGets the value of |
| public ObservableList | getPropertySheetItems()
Overrides com. Returns a list of property items that can be shown by the
|
| public final boolean | |
| public final IntegerProperty | Returns: the number of days to "look ahead"Stores the number of days to "look ahead" into the future when loading its data. |
| public final IntegerProperty | Returns: the number of days to look backStores the number of days to "look back" into the past when loading data. |
| public final void | |
| public final void | setDateTimeFormatter(DateTimeFormatter
a date time formatter, not formatter)nullSets the value of |
| public final void | setLookAheadPeriodInDays(int
the number of days to look ahead days)Sets the value of |
| public final void | setLookBackPeriodInDays(int
the new number of days to look back days)Sets the value of |
| public final void | |
| public final BooleanProperty |
| AGENDA_CATEGORY | back to summary |
|---|---|
| private static final String AGENDA_CATEGORY | |
| cellFactory | back to summary |
|---|---|
| private final ObjectProperty<Callback<AgendaView, ? extends AgendaView. | |
| DEFAULT_STYLE_CLASS | back to summary |
|---|---|
| private static final String DEFAULT_STYLE_CLASS | |
| formatter | back to summary |
|---|---|
| private final ObjectProperty<DateTimeFormatter> formatter | |
| listView | back to summary |
|---|---|
| private final ListView<AgendaView. | |
| lookAheadPeriodInDays | back to summary |
|---|---|
| private final IntegerProperty lookAheadPeriodInDays | |
| lookBackPeriodInDays | back to summary |
|---|---|
| private final IntegerProperty lookBackPeriodInDays | |
| showStatusLabel | back to summary |
|---|---|
| private final BooleanProperty showStatusLabel | |
| AgendaView | back to summary |
|---|---|
| public AgendaView() Constructs a new agenda view. | |
| buildContextMenu | back to summary |
|---|---|
| private ContextMenu buildContextMenu() | |
| cellFactoryProperty | back to summary |
|---|---|
| public final ObjectProperty | |
| createDefaultSkin | back to summary |
|---|---|
| protected Skin Overrides javafx. Doc from javafx. 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 | |
| dateTimeFormatterProperty | back to summary |
|---|---|
| public final ObjectProperty Gets the DateTimeFormatter property, which is use to provide the format on the TimeScale Labels. By default it
has a value of
| |
| getCellFactory | back to summary |
|---|---|
| public final Callback | |
| getDateTimeFormatter | back to summary |
|---|---|
| public final DateTimeFormatter getDateTimeFormatter() Returns the value of
| |
| getListView | back to summary |
|---|---|
| public final ListView Returns the list view that will be used to display one cell for each day that contains at least one calendar entry.
| |
| getLookAheadPeriodInDays | back to summary |
|---|---|
| public final int getLookAheadPeriodInDays() Returns the value of
| |
| getLookBackPeriodInDays | back to summary |
|---|---|
| public final int getLookBackPeriodInDays() Gets the value of
| |
| getPropertySheetItems | back to summary |
|---|---|
| public ObservableList Overrides com. Doc from com. Returns a list of property items that can be shown by the
| |
| isShowStatusLabel | back to summary |
|---|---|
| public final boolean isShowStatusLabel() | |
| lookAheadPeriodInDaysProperty | back to summary |
|---|---|
| public final IntegerProperty lookAheadPeriodInDaysProperty() Stores the number of days to "look ahead" into the future when loading its data.
| |
| lookBackPeriodInDaysProperty | back to summary |
|---|---|
| public final IntegerProperty lookBackPeriodInDaysProperty() Stores the number of days to "look back" into the past when loading data.
| |
| setCellFactory | back to summary |
|---|---|
| public final void setCellFactory(Callback<AgendaView, ? extends AgendaView. | |
| setDateTimeFormatter | back to summary |
|---|---|
| public final void setDateTimeFormatter(DateTimeFormatter formatter) Sets the value of
| |
| setLookAheadPeriodInDays | back to summary |
|---|---|
| public final void setLookAheadPeriodInDays(int days) Sets the value of
| |
| setLookBackPeriodInDays | back to summary |
|---|---|
| public final void setLookBackPeriodInDays(int days) Sets the value of
| |
| setShowStatusLabel | back to summary |
|---|---|
| public final void setShowStatusLabel(boolean showStatusLabel) | |
| showStatusLabelProperty | back to summary |
|---|---|
| public final BooleanProperty showStatusLabelProperty() | |
| Modifier and Type | Field and Description |
|---|---|
| private final LocalDate | |
| private final List |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public int | compareTo(AgendaView.
the object to be compared. oImplements java. Compares this object with the specified object for order. |
| public LocalDate | |
| public final List |
| date | back to summary |
|---|---|
| private final LocalDate date | |
| entries | back to summary |
|---|---|
| private final List<Entry<?>> entries | |
| AgendaEntry | back to summary |
|---|---|
| public AgendaEntry(LocalDate date) | |
| compareTo | back to summary |
|---|---|
| public int compareTo(AgendaView. Implements java. Doc from java. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure The implementor must also ensure that the relation is transitive:
Finally, the implementor must ensure that
| |
| getDate | back to summary |
|---|---|
| public LocalDate getDate() | |
| getEntries | back to summary |
|---|---|
| public final List | |
| Modifier and Type | Field and Description |
|---|---|
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private final AgendaView | |
| private Label | |
| private GridPane | |
| private BorderPane | |
| private final boolean | |
| private DateTimeFormatter | |
| private DateTimeFormatter | |
| private DateTimeFormatter | |
| private DateTimeFormatter | |
| private Label |
| Access | Constructor and Description |
|---|---|
| public | AgendaEntryCell(AgendaView
the parent list view view)Constructs a new cell that will work with the given agenda view. |
| public | AgendaEntryCell(AgendaView
the parent list view view, boolean flag to control the visibility of the cell's header. headerPaneVisible)Constructs a new cell that will work with the given agenda view. |
| Modifier and Type | Method and Description |
|---|---|
| protected Node | |
| protected Node | Returns: a node for displaying a graphic for the entrythe entry for which the icon will be displayed entry)Creates a node used to display an icon for the entry. |
| protected Label | Returns: a label for displaying the time information on the entrythe entry for which the time will be displayed entry)Creates the label used to display the time of the entry. |
| protected Label | Returns: a label for displaying the title of the entrythe entry for which the title will be displayed entry)Creates the label used to display the title of the entry. |
| protected Node | |
| protected String | Returns: a text showing the start and end times of the entrythe entry for which the text will be created entry)Creates a nicely formatted text that contains the start and end time of the given entry. |
| public void | setMediumDateFormatter(DateTimeFormatter
sets medium date time format. mediumDateFormatter)Sets the Medium Date Formatter, the value by default is |
| public void | setShortDateFormatter(DateTimeFormatter
sets the short date time format. shortDateFormatter)Sets the Short Date Formatter, the value by default is |
| public void | setTimeFormatter(DateTimeFormatter
sets the time format. timeFormatter)Sets the Time Formatter, the value by default is |
| public void | setWeekdayFormatter(DateTimeFormatter
sets the week date time format. weekdayFormatter)Sets the Week Formatter, the value by default is 'EEEE' Format. |
| protected void | updateItem(AgendaView.
The new item for the cell. item,whether or not this cell represents data from the list. If it
is empty, then it does not represent any domain data, but is a cell
being used to render an "empty" row. empty)Overrides javafx. The updateItem method should not be called by developers, but it is the best method for developers to override to allow for them to customise the visuals of the cell. |
| AGENDA_VIEW_BODY | back to summary |
|---|---|
| private static final String AGENDA_VIEW_BODY | |
| AGENDA_VIEW_BODY_SEPARATOR | back to summary |
|---|---|
| private static final String AGENDA_VIEW_BODY_SEPARATOR | |
| AGENDA_VIEW_DATE_LABEL | back to summary |
|---|---|
| private static final String AGENDA_VIEW_DATE_LABEL | |
| AGENDA_VIEW_DATE_LABEL_TODAY | back to summary |
|---|---|
| private static final String AGENDA_VIEW_DATE_LABEL_TODAY | |
| AGENDA_VIEW_HEADER | back to summary |
|---|---|
| private static final String AGENDA_VIEW_HEADER | |
| AGENDA_VIEW_HEADER_TODAY | back to summary |
|---|---|
| private static final String AGENDA_VIEW_HEADER_TODAY | |
| AGENDA_VIEW_LIST_CELL | back to summary |
|---|---|
| private static final String AGENDA_VIEW_LIST_CELL | |
| AGENDA_VIEW_TIME_LABEL | back to summary |
|---|---|
| private static final String AGENDA_VIEW_TIME_LABEL | |
| AGENDA_VIEW_TITLE_LABEL | back to summary |
|---|---|
| private static final String AGENDA_VIEW_TITLE_LABEL | |
| AGENDA_VIEW_WEEKDAY_LABEL | back to summary |
|---|---|
| private static final String AGENDA_VIEW_WEEKDAY_LABEL | |
| AGENDA_VIEW_WEEKDAY_LABEL_TODAY | back to summary |
|---|---|
| private static final String AGENDA_VIEW_WEEKDAY_LABEL_TODAY | |
| agendaView | back to summary |
|---|---|
| private final AgendaView agendaView | |
| dateLabel | back to summary |
|---|---|
| private Label dateLabel | |
| gridPane | back to summary |
|---|---|
| private GridPane gridPane | |
| headerPane | back to summary |
|---|---|
| private BorderPane headerPane | |
| headerPaneVisible | back to summary |
|---|---|
| private final boolean headerPaneVisible | |
| mediumDateFormatter | back to summary |
|---|---|
| private DateTimeFormatter mediumDateFormatter | |
| shortDateFormatter | back to summary |
|---|---|
| private DateTimeFormatter shortDateFormatter | |
| timeFormatter | back to summary |
|---|---|
| private DateTimeFormatter timeFormatter | |
| weekdayFormatter | back to summary |
|---|---|
| private DateTimeFormatter weekdayFormatter | |
| weekdayLabel | back to summary |
|---|---|
| private Label weekdayLabel | |
| AgendaEntryCell | back to summary |
|---|---|
| public AgendaEntryCell(AgendaView view) Constructs a new cell that will work with the given agenda view.
| |
| AgendaEntryCell | back to summary |
|---|---|
| public AgendaEntryCell(AgendaView view, boolean headerPaneVisible) Constructs a new cell that will work with the given agenda view.
| |
| createBody | back to summary |
|---|---|
| protected Node createBody() Creates the node used for the body part of each cell. In this default implementation the body consists of a grid pane with three columns. The middle column is used for showing the title of calendar entries. This column will get whatever space is left after the icon and the time column have used what they need. This means that a very long title will automatically be truncated.
| |
| createEntryGraphic | back to summary |
|---|---|
| protected Node createEntryGraphic(Entry<?> entry) Creates a node used to display an icon for the entry. The default implementation of this method
creates a node of type Circle circle = new Circle(4); circle.getStyleClass().add(entry.getCalendar().getStyle() + "-icon"); | |
| createEntryTimeLabel | back to summary |
|---|---|
| protected Label createEntryTimeLabel(Entry<?> entry) Creates the label used to display the time of the entry. The default implementation of this
method creates a label and sets the text returned by | |
| createEntryTitleLabel | back to summary |
|---|---|
| protected Label createEntryTitleLabel(Entry<?> entry) Creates the label used to display the title of the entry. The default implementation of this
method creates a label and sets the text found in | |
| createHeader | back to summary |
|---|---|
| protected Node createHeader() Creates the header part for each cell. The header consists of a border pane with the weekday label in the "left" position and the date label in the "right" position.
| |
| getTimeText | back to summary |
|---|---|
| protected String getTimeText(Entry<?> entry) Creates a nicely formatted text that contains the start and end time of the given entry. The text can also be something like "full day" if the entry is a full-day entry. | |
| setMediumDateFormatter | back to summary |
|---|---|
| public void setMediumDateFormatter(DateTimeFormatter mediumDateFormatter) Sets the Medium Date Formatter, the value by default is
| |
| setShortDateFormatter | back to summary |
|---|---|
| public void setShortDateFormatter(DateTimeFormatter shortDateFormatter) Sets the Short Date Formatter, the value by default is
| |
| setTimeFormatter | back to summary |
|---|---|
| public void setTimeFormatter(DateTimeFormatter timeFormatter) Sets the Time Formatter, the value by default is
| |
| setWeekdayFormatter | back to summary |
|---|---|
| public void setWeekdayFormatter(DateTimeFormatter weekdayFormatter) Sets the Week Formatter, the value by default is 'EEEE' Format.
| |
| updateItem | back to summary |
|---|---|
| protected void updateItem(AgendaView. Overrides javafx. Doc from javafx. The updateItem method should not be called by developers, but it is the
best method for developers to override to allow for them to customise the
visuals of the cell. To clarify, developers should never call this method
in their code (they should leave it up to the UI control, such as the
It is very important that subclasses of Cell override the updateItem method properly, as failure to do so will lead to issues such as blank cells or cells with unexpected content appearing within them. Here is an example of how to properly override the updateItem method:
protected void updateItem(T item, boolean empty) {
super.updateItem(item, empty);
if (empty || item == null) {
setText(null);
setGraphic(null);
} else {
setText(item.toString());
}
}
Note in this code sample two important points:
| |