CalendarPopupComponent (Graphene: API for Components encapsulation using Page Fragments 2.0.0.Alpha3 API)

All Superinterfaces:

CalendarComponent
```
public interface CalendarPopupComponent
extends CalendarComponent
```
CalendarPopupComponent represents calendar nested in some kind of popup, it has to be invoked to be shown and has an input associated with it.

Author:

Juraj Huska

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CalendarPopupComponent.CalendarDay` Interface for calendar day.
`static interface`	`CalendarPopupComponent.CalendarMonth` Interface for calendar month.
`static interface`	`CalendarPopupComponent.CalendarWeek` Interface for calendar week.
`static interface`	`CalendarPopupComponent.CalendarYear` Interface for calendar year.
`static interface`	`CalendarPopupComponent.TimeUnit` Interface for a time unit.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearInput()` Clears the input which is showing the selected date.
`CalendarPopupComponent.CalendarDay`	`getDayOfMonth()` Returns the day of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarDay`	`getDayOfMonth(int day)` Returns a specific day of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarDay`	`getDayOfWeek()` Returns the day of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarDay`	`getDayOfWeek(int day)` Returns a specific day of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarDay`	`getDayOfYear()` Returns the day of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarDay`	`getDayOfYear(int day)` Returns a specific day of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarDay>`	`getDaysOfMonth()` Returns all the days of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarDay>`	`getDaysOfWeek()` Returns all the days of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarDay>`	`getDaysOfYear()` Returns all the days of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarMonth`	`getMonth()` Returns the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarMonth`	`getMonth(int month)` Returns a specific month, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarMonth>`	`getMonths()` Returns all the months of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarWeek`	`getWeekOfMonth()` Returns the week of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarWeek`	`getWeekOfMonth(int week)` Returns a specific week of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarWeek`	`getWeekOfYear()` Returns the week of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarWeek`	`getWeekOfYear(int week)` Returns a specific week of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarWeek>`	`getWeeksOfMonth()` Returns all the weeks of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarWeek>`	`getWeeksOfYear()` Returns all the weeks of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarYear`	`getYear()` Returns the year, if there is a date set in the calendar then this date is considered, current date otherwise.
`CalendarPopupComponent.CalendarYear`	`getYear(int year)` Returns a specific year, if there is a date set in the calendar then this date is considered, current date otherwise.
`List<CalendarPopupComponent.CalendarYear>`	`getYears(int from, int to)` Returns all the years from the range determined by `from` and `to`.
`void`	`gotoDateTime(org.joda.time.DateTime dateTime, ScrollingType type)` Set the date on the calendar
`CalendarPopupComponent.CalendarDay`	`gotoNextDay()` Set the next day of the current set date.
`CalendarPopupComponent.CalendarMonth`	`gotoNextMonth()` Set the next month of the current set date.
`CalendarPopupComponent.CalendarYear`	`gotoNextYear()` Set the next year of the current set date.
`CalendarPopupComponent.CalendarDay`	`gotoPreviousDay()` Set the previous day of the current set date.
`CalendarPopupComponent.CalendarMonth`	`gotoPreviousMonth()` Set the previous month of the current set date.
`CalendarPopupComponent.CalendarYear`	`gotoPreviousYear()` Set the previous year of the current set date.
`void`	`hideCalendar()` Hides the calendar if it is in the popup mode, that is it hides the calendar.
`void`	`showCalendar()` Displays the calendar only if it is not already displayed, that is when it can be displayed in the popup mode, it is shown up.

Methods inherited from interface org.jboss.arquillian.graphene.component.object.api.calendar.CalendarComponent
getDateTime, gotoDateTime

- Method Detail
  - clearInput
```
void clearInput()
```
    Clears the input which is showing the selected date.
  - showCalendar
```
void showCalendar()
```
    Displays the calendar only if it is not already displayed, that is when it can be displayed in the popup mode, it is shown up.
  - hideCalendar
```
void hideCalendar()
```
    Hides the calendar if it is in the popup mode, that is it hides the calendar.
  - gotoDateTime
```
void gotoDateTime(org.joda.time.DateTime dateTime,
                ScrollingType type)
```
    Set the date on the calendar
    
    Parameters:
    dateTime - the date to set
    type - the type of way to set the date, for example by mouse
  - gotoNextDay
```
CalendarPopupComponent.CalendarDay gotoNextDay()
```
    Set the next day of the current set date.
    
    Returns:
    the day which was set as the next day
  - gotoNextMonth
```
CalendarPopupComponent.CalendarMonth gotoNextMonth()
```
    Set the next month of the current set date. If the current set date is not part of the next month, then the last day of next month is set.
    
    For example when the current set date is January 30th and this method is invoked, then February 28th is set (February 29th in case of leap year)
    
    Returns:
    the month which was set as the next month
  - gotoNextYear
```
CalendarPopupComponent.CalendarYear gotoNextYear()
```
    Set the next year of the current set date. If the current set date is not part of the next year, then the last day of the next year is set.
    
    For example when the current set date is February 29th (it is the leap year) and this method is invoked, then the February 28th is set.
    
    Returns:
    the year which was set as the next year
  - gotoPreviousDay
```
CalendarPopupComponent.CalendarDay gotoPreviousDay()
```
    Set the previous day of the current set date.
    
    Returns:
    the day which was set as the previous day
  - gotoPreviousMonth
```
CalendarPopupComponent.CalendarMonth gotoPreviousMonth()
```
    Set the previous month of the current set date. If the current set date is not part of the previous month, then the last day of previous month is set.
    
    For example when the current set date is March 30th and this method is invoked, then February 28th is set (February 29th in case of leap year)
    
    Returns:
    the month which was set as the previous month
  - gotoPreviousYear
```
CalendarPopupComponent.CalendarYear gotoPreviousYear()
```
    Set the previous year of the current set date. If the current set date is not part of the previous year, then the last day of the previous year is set.
    
    For example when the current set date is February 29th, 2012 (it is the leap year) and this method is invoked, then the February 28th, 2011 is set.
    
    Returns:
    the year which was set as the previous year
  - getDayOfMonth
```
CalendarPopupComponent.CalendarDay getDayOfMonth()
```
    Returns the day of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the day of the month of the current set date, or if nothing set then the day of the month of the current date
  - getDayOfMonth
```
CalendarPopupComponent.CalendarDay getDayOfMonth(int day)
```
    Returns a specific day of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    day - the number of the day in the month
    
    Returns:
    the particular day of the month of the current set date, or if nothing set then the day of the month of the current date
  - getDaysOfMonth
```
List<CalendarPopupComponent.CalendarDay> getDaysOfMonth()
```
    Returns all the days of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the days of the month of the current set date, or if nothing set then the days of the month of the current date
  - getDayOfWeek
```
CalendarPopupComponent.CalendarDay getDayOfWeek()
```
    Returns the day of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the day of the week of the current set date, or if nothing set then the day of the week of the current date
  - getDayOfWeek
```
CalendarPopupComponent.CalendarDay getDayOfWeek(int day)
```
    Returns a specific day of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    day - the number of the day in the week
    
    Returns:
    the particular day of the week of the current set date, or if nothing set then the day of the week of the current date
  - getDaysOfWeek
```
List<CalendarPopupComponent.CalendarDay> getDaysOfWeek()
```
    Returns all the days of the week, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the days of the week of the current set date, or if nothing set then the days of the week of the current date
  - getDayOfYear
```
CalendarPopupComponent.CalendarDay getDayOfYear()
```
    Returns the day of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the day of the year of the current set date, or if nothing set then the day of the year of the current date
  - getDayOfYear
```
CalendarPopupComponent.CalendarDay getDayOfYear(int day)
```
    Returns a specific day of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    day - the number of the day in the year
    
    Returns:
    the particular day of the year of the current set date, or if nothing set then the day of the year of the current date
  - getDaysOfYear
```
List<CalendarPopupComponent.CalendarDay> getDaysOfYear()
```
    Returns all the days of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the days of the year of the current set date, or if nothing set then the days of the year of the current date
  - getWeekOfMonth
```
CalendarPopupComponent.CalendarWeek getWeekOfMonth()
```
    Returns the week of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the week of the month of the current set date, or if nothing set then the week of the month of the current date
  - getWeekOfMonth
```
CalendarPopupComponent.CalendarWeek getWeekOfMonth(int week)
```
    Returns a specific week of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    week - the number of the week in the currently set month
    
    Returns:
    the particular week of the month of the current set date, or if nothing set then the week of the month of the current date
  - getWeeksOfMonth
```
List<CalendarPopupComponent.CalendarWeek> getWeeksOfMonth()
```
    Returns all the weeks of the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the weeks of the month of the current set date, or if nothing set then the weeks of the month of the current date
  - getWeekOfYear
```
CalendarPopupComponent.CalendarWeek getWeekOfYear()
```
    Returns the week of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the week of the year of the current set date, or if nothing set then the week of the year of the current date
  - getWeekOfYear
```
CalendarPopupComponent.CalendarWeek getWeekOfYear(int week)
```
    Returns a specific week of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    week - the number of the week in the currently set year
    
    Returns:
    the particular week of the year of the current set date, or if nothing set then the week of the year of the current date
  - getWeeksOfYear
```
List<CalendarPopupComponent.CalendarWeek> getWeeksOfYear()
```
    Returns all the weeks of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the weeks of the year of the current set date, or if nothing set then the weeks of the year of the current date
  - getMonth
```
CalendarPopupComponent.CalendarMonth getMonth()
```
    Returns the month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the month of the current set date, or if nothing set then the month of the current date
  - getMonth
```
CalendarPopupComponent.CalendarMonth getMonth(int month)
```
    Returns a specific month, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Parameters:
    month - the number of the month in the set date
    
    Returns:
    the particular month of the current set date, or if nothing set then the month of the current date
  - getMonths
```
List<CalendarPopupComponent.CalendarMonth> getMonths()
```
    Returns all the months of the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    all the months of the year of the current set date, or if nothing set then the months of the current date
  - getYear
```
CalendarPopupComponent.CalendarYear getYear()
```
    Returns the year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the year of the current set date, or if nothing set then the year of the current date
  - getYear
```
CalendarPopupComponent.CalendarYear getYear(int year)
```
    Returns a specific year, if there is a date set in the calendar then this date is considered, current date otherwise.
    
    Returns:
    the particular year of the current set date, or if nothing set then the year of the current date
  - getYears
```
List<CalendarPopupComponent.CalendarYear> getYears(int from,
                                                 int to)
```
    Returns all the years from the range determined by from and to.
    
    Parameters:
    from - the starting year inclusively
    to - the ending year inclusively
    
    Returns:
    all the years from the range

Interface CalendarPopupComponent

Nested Class Summary

Method Summary

Methods inherited from interface org.jboss.arquillian.graphene.component.object.api.calendar.CalendarComponent

Method Detail

clearInput

showCalendar

hideCalendar

gotoDateTime

gotoNextDay

gotoNextMonth

gotoNextYear

gotoPreviousDay

gotoPreviousMonth

gotoPreviousYear

getDayOfMonth

getDayOfMonth

getDaysOfMonth

getDayOfWeek

getDayOfWeek

getDaysOfWeek

getDayOfYear

getDayOfYear

getDaysOfYear

getWeekOfMonth

getWeekOfMonth

getWeeksOfMonth

getWeekOfYear

getWeekOfYear

getWeeksOfYear

getMonth

getMonth

getMonths

getYear

getYear

getYears