com.paypal.selion.platform.html

Class DatePicker

java.lang.Object

com.paypal.selion.platform.html.AbstractElement

com.paypal.selion.platform.html.DatePicker

All Implemented Interfaces:

Clickable, Hoverable

public class DatePicker
extends AbstractElement

DatePicker is a widget which shows up a monthly calendar when clicked. It comes with "previous month" and "next month" navigators, and a tablet of clickable days in a month. Users can navigate by clicking these item to arrive at a desired date. How to make DatePicker work in excel page data declaration? Since the DatePicker needs other three object to operate properly (Previous Button, Next Button, and Date Label) these object also need to declare and initialize before the DatePicker can work. To initialize this DatePicker a user needs to call datePickerInit before perform any actions on the DatePicker.

Field Summary

Fields inherited from class com.paypal.selion.platform.html.AbstractElement

LOG_DEMARKER

Constructor Summary

Constructors

Constructor and Description
DatePicker(ParentTraits parent, String datePickerLocator) Use this constructor to create a DatePicker contained within a parent.
DatePicker(String datePickerLocator) Using this constructor will create a DatePicker object with default prev month, next month, day of month, and date text (month and year) locators.
DatePicker(String datePickerLocator, String controlName) Use this constructor to override default controlName for logging purposes.
DatePicker(String datePickerLocator, String controlName, ParentTraits parent) Use this constructor to create a DatePicker contained within a parent.
DatePicker(String datePickerLocator, String prevMonthLocator, String nextMonthLocator, String dateTextLocator) This constructor provides a way for users to initialize DatePicker for prev month, next month, and date text (month and year) locators.

Method Summary

Methods

Modifier and Type	Method and Description
void	clickDay(int dayOfMonth) Click on the day-of-month tablet to select the desired day of the month to set date.
void	clickNextMonth() Advances one month to the future.
void	clickPrevMonth() Goes back one month in history.
void	datePickerInit(String prevMonthLocator, String nextMonthLocator, String dateTextLocator) DatePicker comes with default locators for widget controls previous button, next button, and date text.
String	getDate() This function return the current date of a date picker in the format of "MM/dd/yyyy"
String	getDateText() Gets the current setting month and year from the calendar header.
String	getDayOfMonth() Get the current day of month of a date picker.
String	getMonth() Get the current month of a date picker.
String	getYear() Get the current year of a date picker.
void	reset() Clears the date picker.
void	setDate(Calendar to) This is the main function of the DatePicker object to select the date specified by the input parameter.
void	setDate(int year, int month, int day) This function set the date on the DatePicker using the year, month and day provided.
void	setDate(String date) This function set the date on the DatePicker using the input paramter in the format of "MM.dd.yyyy" string

Methods inherited from class com.paypal.selion.platform.html.AbstractElement

click, click, clickAndExpect, clickAndExpectOneOf, clickAndExpectOneOf, clickonly, getAttribute, getControlName, getDispatcher, getElement, getElements, getLocator, getParent, getProperty, getText, getValue, getWaitTime, hover, isElementPresent, isEnabled, isVisible, logUIAction, logUIActions, processScreenShot, resolveControlNameToUseForLogs, setParent, setProperty, validatePresenceOfAlert

Methods inherited from class java.lang.Object

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

Constructor Detail

DatePicker

public DatePicker(String datePickerLocator)

Using this constructor will create a DatePicker object with default prev month, next month, day of month, and date text (month and year) locators. Usage:

 DatePicker datePicker = new DatePicker("//input[@id='datePicker']");
 

Parameters:

datePickerLocator - the calendar field locator, not the widget

DatePicker

public DatePicker(String datePickerLocator,
          String controlName)

Use this constructor to override default controlName for logging purposes. Default controlName would be the element locator.

Parameters:

datePickerLocator - the calendar field element locator, not the widget

controlName - the control name used for logging

DatePicker

public DatePicker(ParentTraits parent,
          String datePickerLocator)

Use this constructor to create a DatePicker contained within a parent.

Parameters:

parent - - A ParentTraits object that represents the parent element for this element.

datePickerLocator - - the calendar field element locator, not the widget.

DatePicker

public DatePicker(String datePickerLocator,
          String controlName,
          ParentTraits parent)

Use this constructor to create a DatePicker contained within a parent.

Parameters:

datePickerLocator - the calendar field element locator, not the widget

controlName - the control name used for logging

parent - - A ParentTraits object that represents the parent element for this element.

DatePicker

public DatePicker(String datePickerLocator,
          String prevMonthLocator,
          String nextMonthLocator,
          String dateTextLocator)

This constructor provides a way for users to initialize DatePicker for prev month, next month, and date text (month and year) locators.

Parameters:

datePickerLocator - calendar field locator, not the widget

prevMonthLocator - calendar widget prev month

nextMonthLocator - calendar widget next month

dateTextLocator - calendar widget month and year text

Method Detail

clickNextMonth

public void clickNextMonth()

Advances one month to the future.

clickPrevMonth

public void clickPrevMonth()

Goes back one month in history.

clickDay

public void clickDay(int dayOfMonth)

Click on the day-of-month tablet to select the desired day of the month to set date.

Parameters:

dayOfMonth - day to select from calendar widget

getDateText

public String getDateText()

Gets the current setting month and year from the calendar header.

Returns:

current setting month and year

setDate

public void setDate(Calendar to)

This is the main function of the DatePicker object to select the date specified by the input parameter. It will calculate how many time needed to click on the "next month" or "previous month" button to arrive at the correct month and year in the input parameters. It then click on the day-of-month tablet to select the correct day-of-month as specified in the input param.

Parameters:

to - destination date as Java Calendar format.

setDate

public void setDate(String date)

This function set the date on the DatePicker using the input paramter in the format of "MM.dd.yyyy" string

Parameters:

date - string input date format of "MM/dd/yyyy"

setDate

public void setDate(int year,
           int month,
           int day)

This function set the date on the DatePicker using the year, month and day provided. Note: month is 0-based (January - 0)

Parameters:

year - The full year.

month - The month. (0-based, 0 for January)

day - The day of the month.

getDate

public String getDate()

This function return the current date of a date picker in the format of "MM/dd/yyyy"

Returns:

the current date

getMonth

public String getMonth()

Get the current month of a date picker.

Returns:

the current month

getYear

public String getYear()

Get the current year of a date picker.

Returns:

the current year

getDayOfMonth

public String getDayOfMonth()

Get the current day of month of a date picker.

Returns:

the current day of month

datePickerInit

public void datePickerInit(String prevMonthLocator,
                  String nextMonthLocator,
                  String dateTextLocator)

DatePicker comes with default locators for widget controls previous button, next button, and date text. This method gives access to override these default locators.

Parameters:

prevMonthLocator - calendar widget prev month

nextMonthLocator - calendar widget next month

dateTextLocator - calendar widget month and year text

reset

public void reset()

Clears the date picker. Some browsers require clicking on an element outside of the date picker field to properly reset the calendar to today's date.