Agenda (jfxtras-agenda 8.0-r4-SNAPSHOT API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- javafx.scene.Node
- - javafx.scene.Parent
  - - javafx.scene.layout.Region
    - - javafx.scene.control.Control
      - jfxtras.scene.control.agenda.Agenda

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
```
public class Agenda
extends javafx.scene.control.Control
```
Agenda
This controls renders appointments similar to Google Calendar. Normally this would be called a Calendar, but since there are controls like CalendarPicker, this would be confusing, hence the name "Agenda".
// create Agenda Agenda agenda = new Agenda(); // add an appointment agenda.appointments().addAll( new Agenda.AppointmentImplLocal() .withStartLocalDateTime(LocalDate.now().atTime(4, 00)) .withEndLocalDateTime(LocalDate.now().atTime(15, 30)) .withDescription("It's time") .withAppointmentGroup(new Agenda.AppointmentGroupImpl().withStyleClass("group1")) // you should use a map of AppointmentGroups ); // show it primaryStage.setScene(new Scene(agenda, 800, 600)); primaryStage.show();
Properties:
- appointments: a list of instances of the Appointment interface, to be rendered by Agenda.
- appointmentGroups: a list of AppointmentGroup implementations, for grouping appointments together (e.g. render in the same color).
- displayedLocalDateTime: the moment in time that is rendered, depending on the active skin this can be different time frames (day, week, etc).
- locale: used to determine the first-day-of-week and week day labels.
- allowDragging: allow appointments to be dragged by the mouse.
- allowResize: allow appointments to be resized using the mouse.
- selectedAppointments: appointments that are selected.
Appointments
The control has a list of appointments (classes implementing the Agenda.Appointment interface) and a LocalDateTime (date) that should be displayed. The appropriate appointments for the to-be-displayed time (based on the currently active skin) will be rendered. The coder could provide all appointments in one big list, but that probably will be a memory heavy. The better approach is to register to the localDateTimeRangeCallbackProperty, and update the appointment collection to match the time frame.

Agenda.Appointment can be provided in three ways:
- through Calendar values (by implementing the *StartTime methods in Appointment or use the Agenda.AppointmentImpl class)
- through ZonedDateTime values (by implementing the *ZonedDateTime methods in Appointment or use the Agenda.AppointmentImplZoned class)
- through LocalDateTime values (by implementing the *LocalDateTime methods in Appointment or use the Agenda.AppointmentImplLocal class)
Calendar, LocalDateTime or ZonedDateTime

Agenda uses LocalDateTime for render the appointments. Since Agenda must display all appointments in the same "time scale", it simply is not possible to mix different time zones in one view. Google Calendar does this by converting everything to UTC (Coordinated Universal Time, previously know as Greenwich Mean time, or GMT), Agenda does this by converting Calendars to ZonedDateTimes, and ZonedDateTimes to LocalDateTimes. The code used to convert ZonedDateTime to LocalDateTime is somewhat crude and possibly too simplistic, you may want to provide more intelligent conversion by overriding the default methods in the Appointment interface. But you can provide the data in any of the three types, just as long as you understand that LocalDateTime is what is used to render, and what is communicated by Agenda.

AppointmentGroup

Each appointment should have an appointment group, this is a class implementing the Agenda.AppointmentGroup interface (Agenda.AppointmentGroupImpl is available). The most important thing this class provides is a style class name which takes care of the rendering (color) of all appointments in that group. Per default agenda has style classes defined, called group0 .. group23.

Callbacks
Action callback

The actionCallback property is called when the 'action' is executed on a appointment. Per default this is a double click.
agenda.actionCallback().set( (appointment) -> { System.out.println("Action was triggered on " + appointment.getDescription()); });
Adding appointments using the mouse

A new appointment can be added by click-and-drag, but only if a createAppointmentCallbackProperty() is set. This method should return a new appointment object, for example:
agenda.newAppointmentCallbackProperty().set( (localDateTimeRange) -> { return new Agenda.AppointmentImplLocal() .withStartLocalDateTime(localDateTimeRange.getStartLocalDateTime()) .withEndLocalDateTime(localDateTimeRange.getEndLocalDateTime()) .withAppointmentGroup(new Agenda.AppointmentGroupImpl().withStyleClass("group1")); // it is better to have a map of appointment groups to get from });
Editing appointments

Agenda has a default popup the allows the primarty properties of appointments to be edited, but maybe you want to do something yourself. If so, you need to register to the editAppointmentCallback, and open your own popup. Because Agenda does not dictate an event/callback mechanism in the implementation of Appointment, it has no way of being informed of changes on the appointment. So when the custom edit is done, make sure that control gets updated (if this does not happen automatically through any of the existing listeners) by calling refresh().

Property Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Type	Property and Description
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>>`	`actionCallback` actionCallback: This triggered when the action is called on an appointment, usually this is a double click
`javafx.beans.property.SimpleBooleanProperty`	`allowDragging` AllowDragging: allow appointments being dragged by the mouse
`javafx.beans.property.SimpleBooleanProperty`	`allowResize` AllowResize: allow appointments to be resized using the mouse
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,java.lang.Void>>`	`calendarRangeCallback` Deprecated.
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment>>`	`createAppointmentCallback` Deprecated.
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>>`	`editAppointmentCallback` editAppointmentCallback: Agenda has a default popup, but maybe you want to do something yourself.
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void>>`	`localDateTimeRangeCallback` localDateTimeRangeCallback: Appointments should match: - start date >= range start - end date <= range end
`javafx.beans.property.ObjectProperty<java.util.Locale>`	`locale` Locale: the locale is used to determine first-day-of-week, weekday labels, etc
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment>>`	`newAppointmentCallback` addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one.

Properties inherited from class javafx.scene.control.Control
contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent
impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node
blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Agenda.Appointment` The interface that all appointments must adhere to; you can provide your own implementation.
`static interface`	`Agenda.AppointmentGroup` The interface that appointment groups must adhere to; you can provide your own implementation.
`static class`	`Agenda.AppointmentGroupImpl` A class to help you get going; all the required methods of the interface are implemented as JavaFX properties
`static class`	`Agenda.AppointmentImpl` A class to help you get going using Calendar; all the required methods of the interface are implemented as JavaFX properties
`static class`	`Agenda.AppointmentImplBase<T>` A class to help you get going; all the required methods of the interface are implemented as JavaFX properties
`static class`	`Agenda.AppointmentImplLocal` A class to help you get going using LocalDateTime; all the required methods of the interface are implemented as JavaFX properties
`static class`	`Agenda.AppointmentImplZoned` A class to help you get going using ZonedDateTime; all the required methods of the interface are implemented as JavaFX properties
`static class`	`Agenda.CalendarRange` Deprecated.
`static class`	`Agenda.LocalDateTimeRange` A Datetime range, for callbacks

Field Summary
- Fields inherited from class javafx.scene.layout.Region
  USE_COMPUTED_SIZE, USE_PREF_SIZE
- Fields inherited from class javafx.scene.Node
  BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors
Constructor and Description

Agenda()

Constructors
Constructor and Description
`Agenda()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>>`	`actionCallbackProperty()` actionCallback: This triggered when the action is called on an appointment, usually this is a double click
`javafx.beans.property.SimpleBooleanProperty`	`allowDraggingProperty()` AllowDragging: allow appointments being dragged by the mouse
`javafx.beans.property.SimpleBooleanProperty`	`allowResizeProperty()` AllowResize: allow appointments to be resized using the mouse
`javafx.collections.ObservableList<Agenda.AppointmentGroup>`	`appointmentGroups()` AppointmentGroups:
`javafx.collections.ObservableList<Agenda.Appointment>`	`appointments()` Appointments:
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,java.lang.Void>>`	`calendarRangeCallbackProperty()` Deprecated.
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment>>`	`createAppointmentCallbackProperty()` Deprecated.
`javafx.scene.control.Skin<?>`	`createDefaultSkin()`
`javafx.beans.property.ObjectProperty<java.util.Calendar>`	`displayedCalendar()` Deprecated.
`javafx.beans.property.ObjectProperty<java.time.LocalDateTime>`	`displayedLocalDateTime()` The skin will use this date and time to determine what to display.
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>>`	`editAppointmentCallbackProperty()` editAppointmentCallback: Agenda has a default popup, but maybe you want to do something yourself.
`javafx.util.Callback<Agenda.Appointment,java.lang.Void>`	`getActionCallback()`
`boolean`	`getAllowDragging()`
`boolean`	`getAllowResize()`
`javafx.util.Callback<Agenda.CalendarRange,java.lang.Void>`	`getCalendarRangeCallback()` Deprecated.
`javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment>`	`getCreateAppointmentCallback()` Deprecated.
`java.util.Calendar`	`getDisplayedCalendar()` Deprecated.
`java.time.LocalDateTime`	`getDisplayedLocalDateTime()`
`javafx.util.Callback<Agenda.Appointment,java.lang.Void>`	`getEditAppointmentCallback()`
`javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void>`	`getLocalDateTimeRangeCallback()`
`java.util.Locale`	`getLocale()`
`javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment>`	`getNewAppointmentCallback()`
`java.lang.String`	`getUserAgentStylesheet()` Return the path to the CSS file so things are setup right
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void>>`	`localDateTimeRangeCallbackProperty()` localDateTimeRangeCallback: Appointments should match: - start date >= range start - end date <= range end
`javafx.beans.property.ObjectProperty<java.util.Locale>`	`localeProperty()` Locale: the locale is used to determine first-day-of-week, weekday labels, etc
`javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment>>`	`newAppointmentCallbackProperty()` addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one.
`void`	`print(javafx.print.PrinterJob job)` Prints the current agenda using the given printer job.
`void`	`refresh()` Force the agenda to completely refresh itself
`javafx.collections.ObservableList<Agenda.Appointment>`	`selectedAppointments()` selectedAppointments: a list of selected appointments
`void`	`setActionCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)`
`void`	`setAllowDragging(boolean value)`
`void`	`setAllowResize(boolean value)`
`void`	`setCalendarRangeCallback(javafx.util.Callback<Agenda.CalendarRange,java.lang.Void> value)` Deprecated.
`void`	`setCreateAppointmentCallback(javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment> value)` Deprecated.
`void`	`setDisplayedCalendar(java.util.Calendar value)` Deprecated.
`void`	`setDisplayedLocalDateTime(java.time.LocalDateTime value)`
`void`	`setEditAppointmentCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)`
`void`	`setLocalDateTimeRangeCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void> value)`
`void`	`setLocale(java.util.Locale value)`
`void`	`setNewAppointmentCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment> value)`
`Agenda`	`withActionCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)`
`Agenda`	`withAllowDragging(boolean value)`
`Agenda`	`withAllowResize(boolean value)`
`Agenda`	`withCalendarRangeCallback(javafx.util.Callback<Agenda.CalendarRange,java.lang.Void> value)` Deprecated.
`Agenda`	`withCreateAppointmentCallback(javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment> value)` Deprecated.
`Agenda`	`withDisplayedCalendar(java.util.Calendar value)` Deprecated.
`Agenda`	`withDisplayedLocalDateTime(java.time.LocalDateTime value)`
`Agenda`	`withEditAppointmentCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)`
`Agenda`	`withId(java.lang.String value)` Id
`Agenda`	`withLocalDateTimeRangeCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void> value)`
`Agenda`	`withLocale(java.util.Locale value)`
`Agenda`	`withNewAppointmentCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment> value)`

Methods inherited from class javafx.scene.control.Control
computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region
backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent
getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node
addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Property Detail
  - locale
```
public javafx.beans.property.ObjectProperty<java.util.Locale> localeProperty
```
    Locale: the locale is used to determine first-day-of-week, weekday labels, etc
    
    See Also:
    
    getLocale(), setLocale(Locale)
  - allowDragging
```
public javafx.beans.property.SimpleBooleanProperty allowDraggingProperty
```
    AllowDragging: allow appointments being dragged by the mouse
    
    See Also:
    
    getAllowDragging(), setAllowDragging(boolean)
  - allowResize
```
public javafx.beans.property.SimpleBooleanProperty allowResizeProperty
```
    AllowResize: allow appointments to be resized using the mouse
    
    See Also:
    
    getAllowResize(), setAllowResize(boolean)
  - calendarRangeCallback
```
@Deprecated
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,java.lang.Void>> calendarRangeCallbackProperty
```
    calendarRangeCallback: Appointments should match: - start date >= range start - end date <= range end
    
    See Also:
    
    getCalendarRangeCallback(), setCalendarRangeCallback(Callback)
  - localDateTimeRangeCallback
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void>> localDateTimeRangeCallbackProperty
```
    localDateTimeRangeCallback: Appointments should match: - start date >= range start - end date <= range end
    
    See Also:
    
    getLocalDateTimeRangeCallback(), setLocalDateTimeRangeCallback(Callback)
  - createAppointmentCallback
```
@Deprecated
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment>> createAppointmentCallbackProperty
```
    addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one. So you need to implement this callback and create an appointment. The calendars in the provided range specify the start and end times, they can be used to create the new appointment (they do not need to be cloned). Null may be returned to indicate that no appointment was created.
    
    See Also:
    
    getCreateAppointmentCallback(), setCreateAppointmentCallback(Callback)
  - newAppointmentCallback
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment>> newAppointmentCallbackProperty
```
    addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one. So you need to implement this callback and create an appointment. The calendars in the provided range specify the start and end times, they can be used to create the new appointment (they do not need to be cloned). Null may be returned to indicate that no appointment was created.
    
    See Also:
    
    getNewAppointmentCallback(), setNewAppointmentCallback(Callback)
  - editAppointmentCallback
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>> editAppointmentCallbackProperty
```
    editAppointmentCallback: Agenda has a default popup, but maybe you want to do something yourself. If so, you need to set this callback method and open your own window. Because Agenda does not dictate a event/callback in the implementation of appointment, it has no way of being informed of changes on the appointment. So when the custom edit is done, make sure that control gets updated, if this does not happen automatically through any of the existing listeners, then call refresh().
    
    See Also:
    
    getEditAppointmentCallback(), setEditAppointmentCallback(Callback)
  - actionCallback
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>> actionCallbackProperty
```
    actionCallback: This triggered when the action is called on an appointment, usually this is a double click
    
    See Also:
    
    getActionCallback(), setActionCallback(Callback)
- Constructor Detail
  - Agenda
```
public Agenda()
```
- Method Detail
  - getUserAgentStylesheet
```
public java.lang.String getUserAgentStylesheet()
```
    Return the path to the CSS file so things are setup right
    
    Overrides:
    
    getUserAgentStylesheet in class javafx.scene.control.Control
  - createDefaultSkin
```
public javafx.scene.control.Skin<?> createDefaultSkin()
```
    Overrides:
    
    createDefaultSkin in class javafx.scene.control.Control
  - withId
```
public Agenda withId(java.lang.String value)
```
    Id
  - appointments
```
public javafx.collections.ObservableList<Agenda.Appointment> appointments()
```
    Appointments:
  - appointmentGroups
```
public javafx.collections.ObservableList<Agenda.AppointmentGroup> appointmentGroups()
```
    AppointmentGroups:
  - localeProperty
```
public javafx.beans.property.ObjectProperty<java.util.Locale> localeProperty()
```
    Locale: the locale is used to determine first-day-of-week, weekday labels, etc
    
    See Also:
    
    getLocale(), setLocale(Locale)
  - getLocale
```
public java.util.Locale getLocale()
```
  - setLocale
```
public void setLocale(java.util.Locale value)
```
  - withLocale
```
public Agenda withLocale(java.util.Locale value)
```
  - allowDraggingProperty
```
public javafx.beans.property.SimpleBooleanProperty allowDraggingProperty()
```
    AllowDragging: allow appointments being dragged by the mouse
    
    See Also:
    
    getAllowDragging(), setAllowDragging(boolean)
  - getAllowDragging
```
public boolean getAllowDragging()
```
  - setAllowDragging
```
public void setAllowDragging(boolean value)
```
  - withAllowDragging
```
public Agenda withAllowDragging(boolean value)
```
  - allowResizeProperty
```
public javafx.beans.property.SimpleBooleanProperty allowResizeProperty()
```
    AllowResize: allow appointments to be resized using the mouse
    
    See Also:
    
    getAllowResize(), setAllowResize(boolean)
  - getAllowResize
```
public boolean getAllowResize()
```
  - setAllowResize
```
public void setAllowResize(boolean value)
```
  - withAllowResize
```
public Agenda withAllowResize(boolean value)
```
  - displayedCalendar
```
@Deprecated
public javafx.beans.property.ObjectProperty<java.util.Calendar> displayedCalendar()
```
    Deprecated.
    
    DisplayedCalendar: this calendar denotes the timeframe being displayed. If the agenda is in week skin, it will display the week containing this date. (Things like FirstDayOfWeek are taken into account.) In month skin, the month containing this date.
  - getDisplayedCalendar
```
@Deprecated
public java.util.Calendar getDisplayedCalendar()
```
    Deprecated.
  - setDisplayedCalendar
```
@Deprecated
public void setDisplayedCalendar(java.util.Calendar value)
```
    Deprecated.
  - withDisplayedCalendar
```
@Deprecated
public Agenda withDisplayedCalendar(java.util.Calendar value)
```
    Deprecated.
  - displayedLocalDateTime
```
public javafx.beans.property.ObjectProperty<java.time.LocalDateTime> displayedLocalDateTime()
```
    The skin will use this date and time to determine what to display. Each skin determines what interval suites best; for example the week skin will find the week where this LocalDateTime falls in using the Locale to decide on what day a week starts, the day skin will render the date. Possibly in the future there may be skins that render part of a day, that simply is not known, hence this is a LocalDateTime instead of a LocalDate.
  - getDisplayedLocalDateTime
```
public java.time.LocalDateTime getDisplayedLocalDateTime()
```
  - setDisplayedLocalDateTime
```
public void setDisplayedLocalDateTime(java.time.LocalDateTime value)
```
  - withDisplayedLocalDateTime
```
public Agenda withDisplayedLocalDateTime(java.time.LocalDateTime value)
```
  - selectedAppointments
```
public javafx.collections.ObservableList<Agenda.Appointment> selectedAppointments()
```
    selectedAppointments: a list of selected appointments
  - calendarRangeCallbackProperty
```
@Deprecated
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,java.lang.Void>> calendarRangeCallbackProperty()
```
    Deprecated.
    
    calendarRangeCallback: Appointments should match: - start date >= range start - end date <= range end
    
    See Also:
    
    getCalendarRangeCallback(), setCalendarRangeCallback(Callback)
  - getCalendarRangeCallback
```
@Deprecated
public javafx.util.Callback<Agenda.CalendarRange,java.lang.Void> getCalendarRangeCallback()
```
    Deprecated.
  - setCalendarRangeCallback
```
@Deprecated
public void setCalendarRangeCallback(javafx.util.Callback<Agenda.CalendarRange,java.lang.Void> value)
```
    Deprecated.
  - withCalendarRangeCallback
```
@Deprecated
public Agenda withCalendarRangeCallback(javafx.util.Callback<Agenda.CalendarRange,java.lang.Void> value)
```
    Deprecated.
  - localDateTimeRangeCallbackProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void>> localDateTimeRangeCallbackProperty()
```
    localDateTimeRangeCallback: Appointments should match: - start date >= range start - end date <= range end
    
    See Also:
    
    getLocalDateTimeRangeCallback(), setLocalDateTimeRangeCallback(Callback)
  - getLocalDateTimeRangeCallback
```
public javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void> getLocalDateTimeRangeCallback()
```
  - setLocalDateTimeRangeCallback
```
public void setLocalDateTimeRangeCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void> value)
```
  - withLocalDateTimeRangeCallback
```
public Agenda withLocalDateTimeRangeCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,java.lang.Void> value)
```
  - createAppointmentCallbackProperty
```
@Deprecated
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment>> createAppointmentCallbackProperty()
```
    Deprecated.
    
    addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one. So you need to implement this callback and create an appointment. The calendars in the provided range specify the start and end times, they can be used to create the new appointment (they do not need to be cloned). Null may be returned to indicate that no appointment was created.
    
    See Also:
    
    getCreateAppointmentCallback(), setCreateAppointmentCallback(Callback)
  - getCreateAppointmentCallback
```
@Deprecated
public javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment> getCreateAppointmentCallback()
```
    Deprecated.
  - setCreateAppointmentCallback
```
@Deprecated
public void setCreateAppointmentCallback(javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment> value)
```
    Deprecated.
  - withCreateAppointmentCallback
```
@Deprecated
public Agenda withCreateAppointmentCallback(javafx.util.Callback<Agenda.CalendarRange,Agenda.Appointment> value)
```
    Deprecated.
  - newAppointmentCallbackProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment>> newAppointmentCallbackProperty()
```
    addAppointmentCallback: Since the Agenda is not the owner of the appointments but only dictates an interface, it does not know how to create a new one. So you need to implement this callback and create an appointment. The calendars in the provided range specify the start and end times, they can be used to create the new appointment (they do not need to be cloned). Null may be returned to indicate that no appointment was created.
    
    See Also:
    
    getNewAppointmentCallback(), setNewAppointmentCallback(Callback)
  - getNewAppointmentCallback
```
public javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment> getNewAppointmentCallback()
```
  - setNewAppointmentCallback
```
public void setNewAppointmentCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment> value)
```
  - withNewAppointmentCallback
```
public Agenda withNewAppointmentCallback(javafx.util.Callback<Agenda.LocalDateTimeRange,Agenda.Appointment> value)
```
  - editAppointmentCallbackProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>> editAppointmentCallbackProperty()
```
    editAppointmentCallback: Agenda has a default popup, but maybe you want to do something yourself. If so, you need to set this callback method and open your own window. Because Agenda does not dictate a event/callback in the implementation of appointment, it has no way of being informed of changes on the appointment. So when the custom edit is done, make sure that control gets updated, if this does not happen automatically through any of the existing listeners, then call refresh().
    
    See Also:
    
    getEditAppointmentCallback(), setEditAppointmentCallback(Callback)
  - getEditAppointmentCallback
```
public javafx.util.Callback<Agenda.Appointment,java.lang.Void> getEditAppointmentCallback()
```
  - setEditAppointmentCallback
```
public void setEditAppointmentCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)
```
  - withEditAppointmentCallback
```
public Agenda withEditAppointmentCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)
```
  - actionCallbackProperty
```
public javafx.beans.property.ObjectProperty<javafx.util.Callback<Agenda.Appointment,java.lang.Void>> actionCallbackProperty()
```
    actionCallback: This triggered when the action is called on an appointment, usually this is a double click
    
    See Also:
    
    getActionCallback(), setActionCallback(Callback)
  - getActionCallback
```
public javafx.util.Callback<Agenda.Appointment,java.lang.Void> getActionCallback()
```
  - setActionCallback
```
public void setActionCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)
```
  - withActionCallback
```
public Agenda withActionCallback(javafx.util.Callback<Agenda.Appointment,java.lang.Void> value)
```
  - refresh
```
public void refresh()
```
    Force the agenda to completely refresh itself
  - print
```
public void print(javafx.print.PrinterJob job)
```
    Prints the current agenda using the given printer job. <p>This method does not modify the state of the job, nor does it call PrinterJob.endJob(), so the job may be safely reused afterwards.
    
    This method is experimental.
    
    Parameters:
    
    job - printer job used for printing

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class Agenda

Agenda

Properties:

Appointments

Calendar, LocalDateTime or ZonedDateTime

AppointmentGroup

Callbacks

Action callback

Adding appointments using the mouse

Editing appointments

Property Summary

Properties inherited from class javafx.scene.control.Control

Properties inherited from class javafx.scene.layout.Region

Properties inherited from class javafx.scene.Parent

Properties inherited from class javafx.scene.Node

Nested Class Summary

Field Summary

Fields inherited from class javafx.scene.layout.Region

Fields inherited from class javafx.scene.Node

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.control.Control

Methods inherited from class javafx.scene.layout.Region

Methods inherited from class javafx.scene.Parent

Methods inherited from class javafx.scene.Node

Methods inherited from class java.lang.Object

Property Detail

locale

allowDragging

allowResize

calendarRangeCallback

localDateTimeRangeCallback

createAppointmentCallback

newAppointmentCallback

editAppointmentCallback

actionCallback

Constructor Detail

Agenda

Method Detail

getUserAgentStylesheet

createDefaultSkin

withId

appointments

appointmentGroups

localeProperty

getLocale

setLocale

withLocale

allowDraggingProperty

getAllowDragging

setAllowDragging

withAllowDragging

allowResizeProperty

getAllowResize

setAllowResize

withAllowResize

displayedCalendar

getDisplayedCalendar

setDisplayedCalendar

withDisplayedCalendar

displayedLocalDateTime

getDisplayedLocalDateTime

setDisplayedLocalDateTime

withDisplayedLocalDateTime

selectedAppointments

calendarRangeCallbackProperty

getCalendarRangeCallback

setCalendarRangeCallback

withCalendarRangeCallback

localDateTimeRangeCallbackProperty

getLocalDateTimeRangeCallback

setLocalDateTimeRangeCallback

withLocalDateTimeRangeCallback

createAppointmentCallbackProperty

getCreateAppointmentCallback

setCreateAppointmentCallback

withCreateAppointmentCallback

newAppointmentCallbackProperty

getNewAppointmentCallback

setNewAppointmentCallback