public class

TimePicker

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.TimePicker

Class Overview

This view lets the user pick a Time. Only hours and minutes are available.

Default properties

By default, the following properties are applied to a new TimePicker:

focusable (limited to some devices)
clickable
enabled
current time
24H mode
width content stretch : MATCH_CONTENT.
height content stretch : MATCH_CONTENT.
content alignment : HCENTER|VCENTER.

Handling Time Changes

 TimeChangedListener timeListener = new TimeChangedListener() {
 	public void onTimeChanged(View source, int hours, int minutes, int seconds) {
 		// do some stuff
 	}
 };
 TimePicker myTimePicker = new TimePicker();
 myTimePicker.setDateChangedListener(dateListener);

Time Picker modes

The TimePicker has two modes : MODE_INLINE, MODE_DIALOG_PICKER. The MODE_INLINE enables wrapping TimePicker control inside a Layout. The MODE_DIALOG_PICKER mode shows a button with the selected time, when the end-user click him, a dialog is displayed : TimePickerDialog.

Default properties

By default, the following properties are applied to a new TimePicker:

focusable (limited to some devices)
clickable
enabled
Selected date (today)
no icon
width content stretch : MATCH_CONTENT.
height content stretch : MATCH_CONTENT.
content alignment : HCENTER|VCENTER.
mode : MODE_DIALOG_PICKER

Summary

XML Attributes
Attribute Name	Related Method	Description
contentAlignment	setContentAlignment(int)	A combination of alignment values (eg: TOP\|LEFT)
font	setFont(Font)	Font resource id: Res.font.FONT_XXXX
hours	setHours(int)	If the view could be clicked
minutes	setMinutes(int)
textColor	setTextColor(Color)	#AARRGGBB or a color
textSize	setTextSize(int)	a size in dp

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

Constants
int	MODE_DIALOG_PICKER	A button is displayed with the value of Time.
int	MODE_INLINE	The TimePicker inputs will be displayed directly in the layout.

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	TimePicker() Constructs a new time picker with the time set to the current time, and 24 hours mode activated by default.
	TimePicker(int mode) Constructs a new time picker with the time set to the current time, and 24 hours mode activated by default.
	TimePicker(int hours, int minutes, boolean mode) Constructs a new time picker with the time set to the given parameters.

Public Methods
int	getHours() Returns the hours of this time picker (always between 0 and 23)
int	getMinutes() Returns the minutes of this time picker (always between 0 and 59)
boolean	is24HoursMode() Returns if the time picker is configured in the 24 hours mode.
static void	openChooser(View origin, Calendar selectedTime, boolean is24hoursMode, TimeChangedListener listener) Opens a dialog to choose a Time.
void	set24HoursMode(boolean mode) Sets the time picker mode to 24 hours.
void	setContentAlignment(int alignment) Sets the alignment of the text or icon in the button.
void	setFont(Font font) Sets the timepicker's button text font.
void	setHours(int hours) Sets the hours of this time picker (always between 0 and 23)
void	setMinutes(int minutes) Sets the minutes of this time picker (always between 0 and 59)
void	setTextColor(Color textColor) Sets the TimePicker text color.
void	setTextSize(int sizeInDp) Sets the text size to a given value (in dp).
void	setTimeChangedListener(TimeChangedListener listener) Sets the listener for this TimePicker, that will be notified if the time changes.

[Expand]

Inherited Methods

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

XML Attributes

contentAlignment

A combination of alignment values (eg: TOP|LEFT)

Related Methods

setContentAlignment(int)

font

Font resource id: Res.font.FONT_XXXX

Related Methods

setFont(Font)

hours

If the view could be clicked

Related Methods

setHours(int)

minutes

Related Methods

setMinutes(int)

textColor

#AARRGGBB or a color

Related Methods

setTextColor(Color)

Constants

public static final int MODE_DIALOG_PICKER

A button is displayed with the value of Time. When the user clicks on the button, a Dialog is displayed in order to pick a Time.

Default mode for all platforms.

Constant Value: 0 (0x00000000)

public static final int MODE_INLINE

The TimePicker inputs will be displayed directly in the layout.

In this mode, text customization methods and background customization methods do nothing (text color, text font, text size, text alignment, background color...).

Constant Value: 1 (0x00000001)

Public Constructors

public TimePicker ()

Constructs a new time picker with the time set to the current time, and 24 hours mode activated by default.

The mode used here is MODE_DIALOG_PICKER.

public TimePicker (int mode)

Constructs a new time picker with the time set to the current time, and 24 hours mode activated by default.

This constructor enables to choose between MODE_DIALOG_PICKER and MODE_INLINE. The default mode is MODE_DIALOG_PICKER.

public TimePicker (int hours, int minutes, boolean mode)

Constructs a new time picker with the time set to the given parameters.

Parameters

hours	the hour to set to this time picker. This value must be between 0 and 23.
minutes	the minute to set to this time picker. This value must be between 0 and 59.
mode	the 24 hours mode to set (true to enable the 24Hours mode, false to enable the AM/PM mode)

Public Methods

public int getHours ()

Returns the hours of this time picker (always between 0 and 23)

Related XML Attributes

hours

Returns

the hours of this time picker (always between 0 and 23)

public int getMinutes ()

Returns the minutes of this time picker (always between 0 and 59)

Related XML Attributes

minutes

Returns

the minutes of this time picker (always between 0 and 59)

public boolean is24HoursMode ()

Returns if the time picker is configured in the 24 hours mode.

Returns

true if the mode is 24 hours, else false (AM/PM mode)

public static void openChooser (View origin, Calendar selectedTime, boolean is24hoursMode, TimeChangedListener listener)

Opens a dialog to choose a Time.

Parameters

origin	the view from here the dialog should be opened in iOS.
selectedTime	the selected time when the chooser will be shown at the user
is24hoursMode	true for 24H mode, false for AM/PM
listener	the callback used to get the selected date or null

Throws

NullPointerException	for iOS if the `origin` parameter is `null`.

public void set24HoursMode (boolean mode)

Sets the time picker mode to 24 hours. The time will be displayed differently, according to the mode.

Parameters

mode	true to set the mode to 24 hours, else false (mode AM/PM)

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setContentAlignment (int alignment)

Sets the alignment of the text or icon in the button. The parameter is a combination of values from Alignment

Only available in MODE_DIALOG_PICKER.

Related XML Attributes

contentAlignment

Parameters

alignment	The new alignment of the timepicker's text

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setFont (Font font)

Sets the timepicker's button text font.

Related XML Attributes

font

Parameters

font	new font for the text

Throws

CrossThreadException	if the method is called from outside the UI-Thread
NullPointerException	if the font parameter is null

public void setHours (int hours)

Sets the hours of this time picker (always between 0 and 23)

Related XML Attributes

hours

Parameters

hours	the hours to set (always between 0 and 23)

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setMinutes (int minutes)

Sets the minutes of this time picker (always between 0 and 59)

Related XML Attributes

minutes

Parameters

minutes	the minutes to set (always between 0 and 59)

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setTextColor (Color textColor)

Sets the TimePicker text color.

Related XML Attributes

textColor

Parameters

textColor	new color for the text

Throws

CrossThreadException	if the method is called from outside the UI-Thread
NullPointerException	if the parameter is null

public void setTextSize (int sizeInDp)

Sets the text size to a given value (in dp).

Related XML Attributes

textSize

Parameters

sizeInDp	size to set to the text

public void setTimeChangedListener (TimeChangedListener listener)

Sets the listener for this TimePicker, that will be notified if the time changes.

Parameters

listener	the listener

Interfaces

Classes

Enums

Exceptions

TimePicker

Class Overview

Default properties

Handling Time Changes

Time Picker modes

Default properties

Summary

XML Attributes

contentAlignment

Related Methods

font

Related Methods

hours

Related Methods

minutes

Related Methods

textColor

Related Methods

textSize

Related Methods

Constants

public static final int MODE_DIALOG_PICKER

public static final int MODE_INLINE

Public Constructors

public TimePicker ()

See Also

public TimePicker (int mode)

See Also

public TimePicker (int hours, int minutes, boolean mode)

Parameters

Public Methods

public int getHours ()

Related XML Attributes

Returns

public int getMinutes ()

Related XML Attributes

Returns

public boolean is24HoursMode ()

Returns

public static void openChooser (View origin, Calendar selectedTime, boolean is24hoursMode, TimeChangedListener listener)

Parameters

Throws

public void set24HoursMode (boolean mode)

Parameters

Throws

public void setContentAlignment (int alignment)

Related XML Attributes

Parameters

Throws

See Also

public void setFont (Font font)

Related XML Attributes

Parameters

Throws

public void setHours (int hours)

Related XML Attributes

Parameters

Throws

public void setMinutes (int minutes)

Related XML Attributes

Parameters

Throws

public void setTextColor (Color textColor)

Related XML Attributes

Parameters

Throws

public void setTextSize (int sizeInDp)

Related XML Attributes

Parameters

public void setTimeChangedListener (TimeChangedListener listener)

Parameters