com.whitestein.lsps.vaadin.ui.components.calendar

Class DumbCalendar.DateRange

java.lang.Object

com.whitestein.lsps.vaadin.ui.components.calendar.DumbCalendar.DateRange

All Implemented Interfaces:

Serializable

Enclosing class:

DumbCalendar

public final class DumbCalendar.DateRange
extends Object
implements Serializable

A simple date range.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
org.joda.time.Instant	from The start date, inclusive.
org.joda.time.Instant	to The end date, inclusive.

Constructor Summary

Constructors

Constructor and Description
DateRange(Date from, Date to) Creates a new date range

Method Summary

Modifier and Type	Method and Description
DumbCalendar.DateRange	expandToMonthly() Creates a new instance which represent an expansion of the current date range to a month.
DumbCalendar.DateRange	expandToWeekly() Creates a week date range based on the middle date of this date range.
DumbCalendar.DateRange	getDailyRange(Date day) Returns a date range which spans over a single day.
org.joda.time.Duration	getDuration() The range duration, 0 or greater.
Date	getMiddleDate() Returns the middle (or the center) date shown in the calendarWrapper.
DumbCalendar.DateRange	getMonthlyRange(Date dayInMonth) Returns a range which spans over a single month.
DumbCalendar.DateRange	getToday() Returns a date range which contains TODAY.
DumbCalendar.DateRange	getWeeklyRange(Date dayInWeek) Returns a date range which spans over a single week.
boolean	isDailyMode() True if this calendar shows a single day.
boolean	isMonthlyMode() True if this calendar shows an entire month..
boolean	isWeeklyMode() True if this calendarWrapper shows a single week.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

from

public final org.joda.time.Instant from

The start date, inclusive. Never null.

to

public final org.joda.time.Instant to

The end date, inclusive. Never null. Greater than or equals to from.

Constructor Detail

DateRange

public DateRange(Date from,
                 Date to)

Creates a new date range

Parameters:

from - the beginning of the range

to - the end of the range

Method Detail

getDuration

public org.joda.time.Duration getDuration()

The range duration, 0 or greater.

Returns:

duration, never null.

isMonthlyMode

public boolean isMonthlyMode()

True if this calendar shows an entire month..

Returns:

true if this calendarWrapper shows entire month, false if it shows a week or just a single day.

isDailyMode

public boolean isDailyMode()

True if this calendar shows a single day.

Returns:

true if this calendarWrapper shows a single day, false if it shows a week or a month.

isWeeklyMode

public boolean isWeeklyMode()

True if this calendarWrapper shows a single week.

Returns:

true if this calendarWrapper shows a single week, false if it shows a single day, or an entire month.

getMiddleDate

public Date getMiddleDate()

Returns the middle (or the center) date shown in the calendarWrapper.

Returns:

the center date, never null.

getWeeklyRange

public DumbCalendar.DateRange getWeeklyRange(Date dayInWeek)

Returns a date range which spans over a single week.

Parameters:

dayInWeek - returns week containing this day, not null.

Returns:

range, never null.

getDailyRange

public DumbCalendar.DateRange getDailyRange(Date day)

Returns a date range which spans over a single day.

Parameters:

day - the day to show, not null.

Returns:

range, never null.

getMonthlyRange

public DumbCalendar.DateRange getMonthlyRange(Date dayInMonth)

Returns a range which spans over a single month.

Parameters:

dayInMonth - returns range containing this day, not null.

Returns:

range, never null.

getToday

public DumbCalendar.DateRange getToday()

Returns a date range which contains TODAY.

Returns:

the new date range, not null. It will be of the same type (weekly, monthly, etc) as the old range.

expandToMonthly

public DumbCalendar.DateRange expandToMonthly()

Creates a new instance which represent an expansion of the current date range to a month.

Returns:

a monthly date range

expandToWeekly

public DumbCalendar.DateRange expandToWeekly()

Creates a week date range based on the middle date of this date range.

Returns:

a week date range