org.dominokit.domino.ui.datepicker.MonthsPicker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation
There is a newer version: 2.0.3
/*
 * Copyright © 2019 Dominokit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.dominokit.domino.ui.datepicker;

import static org.dominokit.domino.ui.utils.Domino.*;

import elemental2.dom.HTMLDivElement;
import java.util.Date;
import org.dominokit.domino.ui.elements.DivElement;
import org.dominokit.domino.ui.style.BooleanCssClass;
import org.dominokit.domino.ui.utils.BaseDominoElement;
import org.gwtproject.i18n.shared.cldr.DateTimeFormatInfo;

/**
 * Represents a visual component for picking months. The component displays all the months in a
 * year, and users can select any month by clicking on it.
 *
 * Usage Example:
 *
 * 
 * IsCalendar calendar = ...; // Implementation of IsCalendar
 * MonthsPicker picker = MonthsPicker.create(calendar);
 * 
 *
 * @see BaseDominoElement
 */
public class MonthsPicker extends BaseDominoElement
    implements CalendarStyles, CalendarViewListener {

  private final DivElement root;
  private final IsCalendar calendar;

  /**
   * Constructs a new MonthsPicker for the provided calendar.
   *
   * @param calendar The calendar reference used by this MonthsPicker.
   */
  public MonthsPicker(IsCalendar calendar) {
    this.calendar = calendar;
    this.root = div().addCss(dui_month_selector);
    updateView();
    this.calendar.bindCalenderViewListener(this);
    init(this);
  }

  /**
   * Factory method to create a new MonthsPicker for the provided calendar.
   *
   * @param isCalendar The calendar reference.
   * @return A new instance of MonthsPicker.
   */
  public static MonthsPicker create(IsCalendar isCalendar) {
    return new MonthsPicker(isCalendar);
  }

  /**
   * Updates the view of the MonthsPicker to reflect any changes in the calendar or the date-time
   * format.
   *
   * @return The updated MonthsPicker.
   */
  MonthsPicker updateView() {
    this.root.clearElement();
    String[] months = this.calendar.getDateTimeFormatInfo().monthsShort();

    int counter = 0;
    while (counter < 12) {
      DivElement monthsRow = div().addCss(dui_months_row);
      this.root.appendChild(monthsRow);
      for (int i = 0; i < 3; i++) {
        final int month = counter;
        monthsRow.appendChild(
            div()
                .addCss(
                    dui_month_selector_month,
                    BooleanCssClass.of(dui_current_month, isCurrentMonth(counter)),
                    BooleanCssClass.of(dui_selected_month, isSelectedMonth(counter)))
                .textContent(months[counter])
                .addClickListener(
                    evt -> {
                      Date calendarDate = calendar.getDate();
                      Date date = new Date(calendarDate.getTime());
                      date.setDate(1);
                      date.setMonth(month);
                      dispatchEvent(CalendarCustomEvents.dateNavigationChanged(date.getTime()));
                    }));
        counter++;
      }
    }
    return this;
  }

  /**
   * Listener method for when the date-time format changes. It updates the MonthsPicker view
   * accordingly.
   *
   * @param dateTimeFormatInfo The new date-time format information.
   */
  @Override
  public void onDateTimeFormatInfoChanged(DateTimeFormatInfo dateTimeFormatInfo) {
    updateView();
  }

  /**
   * Checks if a given month (by index) is the current month.
   *
   * @param counter The month's index (0-based).
   * @return True if it's the current month, false otherwise.
   */
  private boolean isCurrentMonth(int counter) {
    return new Date().getMonth() == counter;
  }

  /**
   * Checks if a given month (by index) is the selected month in the calendar.
   *
   * @param counter The month's index (0-based).
   * @return True if it's the selected month, false otherwise.
   */
  private boolean isSelectedMonth(int counter) {
    return counter == this.calendar.getDate().getMonth();
  }

  /**
   * Returns the root element of the MonthsPicker.
   *
   * @return The root HTMLDivElement element.
   */
  @Override
  public HTMLDivElement element() {
    return root.element();
  }
}