Package com.hp.lft.sdk.wpf

Interface Calendar

All Superinterfaces:
Clickable, DoubleClickable, EnabledProvider, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, SupportsNativeObject, TestObject, TestObjectDescriber, UiObjectBase, UiObjectBase, VisibleProvider, WaitUntilEnabledProvider, WaitUntilVisibleProvider
public interface Calendar extends UiObjectBase, TestObject
A calendar or a date picker .NET WPF object.

  • Method Details

    • getDate

      Date getDate() throws GeneralLeanFtException
      Returns the date associated with this calendar. If a date range is associated, returns the start date.
      Note: If you try to retrieve a date value from a WPF calendar object before performing an operation on it, an exception is returned.
      Therefore, make sure to precede the retrieve value step with a step that performs an operation on the calendar, such as setting the date on the calendar to the current date.
      Returns:
      the date
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setDate

      void setDate(Date date) throws GeneralLeanFtException
      Sets the date of this calendar.
      Parameters:
      date - the date of the calendar
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getDateRanges

      DateRange[] getDateRanges() throws GeneralLeanFtException
      Returns the selected date ranges of this Month Calendar control in multi-selection mode.
      If a single date is selected in the calendar:
      • DateRanges returns an array with a single element.
      • Both DateRange.getStartDate() and DateRange.getEndDate() are equal to the selected date.
      Returns:
      ranges of dates
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setDateRange

      void setDateRange(DateRange dateRange) throws GeneralLeanFtException
      Sets the date range of this calendar or the date of this date picker.
      If a single date is selected in the calendar, the getDateRanges method will return a DateRange array with a single element, where both DateRange.getStartDate() and DateRange.getEndDate() of the element are equal to the selected date.
      Parameters:
      dateRange - the date range
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setDateRange

      void setDateRange(Date startDate, Date endDate) throws GeneralLeanFtException
      Sets the date range of this calendar or the date of this date picker.
      Parameters:
      startDate - the start of the range
      endDate - the end of the range
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setDateRanges

      void setDateRanges(DateRange... dateRanges) throws GeneralLeanFtException
      Sets the date ranges of this calendar or the dates of this date picker.
      Parameters:
      dateRanges - the date ranges to set
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setMonth

      void setMonth(int month) throws GeneralLeanFtException
      Sets the month in this calendar.
      Parameters:
      month - a number from 1 to 12
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • setYear

      void setYear(int year) throws GeneralLeanFtException
      Sets the year in this calendar.
      Parameters:
      year - the year
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getDateFormatType

      DateFormatType getDateFormatType() throws GeneralLeanFtException
      Returns the date format type.
      Returns:
      the DateFormateType
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getParentText

      String getParentText() throws GeneralLeanFtException
      Returns the text associated with the parent object of this object.
      Returns:
      the text
      Throws:
      GeneralLeanFtException - if error occurs during execution

    • getHelpText

      String getHelpText() throws GeneralLeanFtException
      Returns the help text associated with this object.
      Returns:
      the help text
      Throws:
      GeneralLeanFtException - if error occurs during execution