Class TimeSpinner

java.lang.Object
com.codename1.ui.Component
com.codename1.ui.Container
com.codename1.ui.spinner.BaseSpinner
com.codename1.ui.spinner.TimeSpinner
All Implemented Interfaces:
Animation, Editable, StyleListener, Iterable<Component>
Direct Known Subclasses:
DateTimeSpinner
public class TimeSpinner extends BaseSpinner

Allows selecting a time of day either in 24 hour batches or AM/PM format.

If #setDurationMode(boolean) is true then this will allow users to set a duration in hours and minutes.

Styles

UIIDDescription SpinnerRendererUsed for each cell/row of the spinner. TimeSpinnerHoursLabelUsed for the "hours" label to the right of the hours spinner. Used only in duration mode. TimeSpinnerMinutesLabelUsed for the "minutes" label to the right of the minutes spinner. Used only in duration mode.

Screenshots

  • Constructor Details

    • TimeSpinner

      public TimeSpinner()

  • Method Details

    • getPropertyNames

      public String[] getPropertyNames()

      A component may expose mutable property names for a UI designer to manipulate, this API is designed for usage internally by the GUI builder code

      Returns

      the property names allowing mutation

      Overrides:
      getPropertyNames in class Component

    • getPropertyTypes

      public Class[] getPropertyTypes()

      Matches the property names method (see that method for further details).

      Returns

      the types of the properties

      Overrides:
      getPropertyTypes in class Component

    • getPropertyValue

      public Object getPropertyValue(String name)

      Returns the current value of the property name, this method is used by the GUI builder

      Parameters
      • name: the name of the property
      Returns

      the value of said property

      Overrides:
      getPropertyValue in class Component

    • setPropertyValue

      public String setPropertyValue(String name, Object value)

      Sets a new value to the given property, returns an error message if failed and null if successful. Notice that some builtin properties such as "$designMode" might be sent to components to indicate application state.

      Parameters

      • name: the name of the property

      • value: new value for the property

      Returns

      error message or null

      Overrides:
      setPropertyValue in class Component

    • getMinuteStep

      public int getMinuteStep()

      Gets the minutes spinner step size.

      Returns

      the minuteStep

    • setMinuteStep

      public void setMinuteStep(int minuteStep)

      Sets the step-size for the minutes spinner.

      Parameters
      • minuteStep: The step size. Must be beween 1 and 60.

    • isShowMeridiem

      public boolean isShowMeridiem()
      Returns

      the showMeridiem

    • setShowMeridiem

      public void setShowMeridiem(boolean showMeridiem)

      Shows AM/PM indication

      Parameters
      • showMeridiem: the showMeridiem to set

    • getCurrentHour

      public int getCurrentHour()

      The hour from 1-12 or 0-23

      Returns

      the currentHour

    • setCurrentHour

      public void setCurrentHour(int currentHour)

      Set the hour from 1-12 or 0-23

      Parameters
      • currentHour: the currentHour to set

    • getCurrentMinute

      public int getCurrentMinute()
      Returns

      the currentMinute

    • setCurrentMinute

      public void setCurrentMinute(int currentMinute)
      Parameters
      • currentMinute: the currentMinute to set

    • isCurrentMeridiem

      public boolean isCurrentMeridiem()
      Returns

      the currentMeridiem

    • setCurrentMeridiem

      public void setCurrentMeridiem(boolean currentMeridiem)
      Parameters
      • currentMeridiem: the currentMeridiem to set

    • isDurationMode

      public boolean isDurationMode()

      Duration mode uses the time spinner to indicate a duration in hours and minutes

      Returns

      the durationMode

    • setDurationMode

      public void setDurationMode(boolean durationMode)

      Duration mode uses the time spinner to indicate a duration in hours and minutes

      Parameters
      • durationMode: the durationMode to set

    • setHoursVisible

      public void setHoursVisible(boolean visible)

      Show or hide the hours spinner.

      Parameters
      • visible: True to show the hours spinner.

    • setMinutesVisible

      public void setMinutesVisible(boolean visible)

      Show or hide the minutes spinner.

      Parameters
      • visible: True to make the minutes spinner visible.