Module com.flexganttfx.model

Package com.flexganttfx.model.dateline

Class SimpleUnitResolution

java.lang.Object

com.flexganttfx.model.dateline.Resolution<SimpleUnit>

com.flexganttfx.model.dateline.SimpleUnitResolution

public final class SimpleUnitResolution
extends Resolution<SimpleUnit>

A resolution type for SimpleUnit that can be used in combination with the SimpleUnitDatelineModel.

Since:

1.0

See Also:

DatelineModel.addResolution(Resolution)

Nested Class Summary

Nested classes/interfaces inherited from class com.flexganttfx.model.dateline.Resolution

Resolution.Position

Constructor Summary

Constructors

Constructor	Description
SimpleUnitResolution(SimpleUnit unit, String format, int stepRate)	Constructs a new resolution for the given unit, format, step rate, and positions.
SimpleUnitResolution(SimpleUnit unit, String format, int stepRate, Resolution.Position... supportedPositions)	Constructs a new resolution for the given unit, format, step rate, and positions.

Method Summary

Modifier and Type	Method	Description
VirtualGrid<SimpleUnit>	createGrid()	Creates a virtual grid for editing operations based on the settings of this resolution.
String	format(Instant instant, ZoneId zoneId)	Formats the given time / instant for the given time zone based on the settings of this resolution.
Instant	increment(Instant instant, ZoneId zoneId)	Increments the given time based on the temoral unit represented by this resolution.
Instant	truncate(Instant temporal, ZoneId zoneId, DayOfWeek firstDayOfWeek)	Truncates the given time based on the temporal unit represented by this resolution.

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

getFormat, getStepRate, getTemporalUnit, isSupportingPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleUnitResolution

public SimpleUnitResolution(SimpleUnit unit,
                            String format,
                            int stepRate,
                            Resolution.Position... supportedPositions)

Constructs a new resolution for the given unit, format, step rate, and positions.

Parameters:

unit - the simple unit supported by this resolution (e.g. TEN)

format - the format how the unit will be shown on the screen

stepRate - the step rate (e.g. "1", "5", "15")

supportedPositions - the position inside the dateline where this resolution can be displayed (top, middle, bottom)

Since:

1.0

SimpleUnitResolution

public SimpleUnitResolution(SimpleUnit unit,
                            String format,
                            int stepRate)

Constructs a new resolution for the given unit, format, step rate, and positions.

Parameters:

unit - the simple unit supported by this resolution (e.g. TEN)

format - the format how the unit will be shown on the screen

stepRate - the step rate (e.g. "1", "5", "15")

Since:

1.0

Method Detail

format

public String format(Instant instant,
                     ZoneId zoneId)

Description copied from class: Resolution

Formats the given time / instant for the given time zone based on the settings of this resolution.

Specified by:

format in class Resolution<SimpleUnit>

Parameters:

instant - the time used for the formatting

zoneId - the time zone

Returns:

the formatted time

truncate

public Instant truncate(Instant temporal,
                        ZoneId zoneId,
                        DayOfWeek firstDayOfWeek)

Description copied from class: Resolution

Truncates the given time based on the temporal unit represented by this resolution. Example: a date located on a Wednesday will be adjusted to a date on the previous Monday (if Monday is the first day of the week in the given time zone).

Specified by:

truncate in class Resolution<SimpleUnit>

Parameters:

temporal - the time to truncate

zoneId - the time zone

firstDayOfWeek - the weekday that is considered to be the first day of the week

Returns:

the truncated time

increment

public Instant increment(Instant instant,
                         ZoneId zoneId)

Description copied from class: Resolution

Increments the given time based on the temoral unit represented by this resolution. Example: if the temporal unit is DAY and the given time is located on Monday, then the incremented time will be Tuesday. If the temporal unit is WEEK then the incremented time will be the Monday of the next week. This function is very important for building the cells in the dateline control.

Specified by:

increment in class Resolution<SimpleUnit>

Parameters:

instant - the time to increment

zoneId - the time zone

Returns:

the incremented time

createGrid

public VirtualGrid<SimpleUnit> createGrid()

Description copied from class: Resolution

Creates a virtual grid for editing operations based on the settings of this resolution.

Specified by:

createGrid in class Resolution<SimpleUnit>

Returns:

the virtual grid