com.calendarfx.view.VirtualGrid Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of view Show documentation
There is a newer version: 11.12.7
/*
 *  Copyright (C) 2017 Dirk Lemmermann Software & Consulting (dlsc.com)
 *
 *  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 com.calendarfx.view;

import impl.com.calendarfx.view.util.Util;

import java.time.DayOfWeek;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.temporal.ChronoUnit;

import static java.util.Objects.requireNonNull;

/**
 * A virtual grid used to make entries snap to virtual grid lines while being
 * edited.
 *
 * @see DateControl#setVirtualGrid(VirtualGrid)
 */
public class VirtualGrid {

    /**
     * The virtual grid in {@link DateControl} can never be null, hence we need
     * a virtual grid that does nothing, the OFF grid.
     *
     * @see DateControl#setVirtualGrid(VirtualGrid)
     */
    public static final VirtualGrid OFF = new VirtualGrid(Messages.getString("VirtualGrid.OFF"), Messages.getString("VirtualGrid.OFF_SHORT"), //$NON-NLS-1$ //$NON-NLS-2$
            ChronoUnit.SECONDS, 1) {

        @Override
        public Instant adjustTime(Instant instant, ZoneId zoneId,
                                  boolean roundUp, DayOfWeek firstDayOfWeek) {
            return instant;
        }

        @Override
        public LocalDateTime adjustTime(LocalDateTime time, boolean roundUp,
                                        DayOfWeek firstDayOfWeek) {
            return time;
        }

        @Override
        public ZonedDateTime adjustTime(ZonedDateTime time, boolean roundUp,
                                        DayOfWeek firstDayOfWeek) {
            return time;
        }
    };

    private String name;
    private String shortName;
    private ChronoUnit unit;
    private int amount;

    /**
     * Constructs a new virtual grid.
     *
     * @param name
     *            the name of the grid (e.g. "15 Minutes")
     * @param shortName
     *            the short name of the grid (e.g. "15 Min.")
     * @param unit
     *            the time unit of the grid (seconds, minutes, hours)
     * @param amount
     *            the amount of the unit (5, 10, 15 minutes)
     */
    public VirtualGrid(String name, String shortName, ChronoUnit unit,
                       int amount) {
        this.name = requireNonNull(name);
        this.shortName = requireNonNull(shortName);
        this.unit = requireNonNull(unit);

        if (amount <= 0) {
            throw new IllegalArgumentException(
                    "grid amount must be larger than 0 but was " + amount); //$NON-NLS-1$
        }

        this.amount = amount;
    }

    /**
     * Returns the grid name that can be used for grid selection controls.
     *
     * @return the name of the grid settings
     */
    public final String getName() {
        return name;
    }

    /**
     * Returns the grid short name that can be used for grid selection controls.
     *
     * @return the short name of the grid settings
     */
    public final String getShortName() {
        return shortName;
    }

    /**
     * The temporal unit used for the grid.
     *
     * @return the temporal unit of the grid
     */
    public final ChronoUnit getUnit() {
        return unit;
    }

    /**
     * The number of units used for the grid.
     *
     * @return the number of units
     */
    public final int getAmount() {
        return amount;
    }

    /**
     * Adjusts the given time either rounding it up or down.
     *
     * @param time
     *            the time to adjust
     * @param roundUp
     *            the rounding direction
     * @param firstDayOfWeek
     *            the first day of the week (needed for rounding weeks)
     * @return the adjusted time
     */
    public ZonedDateTime adjustTime(ZonedDateTime time, boolean roundUp,
                                    DayOfWeek firstDayOfWeek) {
        Instant instant = time.toInstant();
        ZoneId zoneId = time.getZone();
        instant = adjustTime(instant, zoneId, roundUp, firstDayOfWeek);
        return ZonedDateTime.ofInstant(instant, zoneId);
    }

    /**
     * Adjusts the given instant either rounding it up or down.
     *
     * @param instant
     *            the instant to adjust
     * @param zoneId
     *            the time zone
     * @param roundUp
     *            the rounding direction
     * @param firstDayOfWeek
     *            the first day of the week (needed for rounding weeks)
     * @return the adjusted instant
     */
    public Instant adjustTime(Instant instant, ZoneId zoneId, boolean roundUp,
                              DayOfWeek firstDayOfWeek) {

        requireNonNull(instant);
        requireNonNull(zoneId);
        requireNonNull(firstDayOfWeek);

        ZonedDateTime zonedDateTime = ZonedDateTime.ofInstant(instant, zoneId);
        if (roundUp) {
            zonedDateTime = zonedDateTime.plus(getAmount(), getUnit());
        }

        zonedDateTime = Util.truncate(zonedDateTime, getUnit(), getAmount(),
                firstDayOfWeek);

        return Instant.from(zonedDateTime);
    }

    /**
     * Adjusts the given time either rounding it up or down.
     *
     * @param time
     *            the time to adjust
     * @param roundUp
     *            the rounding direction
     * @param firstDayOfWeek
     *            the first day of the week (needed for rounding weeks)
     * @return the adjusted time
     */
    public LocalDateTime adjustTime(LocalDateTime time, boolean roundUp,
                                    DayOfWeek firstDayOfWeek) {
        requireNonNull(time);

        if (roundUp) {
            time = time.plus(getAmount(), getUnit());
        }

        return Util.truncate(time, getUnit(), getAmount(), firstDayOfWeek);
    }

    @Override
    public String toString() {
        return "VirtualGrid [name=" + name + ", shortName=" + shortName //$NON-NLS-1$ //$NON-NLS-2$
                + ", unit=" + unit + ", amount=" + amount + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    }
}