Module eu.hansolo.tilesfx
Package eu.hansolo.tilesfx

Class TimeSection

java.lang.Object
eu.hansolo.tilesfx.TimeSection
All Implemented Interfaces:
Comparable<TimeSection>
public class TimeSection extends Object implements Comparable<TimeSection>
Created by hansolo on 31.01.16.

  • Property Details

  • Field Details

  • Constructor Details

    • TimeSection

      public TimeSection()
      Represents an area of a given range, defined by a start and stop time. This class is used for regions and areas in many clocks. It is possible to check a time against the defined range and fire events in case the value enters or leaves the defined region.

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, javafx.scene.paint.Color COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, javafx.scene.paint.Color COLOR, javafx.scene.paint.Color HIGHLIGHT_COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, javafx.scene.paint.Color COLOR, javafx.scene.paint.Color HIGHLIGHT_COLOR, DayOfWeek... DAYS)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, javafx.scene.image.Image ICON, javafx.scene.paint.Color COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, String TEXT, javafx.scene.paint.Color COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, String TEXT, javafx.scene.paint.Color COLOR, javafx.scene.paint.Color TEXT_COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, String TEXT, javafx.scene.image.Image ICON, javafx.scene.paint.Color COLOR, javafx.scene.paint.Color TEXT_COLOR)

    • TimeSection

      public TimeSection(LocalTime START, LocalTime STOP, String TEXT, javafx.scene.image.Image ICON, javafx.scene.paint.Color COLOR, javafx.scene.paint.Color HIGHLIGHT_COLOR, javafx.scene.paint.Color TEXT_COLOR, boolean ACTIVE, DayOfWeek... DAYS)

  • Method Details

    • getStart

      public LocalTime getStart()
      Returns the time when the section begins.
      Returns:
      the time when the section begins

    • setStart

      public void setStart(LocalTime START)
      Defines the time when the section starts.
      Parameters:
      START -

    • startProperty

      public javafx.beans.property.ObjectProperty<LocalTime> startProperty()
      See Also:

    • getStop

      public LocalTime getStop()
      Returns the time when the section ends.
      Returns:
      the time when the section ends

    • setStop

      public void setStop(LocalTime STOP)
      Defines the time when the section ends
      Parameters:
      STOP -

    • stopProperty

      public javafx.beans.property.ObjectProperty<LocalTime> stopProperty()
      See Also:

    • getText

      public String getText()
      Returns the text that was set for the section.
      Returns:
      the text that was set for the section

    • setText

      public void setText(String TEXT)
      Defines the text for the section
      Parameters:
      TEXT -

    • textProperty

      public javafx.beans.property.StringProperty textProperty()
      See Also:

    • getImage

      public javafx.scene.image.Image getImage()
      Returns the image that was defined for the section.
      Returns:
      the image that was defined for the section

    • setIcon

      public void setIcon(javafx.scene.image.Image IMAGE)
      Defines an image for the section.
      Parameters:
      IMAGE -

    • iconProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.image.Image> iconProperty()
      See Also:

    • getColor

      public javafx.scene.paint.Color getColor()
      Returns the color that will be used to colorize the section in a clock.
      Returns:
      the color that will be used to colorize the section

    • setColor

      public void setColor(javafx.scene.paint.Color COLOR)
      Defines the color that will be used to colorize the section in a clock.
      Parameters:
      COLOR -

    • colorProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> colorProperty()
      See Also:

    • getHighlightColor

      public javafx.scene.paint.Color getHighlightColor()
      Returns the color that will be used to colorize the section in a gauge when it is highlighted.
      Returns:
      the color that will be used to colorize a highlighted section

    • setHighlightColor

      public void setHighlightColor(javafx.scene.paint.Color COLOR)
      Defines the color that will be used to colorize a highlighted section
      Parameters:
      COLOR -

    • highlightColorProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> highlightColorProperty()
      See Also:

    • getTextColor

      public javafx.scene.paint.Color getTextColor()
      Returns the color that will be used to colorize the section text.
      Returns:
      the color that will bused to colorize the section text

    • setTextColor

      public void setTextColor(javafx.scene.paint.Color COLOR)
      Defines the color that will be used to colorize the section text
      Parameters:
      COLOR -

    • textColorProperty

      public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> textColorProperty()
      See Also:

    • isActive

      public boolean isActive()
      Gets the value of the property active.
      Property description:

    • setActive

      public void setActive(boolean ACTIVE)
      Sets the value of the property active.
      Property description:

    • activeProperty

      public javafx.beans.property.ReadOnlyBooleanProperty activeProperty()
      See Also:

    • getDays

      public Set<DayOfWeek> getDays()

    • getDaysAsList

      public List<DayOfWeek> getDaysAsList()

    • setDays

      public void setDays(DayOfWeek... DAYS)

    • setDays

      public void setDays(Set<DayOfWeek> DAYS)

    • addDay

      public void addDay(DayOfWeek DAY)

    • removeDay

      public void removeDay(DayOfWeek DAY)

    • clearDays

      public void clearDays()

    • contains

      public boolean contains(LocalTime VALUE)
      Returns true if the given time is within the range between section.getStart() and section.getStop()
      Parameters:
      VALUE -
      Returns:
      true if the given time is within the range of the section

    • checkForTime

      public void checkForTime(LocalTime VALUE)
      Checks if the section contains the given time and fires an event in case the value "entered" or "left" the section. With this one can react if a time "enters"/"leaves" a section. This can be useful to control things like switching lights on if the time enters the region and switching it of again when the time left the region. When calling this method the days won't be taken into account but only the time!!! If the TimeSection is not active no event will be fired.
      Parameters:
      VALUE -

    • checkForTimeAndDay

      public void checkForTimeAndDay(LocalTime VALUE, DayOfWeek DAY)

    • checkForTimeAndDate

      public void checkForTimeAndDate(ZonedDateTime DATE_TIME)
      Checks if the section days contains the day of week of the given ZonedDateTime object and if the section contains the time itself. With this one can react if a time "enters"/"leaves" a section.
      Parameters:
      DATE_TIME -

    • equals

      public boolean equals(TimeSection SECTION)

    • compareTo

      public int compareTo(TimeSection SECTION)
      Specified by:
      compareTo in interface Comparable<TimeSection>

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toJSONString

      public String toJSONString()

    • onTimeSectionEnteredProperty

      public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<TimeSection.TimeSectionEvent>> onTimeSectionEnteredProperty()
      See Also:

    • setOnTimeSectionEntered

      public final void setOnTimeSectionEntered(javafx.event.EventHandler<TimeSection.TimeSectionEvent> value)
      Sets the value of the property onTimeSectionEntered.
      Property description:

    • getOnTimeSectionEntered

      public final javafx.event.EventHandler<TimeSection.TimeSectionEvent> getOnTimeSectionEntered()
      Gets the value of the property onTimeSectionEntered.
      Property description:

    • onTimeSectionLeftProperty

      public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<TimeSection.TimeSectionEvent>> onTimeSectionLeftProperty()
      See Also:

    • setOnTimeSectionLeft

      public final void setOnTimeSectionLeft(javafx.event.EventHandler<TimeSection.TimeSectionEvent> value)
      Sets the value of the property onTimeSectionLeft.
      Property description:

    • getOnTimeSectionLeft

      public final javafx.event.EventHandler<TimeSection.TimeSectionEvent> getOnTimeSectionLeft()
      Gets the value of the property onTimeSectionLeft.
      Property description:

    • fireTimeSectionEvent

      public void fireTimeSectionEvent(TimeSection.TimeSectionEvent EVENT)