Top Description Fields Constructors Methods
com.calendarfx.view

public final Class RequestEvent

extends Event
Class Inheritance
Imports
com.calendarfx.model.Entry, com.calendarfx.view.page.DayPage, .YearPage, javafx.event.Event, .EventTarget, .EventType, java.time.LocalDate, .LocalDateTime, .Year, .YearMonth

A specialized event class used by date controls to request that the UI shows a given date, dateTime, month, or year. This event gets, for example, fired when the user double clicks on a day in the YearPage of the CalendarView. The CalendarView will then automatically switch to the DayPage.

Field Summary

Modifier and TypeField and Description
private LocalDate
private LocalDateTime
private Entry<?>
public static final EventType<RequestEvent>
REQUEST

An event type used to request that the UI shows a certain granularity.

public static final EventType<RequestEvent>
REQUEST_DATE

An event type used to request that the UI shows a certain granularity.

public static final EventType<RequestEvent>
REQUEST_DATE_TIME

An event type used to request that the UI shows a certain granularity.

public static final EventType<RequestEvent>
REQUEST_ENTRY

An event type used to request that the UI shows a certain entry.

public static final EventType<RequestEvent>
REQUEST_WEEK

An event type used to request that the UI shows a certain week.

public static final EventType<RequestEvent>
REQUEST_YEAR

An event type used to request that the UI shows a certain granularity.

public static final EventType<RequestEvent>
REQUEST_YEAR_MONTH

An event type used to request that the UI shows a certain granularity.

private static final long
private int
private Year
private YearMonth
Inherited from javafx.event.Event:
ANYconsumedeventTypeNULL_SOURCE_TARGETtarget

Constructor Summary

AccessConstructor and Description
public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
LocalDate
the day to show
date
)

Constructs a new request event.

public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
LocalDateTime
the day and dateTime to show
dateTime
)

Constructs a new request event.

public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
Year
the year
year
,
int
the week of year number
weekOfYear
)

Constructs a new request event.

public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
YearMonth
the year month to show
yearMonth
)

Constructs a new request event.

public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
Year
the year to show
year
)

Constructs a new request event.

public
RequestEvent(Object
the event source
source
,
EventTarget
the event target
target
,
Entry<?>
the entry to show
entry
)

Constructs a new request event.

Method Summary

Modifier and TypeMethod and Description
public LocalDate

Returns:

the date
getDate
()

Returns the requested date.

public LocalDateTime

Returns:

the date and time
getDateTime
()

Returns the requested date and time.

public Entry<?>

Returns:

the requested entry
getEntry
()

Returns the requested entry.

public int

Returns:

the requested week of year
getWeekOfYear
()

Returns the requested week of year.

public Year

Returns:

the requested year
getYear
()

Returns the requested year.

public YearMonth

Returns:

the requested year and month
getYearMonth
()

Returns the requested year and month.

public String
toString()

Overrides java.util.EventObject.toString.

Returns a String representation of this EventObject.

Inherited from javafx.event.Event:
cloneconsumecopyForfireEventgetEventTypegetTargetisConsumed

Field Detail

dateback to summary
private LocalDate date
dateTimeback to summary
private LocalDateTime dateTime
entryback to summary
private Entry<?> entry
REQUESTback to summary
public static final EventType<RequestEvent> REQUEST

An event type used to request that the UI shows a certain granularity.

REQUEST_DATEback to summary
public static final EventType<RequestEvent> REQUEST_DATE

An event type used to request that the UI shows a certain granularity.

REQUEST_DATE_TIMEback to summary
public static final EventType<RequestEvent> REQUEST_DATE_TIME

An event type used to request that the UI shows a certain granularity.

REQUEST_ENTRYback to summary
public static final EventType<RequestEvent> REQUEST_ENTRY

An event type used to request that the UI shows a certain entry.

REQUEST_WEEKback to summary
public static final EventType<RequestEvent> REQUEST_WEEK

An event type used to request that the UI shows a certain week.

REQUEST_YEARback to summary
public static final EventType<RequestEvent> REQUEST_YEAR

An event type used to request that the UI shows a certain granularity.

REQUEST_YEAR_MONTHback to summary
public static final EventType<RequestEvent> REQUEST_YEAR_MONTH

An event type used to request that the UI shows a certain granularity.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javafx.event.Event.serialVersionUID.

weekOfYearback to summary
private int weekOfYear
yearback to summary
private Year year
yearMonthback to summary
private YearMonth yearMonth

Constructor Detail

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, LocalDate date)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

date:LocalDate

the day to show

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, LocalDateTime dateTime)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

dateTime:LocalDateTime

the day and dateTime to show

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, Year year, int weekOfYear)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

year:Year

the year

weekOfYear:int

the week of year number

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, YearMonth yearMonth)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

yearMonth:YearMonth

the year month to show

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, Year year)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

year:Year

the year to show

RequestEventback to summary
public RequestEvent(Object source, EventTarget target, Entry<?> entry)

Constructs a new request event.

Parameters
source:Object

the event source

target:EventTarget

the event target

entry:Entry<?>

the entry to show

Method Detail

getDateback to summary
public LocalDate getDate()

Returns the requested date.

Returns:LocalDate

the date

getDateTimeback to summary
public LocalDateTime getDateTime()

Returns the requested date and time.

Returns:LocalDateTime

the date and time

getEntryback to summary
public Entry<?> getEntry()

Returns the requested entry.

Returns:Entry<?>

the requested entry

getWeekOfYearback to summary
public int getWeekOfYear()

Returns the requested week of year.

Returns:int

the requested week of year

getYearback to summary
public Year getYear()

Returns the requested year.

Returns:Year

the requested year

getYearMonthback to summary
public YearMonth getYearMonth()

Returns the requested year and month.

Returns:YearMonth

the requested year and month

toStringback to summary
public String toString()

Overrides java.util.EventObject.toString.

Doc from java.util.EventObject.toString.

Returns a String representation of this EventObject.

Returns:String

a String representation of this EventObject

Annotations
@Override