Top Description Fields Constructors Methods
com.calendarfx.view

public Class TimeField

extends CalendarFXControl
Class Inheritance
Imports
impl.com.calendarfx.view.TimeFieldSkin, javafx.beans.property.BooleanProperty, .ObjectProperty, .SimpleBooleanProperty, .SimpleObjectProperty, javafx.beans.value.ObservableValue, javafx.collections.FXCollections, .ObservableList, javafx.scene.control.Skin, org.controlsfx.control.PropertySheet, .PropertySheet.Item, java.time.LocalTime, java.util.Optional

A control for editing a LocalTime. Time Field

Field Summary

Modifier and TypeField and Description
private final BooleanProperty
private static final String
private final ObjectProperty<LocalTime>

Constructor Summary

AccessConstructor and Description
public
TimeField()

Constructs a new field.

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

public ObservableList<PropertySheet.Item>

Returns:

the property sheet items
getPropertySheetItems
()

Overrides com.calendarfx.view.CalendarFXControl.getPropertySheetItems.

Returns a list of property items that can be shown by the PropertySheet of ControlsFX.

public final LocalTime

Returns:

the local time value
getValue
()

Returns the value of valueProperty().

public final boolean

Returns:

true if the fields will roll over
isRollOver
()

Returns the value of rollOverProperty().

public final BooleanProperty

Returns:

the roll over flag
rollOverProperty
()

Determines if the field for hours will jump from 23 to 0 when the user increases the hour value (and vice versa when decreasing).

public final void
setRollOver(boolean
if true the fields will roll over (e.g. from 23 to 0 or from 59 to 0).
roll
)

Sets the value of rollOverProperty().

public final void
setValue(LocalTime
the new time
localTime
)

Sets the value of valueProperty().

public final ObjectProperty<LocalTime>

Returns:

the local time value
valueProperty
()

The current local time value of the field.

Inherited from com.calendarfx.view.CalendarFXControl:
getUserAgentStylesheet

Field Detail

rollOverback to summary
private final BooleanProperty rollOver
TIME_FIELD_CATEGORYback to summary
private static final String TIME_FIELD_CATEGORY
valueback to summary
private final ObjectProperty<LocalTime> value

Constructor Detail

TimeFieldback to summary
public TimeField()

Constructs a new field.

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations
@Override
getPropertySheetItemsback to summary
public ObservableList<PropertySheet.Item> getPropertySheetItems()

Overrides com.calendarfx.view.CalendarFXControl.getPropertySheetItems.

Returns a list of property items that can be shown by the PropertySheet of ControlsFX.

Returns:ObservableList<PropertySheet.Item>

the property sheet items

getValueback to summary
public final LocalTime getValue()

Returns the value of valueProperty().

Returns:LocalTime

the local time value

isRollOverback to summary
public final boolean isRollOver()

Returns the value of rollOverProperty().

Returns:boolean

true if the fields will roll over

rollOverPropertyback to summary
public final BooleanProperty rollOverProperty()

Determines if the field for hours will jump from 23 to 0 when the user increases the hour value (and vice versa when decreasing). Same for minutes.

Returns:BooleanProperty

the roll over flag

setRollOverback to summary
public final void setRollOver(boolean roll)

Sets the value of rollOverProperty().

Parameters
roll:boolean

if true the fields will roll over (e.g. from 23 to 0 or from 59 to 0).

setValueback to summary
public final void setValue(LocalTime localTime)

Sets the value of valueProperty().

Parameters
localTime:LocalTime

the new time

valuePropertyback to summary
public final ObjectProperty<LocalTime> valueProperty()

The current local time value of the field.

Returns:ObjectProperty<LocalTime>

the local time value