Top Description Inners Fields Constructors Methods
com.calendarfx.view.print

public Class PrintablePage

extends DateControl
Class Inheritance
Imports
com.calendarfx.view.DateControl, .DayViewBase, .DetailedDayView, .DetailedWeekView, .MonthView, com.calendarfx.view.print.PaperView.MarginType, impl.com.calendarfx.view.print.PrintablePageSkin, javafx.beans.InvalidationListener, .Observable, javafx.beans.binding.Bindings, javafx.beans.property.BooleanProperty, .DoubleProperty, .ObjectProperty, .ReadOnlyIntegerProperty, .ReadOnlyIntegerWrapper, .ReadOnlyObjectProperty, .ReadOnlyObjectWrapper, .SimpleBooleanProperty, .SimpleDoubleProperty, .SimpleObjectProperty, javafx.event.Event, .WeakEventHandler, javafx.print.PageOrientation, .Paper, javafx.scene.control.Skin, javafx.scene.input.KeyEvent, .MouseEvent, java.time.LocalDate, .LocalTime, java.time.format.DateTimeFormatter, java.util.HashMap, .Map, .Objects

A control that is designed and laid out in such a way that it can be nicely printed. The control is capable of switching between a day view, a week view, or a month view.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class

Field Summary

Modifier and TypeField and Description
private final DoubleProperty
public static final String
private final DetailedDayView
private final DetailedWeekView
private final ObjectProperty<Map<ViewType, DateTimeFormatter>>
public static final String
private final DoubleProperty
private final ObjectProperty<PaperView.MarginType>
private final MonthView
private final ReadOnlyObjectWrapper<LocalDate>
private final ReadOnlyIntegerWrapper
private final ReadOnlyObjectWrapper<LocalDate>
private final ObjectProperty<Paper>
private final PrintablePage.PrintPeriodSplitter
private final ObjectProperty<LocalDate>
private final ObjectProperty<LocalDate>
private final DoubleProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final BooleanProperty
private final DoubleProperty
private final ReadOnlyIntegerWrapper
private final ReadOnlyObjectWrapper<DateControl>
private final ObjectProperty<ViewType>
private final WeakEventHandler<MouseEvent>
Inherited from com.calendarfx.view.DateControl:
usagePolicy

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final boolean
back()

public final void
public final DoubleProperty

Returns:

the bottom margin
bottomMarginProperty
()

Stores the bottom print margin value.

protected void
configureDetailedDayView(DetailedDayView
view.
newDetailedDayView
,
boolean
define if trim or not the hours in the day view
trimTimeBounds
)

The idea of this method is to be able to change the default configuration of the detailed day view in the preview pane.

protected void
configureDetailedWeekView(DetailedWeekView
view.
newDetailedWeekView
,
boolean
define if trim or not the hours in the week view
trimTimeBounds
)

The idea of this method is to be able to change the default configuration of the detailed week view in the preview pane.

protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

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

private DetailedDayView

Returns:

the detailed day view
createDetailedDayView
()

Default configuration for detailed day view in the preview pane.

private DetailedWeekView

Returns:

the detailed week view
createDetailedWeekView
()

Default configuration for Detailed Week view in the preview Pane.

protected MonthView

Returns:

the month view
createMonthView
()

Default configuration for Month view in the preview pane.

public ObjectProperty<Map<ViewType, DateTimeFormatter>>

Returns:

the ObjectProperty
formatterMapProperty
()

Object property which contains a Map with the custom date time formatters.

public final double

Returns:

the bottom margin
getBottomMargin
()

Returns the value of the bottomMarginProperty().

public final DetailedDayView
public Map<ViewType, DateTimeFormatter>

Returns:

the Formatter Map.
getFormatterMap
()

Gets the Formatter Map from the property.

public final double

Returns:

the left margin
getLeftMargin
()

Returns the value of the leftMarginProperty().

public final PaperView.MarginType

Returns:

the margin type (custom, default, minimum)
getMarginType
()

Returns the value of marginTypeProperty().

public final MonthView
public final LocalDate
public final int
public final LocalDate
public final Paper
public final LocalDate
public final LocalDate
public final double

Returns:

the right margin
getRightMargin
()

Returns the value of the rightMarginProperty().

public final double

Returns:

the top margin
getTopMargin
()

Returns the value of the topMarginProperty().

public final int
public final DateControl
public final ViewType
public final DetailedWeekView
public final boolean
public final boolean
public final boolean
public final boolean
public final boolean
public final DoubleProperty

Returns:

the left margin
leftMarginProperty
()

Stores the left print margin value.

public final ObjectProperty<PaperView.MarginType>

Returns:

the requested margin types
marginTypeProperty
()

A property used to store the currently requested margin type (custom, minimum, or default).

public final boolean
next()

public final ReadOnlyObjectProperty<LocalDate>
public final ReadOnlyIntegerProperty
public final ReadOnlyObjectProperty<LocalDate>
public final ObjectProperty<Paper>
public final ObjectProperty<LocalDate>
public final ObjectProperty<LocalDate>
private void
removeDataBindings()

Removes all bindings related with the calendar sources and visibility map.

public final DoubleProperty

Returns:

the right margin
rightMarginProperty
()

Stores the right print margin value.

public final void
setBottomMargin(double
the bottom margin
margin
)

Sets the value of the bottomMarginProperty().

public void
setDayDateTimeFormatter(DateTimeFormatter
the DateTimeFormatter
formatter
)

Sets the DateTimeFormatter on the Day Label located in the day page.

public final void
setLeftMargin(double
the left margin
margin
)

Sets the value of the leftMarginProperty().

public final void
setMarginType(PaperView.MarginType
the margin type (custom, default, minimum)
type
)

Sets the value of marginTypeProperty().

public void
setMonthDateTimeFormatter(DateTimeFormatter
the DateTimeFormatter
formatter
)

Sets the DateTimeFormatter on the Month Label located in the month page.

private void
private void
setPageNumber(int number)

public void
public final void
setPaper(Paper paper)

public final void
public final void
public final void
setRightMargin(double
the right margin
margin
)

Sets the value of the rightMarginProperty().

public final void
setShowAllDayEntries(boolean show)

public final void
setShowCalendarKeys(boolean show)

public final void
setShowEntryDetails(boolean show)

public final void
setShowMiniCalendars(boolean show)

public final void
setShowTimedEntries(boolean show)

public final void
setTopMargin(double
the top margin
margin
)

Sets the value of the topMarginProperty().

private void
setTotalPages(int total)

private void
public final void
public void
setWeekDateTimeFormatter(DateTimeFormatter
the DateTimeFormatter
formatter
)

Sets the DateTimeFormatter on the Week Label located in the week page.

public final BooleanProperty
public final BooleanProperty
public final BooleanProperty
public final BooleanProperty
public final BooleanProperty
public final DoubleProperty

Returns:

the top margin
topMarginProperty
()

Stores the top print margin value.

public final ReadOnlyIntegerProperty
public final void
private void
private void
public final ReadOnlyObjectProperty<DateControl>
public final ObjectProperty<ViewType>
Inherited from com.calendarfx.view.DateControl:
availabilityCalendarPropertyavailabilityFillPropertyavailabilityGridPropertybindcalendarSourceFactoryPropertycalendarsPropertyclearSelectioncontextMenuCallbackPropertycreateCalendarSourcecreateEntryAtcreateEntryAtcreateEntryAtcreateEntryClickCountPropertydateDetailsCallbackPropertydatePropertydefaultCalendarProviderPropertydeselectdraggedEntryPropertyeditAvailabilityPropertyeditEntryeditEntryenableHyperlinksPropertyenableTimeZoneSupportPropertyendTimePropertyentryContextMenuCallbackPropertyentryDetailsCallbackPropertyentryDetailsPopOverContentCallbackPropertyentryEditPolicyPropertyentryFactoryPropertyfindEntryViewgetAvailabilityCalendargetAvailabilityFillgetAvailabilityGridgetAvailableZoneIdsgetBoundDateControlsgetCalendarAtgetCalendarsgetCalendarSourceFactorygetCalendarSourcesgetCalendarVisibilityMapgetCalendarVisibilityPropertygetContextMenuCallbackgetCreateEntryClickCountgetDategetDateDetailsCallbackgetDefaultCalendarProvidergetDraggedEntrygetEndTimegetEntryContextMenuCallbackgetEntryDetailsCallbackgetEntryDetailsPopOverContentCallbackgetEntryEditPolicygetEntryFactorygetFirstDayOfWeekgetLayoutgetPropertySheetItemsgetRequestedTimegetSelectionModegetSelectionsgetStartTimegetTimegetTodaygetUsagePolicygetVirtualGridgetWeekendDaysgetWeekFieldsgetZonedDateTimegetZoneIdgoBackgoForwardgoTodayisCalendarVisibleisEditAvailabilityisEnableHyperlinksisEnableTimeZoneSupportisShowDetailsUponEntryCreationisShowNoonMarkerisShowTodayisSuspendUpdateslayoutPropertyrefreshDatarequestedTimePropertyselectselectionModePropertysetAvailabilityCalendarsetAvailabilityFillsetAvailabilityGridsetCalendarSourceFactorysetCalendarVisibilitysetContextMenuCallbacksetCreateEntryClickCountsetDatesetDateDetailsCallbacksetDefaultCalendarProvidersetDraggedEntrysetEditAvailabilitysetEnableHyperlinkssetEnableTimeZoneSupportsetEndTimesetEntryContextMenuCallbacksetEntryDetailsCallbacksetEntryDetailsPopOverContentCallbacksetEntryEditPolicysetEntryFactorysetLayoutsetRequestedTimesetSelectionModesetShowDetailsUponEntryCreationsetShowNoonMarkersetShowTodaysetStartTimesetSuspendUpdatessetTimesetTodaysetUsagePolicysetVirtualGridsetWeekFieldssetZoneIdshowDateDetailsshowDetailsUponEntryCreationPropertyshowEntryshowNoonMarkerPropertyshowTodayPropertystartTimePropertysuspendUpdatesPropertytimePropertytodayPropertyunbindunbindAllusagePolicyPropertyvirtualGridPropertyvisibleLayersPropertyweekFieldsPropertyzoneIdProperty