Module com.flexganttfx.model

Package com.flexganttfx.model.dateline

Class ChronoUnitGrid

java.lang.Object

com.flexganttfx.model.dateline.VirtualGrid<ChronoUnit>

com.flexganttfx.model.dateline.ChronoUnitGrid

public final class ChronoUnitGrid
extends VirtualGrid<ChronoUnit>

A virtual grid implementation for ChronoUnit.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
ChronoUnitGrid(String name, String shortName, ChronoUnit unit, int amount)	Constructs a new grid.
ChronoUnitGrid(String name, ChronoUnit unit, int amount)	Constructs a new grid.

Method Summary

Modifier and Type	Method	Description
Instant	adjustTime(Instant instant, ZoneId zoneId, boolean roundUp, DayOfWeek firstDayOfWeek)	Adjusts the given instant so that the returned instant will snap to the position defined by the grid settings.
LocalTime	adjustTime(LocalTime time, boolean roundUp)	Adjusts the given local time so that the returned time will snap to the position defined by the grid settings.

Methods inherited from class com.flexganttfx.model.dateline.VirtualGrid

getAmount, getName, getShortName, getUnit, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChronoUnitGrid

public ChronoUnitGrid(String name,
                      String shortName,
                      ChronoUnit unit,
                      int amount)

Constructs a new grid.

Parameters:

name - the grid name as shown in the UI (e.g. "15 Minutes")

shortName - the short name (e.g. "15 Min.")

unit - the chrono unit on which the grid will be based (e.g. "MINUTE")

amount - the amount of the chrono unit (e.g. "15")

Since:

1.0

ChronoUnitGrid

public ChronoUnitGrid(String name,
                      ChronoUnit unit,
                      int amount)

Constructs a new grid. The short name will be the same as the long name.

Parameters:

name - the grid name as shown in the UI (e.g. "15 Minutes")

unit - the chrono unit on which the grid will be based (e.g. "MINUTE")

amount - the amount of the chrono unit (e.g. "15")

Since:

1.0

Method Detail

adjustTime

public Instant adjustTime(Instant instant,
                          ZoneId zoneId,
                          boolean roundUp,
                          DayOfWeek firstDayOfWeek)

Description copied from class: VirtualGrid

Adjusts the given instant so that the returned instant will snap to the position defined by the grid settings.

Specified by:

adjustTime in class VirtualGrid<ChronoUnit>

Parameters:

instant - the time to adjust to a grid location

zoneId - the time zone for which the adjustment is performed (can be different from row to row)

roundUp - a flag signaling whether we want the adjusted time to snap to an earlier or later time (start time or end time)

firstDayOfWeek - the weekday that is considered to be the first day of the week (mostly Monday or Sunday)

Returns:

the grid adjusted time

adjustTime

public LocalTime adjustTime(LocalTime time,
                            boolean roundUp)

Description copied from class: VirtualGrid

Adjusts the given local time so that the returned time will snap to the position defined by the grid settings.

Specified by:

adjustTime in class VirtualGrid<ChronoUnit>

Parameters:

time - the time to adjust to a grid location

roundUp - a flag signaling whether we want the adjusted time to snap to an earlier or later time (start time or end time)

Returns:

the grid adjusted local time