Time spinner

The time spinner displays and spins the time. You can change the time value by clicking on different subfields and spinning on them. You can also type in a time string to set the current value.

Properties

Property Description Data Type Flags* Default Value Valid Value
wrapAssociated Marks whether the different field values are associated. boolean R, W, B True True - different field values are associated
False - different field values are not associated
timeZone Represents a time zone offset. It is also makes changes for daylight savings time. String R, W, B system's local time zone valid time zone string
hour The hour int R, W, B, E The current system hour. valid hour
minute The minute int R, W, B, E The current system minute. valid minute
second The second int R, W, B, E The current system second. valid second
formatString The user-defined pattern string for formatting and parsing time. String R, W, B "h:mm:ss a" FULL - " h:mm:ss 'o'clock' a z"
LONG - "h:mm:ss a z"
MEDIUM - "h:mm:ss a"
SHORT - "h:mm a"
formattingStyle The ID of format string.
Note:This property is the same as the formatString property. However, to keep compatible with Webrunner API, it cannot be eliminated. Therefore, it is a hidden property and can only be manipulated by the set/get methods.
int R, W, B, H 2 0 - FULL
1 - LONG
2 - MEDIUM
3 - SHORT
caretPos The caret position which represents the current field to be changed. It can be one of: HOUR, MINUTE, and SECOND.
Note:The "caretPos" property of TimeSpinner is not similar to the caret position defined in the TextField. Therefore, when you manipulate TimeSpinner, the caret position displayed in the input field may not be consistent with the value of the caret position displayed in the property sheet.
int R, W, B 3 3 - HOUR
4 - MINUTE
5 - SECOND
value The calendar value in long. long R, W, B, E The current system calendar in long. minimum<value< maximum
calendar
(display name:Time)
The calendar value in calendar. java.util.Calendar R, W, B The current system calendar. any instance of Calendar
maximum The maximum value. java.util.Calendar R, W, B 11:59:59 PM maximum>minimum
minimum The minimum value. java.util.Calendar R, W, B 00:00:00 AM any instance of Calendar
dateString The time shown in the entry field. String R, W, B, E The current system time. any instance of valid time string

* R = read, W = write, B = bound, E = expert, H = hidden

Events

The time spinner fires the DateChangedEvent. The listener method for this event is dateChanged(com.ibm.spinner.DateChangedEvent)

User interface

The currently selected value is displayed in an input field. The following picture shows what this may look like:

You can change the time value by clicking on different subfields within the input field and using the arrow buttons to spin them. You can also set the values by typing a time string into the input field. If the input is invalid, the TimeSpinner restores the previous value after you press the "Enter" or "Tab" key or when you change the focus to another component.