Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.control

Enum Class TimeSlider.Granularity

java.lang.Object

java.lang.Enum<TimeSlider.Granularity>

org.tquadrat.foundation.fx.control.TimeSlider.Granularity

All Implemented Interfaces:

Serializable, Comparable<TimeSlider.Granularity>, Constable

Enclosing class:

TimeSlider

@ClassVersion(sourceVersion="$Id: TimeSlider.java 1121 2024-03-16 16:51:23Z tquadrat $")
@API(status=STABLE,
     since="0.4.6")
public static enum TimeSlider.Granularity
extends Enum<TimeSlider.Granularity>

The granularity for the TimeSlider.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TimeSlider.java 1121 2024-03-16 16:51:23Z tquadrat $

Since:

0.4.6

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIVE_MINUTES	5 minutes steps can be selected.
HALF_HOUR	Half hour steps are possible.
ONE_HOUR	Only full hours can be selected.
ONE_MINUTE	One minute steps can be selected.
QUARTER_HOUR	Quarter hour steps are possible.
TEN_MINUTES	10 minutes steps can be selected.
TWENTY_MINUTES	20 minutes steps can be selected.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	m_MinorTickCount	The minor tick count for this granularity.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Granularity(int tickCount)	Creates a new instance of Granularity.

Method Summary

Modifier and Type	Method	Description
final int	getMinorTickCount()	Returns the minor tick count for this granularity.
static TimeSlider.Granularity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeSlider.Granularity[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONE_HOUR

public static final TimeSlider.Granularity ONE_HOUR

Only full hours can be selected.

HALF_HOUR

public static final TimeSlider.Granularity HALF_HOUR

Half hour steps are possible.

TWENTY_MINUTES

public static final TimeSlider.Granularity TWENTY_MINUTES

20 minutes steps can be selected.

QUARTER_HOUR

public static final TimeSlider.Granularity QUARTER_HOUR

Quarter hour steps are possible.

TEN_MINUTES

public static final TimeSlider.Granularity TEN_MINUTES

10 minutes steps can be selected.

FIVE_MINUTES

public static final TimeSlider.Granularity FIVE_MINUTES

5 minutes steps can be selected.

ONE_MINUTE

public static final TimeSlider.Granularity ONE_MINUTE

One minute steps can be selected.

Field Details

m_MinorTickCount

private final int m_MinorTickCount

The minor tick count for this granularity.

Constructor Details

Granularity

private Granularity(int tickCount)

Creates a new instance of Granularity.

Parameters:

tickCount - The minor tick count for this granularity.

Method Details

values

public static TimeSlider.Granularity[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TimeSlider.Granularity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getMinorTickCount

public final int getMinorTickCount()

Returns the minor tick count for this granularity.

Returns:

The tick count.