Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.component.calendar

Interface CalendarPanel.Builder

Enclosing class:
CalendarPanel
public static interface CalendarPanel.Builder
Builds a CalendarPanel instance.

  • Method Details

    • locale

      CalendarPanel.Builder locale(Locale locale)
      Specifies the locale, controlling the start of week day and the full date display format. Note that setting the locale also sets firstDayOfWeek(DayOfWeek) and minimalDaysInFirstWeek(int) according to the given locale.
      Parameters:
      locale - the locale
      Returns:
      this builder instance

    • firstDayOfWeek

      CalendarPanel.Builder firstDayOfWeek(DayOfWeek firstDayOfWeek)
      Sets the first day of week, in case it should differ from the one specified by locale(Locale)
      Parameters:
      firstDayOfWeek - the first day of week
      Returns:
      this builder instance

    • minimalDaysInFirstWeek

      CalendarPanel.Builder minimalDaysInFirstWeek(int minimalDaysInFirstWeek)
      Parameters:
      minimalDaysInFirstWeek - the minimal number of days in the first week of the year
      Returns:
      this builder instance

    • value

      CalendarPanel.Builder value(@Nullable LocalDate value)
      Note that calling this method also sets includeTime(boolean) to false. In case of a null value LocalDate.now() is used.
      Parameters:
      value - the initial value
      Returns:
      this builder instance

    • value

      CalendarPanel.Builder value(@Nullable LocalDateTime value)
      Note that calling this method also sets includeTime(boolean) to true. In case of a null value LocalDateTime.now() is used.
      Parameters:
      value - the initial value
      Returns:
      this builder instance

    • includeTime

      CalendarPanel.Builder includeTime(boolean includeTime)
      Parameters:
      includeTime - if true then time fields are included (hours, minutes)
      Returns:
      this builder instance

    • includeTodayButton

      CalendarPanel.Builder includeTodayButton(boolean includeTodayButton)
      Parameters:
      includeTodayButton - true if a 'Today' button for selecting the current date should be included
      Returns:
      this builder instance

    • includeWeekNumbers

      CalendarPanel.Builder includeWeekNumbers(boolean includeWeekNumbers)
      Parameters:
      includeWeekNumbers - true if week numbers should be displayed
      Returns:
      this builder instance

    • keyStroke

      CalendarPanel.Builder keyStroke(ControlKey<?> controlKey, KeyStroke keyStroke)
      Parameters:
      controlKey - the control key
      keyStroke - the keyStroke to assign to the given control
      Returns:
      this builder instance

    • enabled

      CalendarPanel.Builder enabled(ObservableState enabled)
      Parameters:
      enabled - the state controlling the component enabled status
      Returns:
      this builder instance

    • build

      CalendarPanel build()
      Returns:
      a new CalendarPanel based on this builder