public class

Switch

extends View

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

Class Overview

Switch component shows an On/Off button.

The user manipulates this component by dragging horizontally the slider part ("flips" it).

You can customize the appearance of the switch by changing the on/off texts, and colors.

Handling switch changes

Default properties

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

focusable (limited to some devices)
clickable
enabled
not checked
platform default checked color
width content stretch : MATCH_CONTENT.
height content stretch : MATCH_CONTENT.
content alignment : HCENTER|VCENTER.

Cross Platform Considerations

In Android, the switch shows a toggle button in older versions (before API Level 14), otherwise it shows the Holo switch.

Summary

XML Attributes
Attribute Name	Related Method	Description
checked	setChecked(boolean)	To check the checkbox
checkedColor	setCheckedColor(Color)	#AARRGGBB or a color
contentAlignment	setContentAlignment(int)	A combination of alignment values (eg: TOP\|LEFT)
defaultText	setDefaultText(String)	Res.string.XXXX or a text
font	setFont(Font)	Font resource id: Res.font.FONT_XXXX
textColor	setTextColor(Color)	#AARRGGBB or a color
textOff	setTextOff(String)	Res.string.XXXX or a text
textOn	setTextOn(String)	Res.string.XXXX or a text
textSize	setTextSize(int)	a size in dp

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	Switch() Construct a new Switch or Toggle (old version of android)

Public Methods
boolean	isChecked()
void	setCheckChangedListener(CheckChangedListener checkChangedListener) Registers a callback to be invoked when the checked state of this switch changes.
void	setChecked(boolean checked) Change the checked state of the view to on (`true`) or off ( `false`).
void	setCheckedColor(Color color) Sets the color of the Switch when it is checked.
void	setContentAlignment(int alignment) Sets the alignment of the text in the Switch.
void	setDefaultText(String text) Sets the default text of the Switch.
void	setDefaultText(int resId) Sets the default text of the Switch.
void	setFont(Font font) Sets the Switch text font.
void	setTextColor(Color color) Sets the Switch's text color.
void	setTextOff(String off) Sets the text displayed when the button is not in the checked state.
void	setTextOff(int resId) Sets the text displayed when the button is in the unchecked state.
void	setTextOn(int resId) Sets the text displayed when the button is in the checked state.
void	setTextOn(String on) Sets the text displayed when the button is in the checked state.
void	setTextSize(int sizeInDp) Sets the text size to a given value (in dp).
void	toggle() Change the checked state of the view to the inverse of its current state.

[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

checked

To check the checkbox

Related Methods

setChecked(boolean)

checkedColor

#AARRGGBB or a color

Related Methods

setCheckedColor(Color)

contentAlignment

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

Related Methods

setContentAlignment(int)

defaultText

Res.string.XXXX or a text

Related Methods

setDefaultText(String)

font

Font resource id: Res.font.FONT_XXXX

Related Methods

setFont(Font)

textColor

#AARRGGBB or a color

Related Methods

setTextColor(Color)

textOff

Res.string.XXXX or a text

Related Methods

setTextOff(String)

textOn

Res.string.XXXX or a text

Related Methods

setTextOn(String)

Public Constructors

public Switch ()

Construct a new Switch or Toggle (old version of android)

Public Methods

public boolean isChecked ()

Returns

if the switch state is on

public void setCheckChangedListener (CheckChangedListener checkChangedListener)

Registers a callback to be invoked when the checked state of this switch changes.

Parameters

checkChangedListener	the callback to be called or `null` to unregister

public void setChecked (boolean checked)

Change the checked state of the view to on (true) or off ( false).

Related XML Attributes

checked

Parameters

checked	true to change the state to `on`

Throws

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

public void setCheckedColor (Color color)

Sets the color of the Switch when it is checked.

Related XML Attributes

checkedColor

Parameters

color	the color of the Switch in the checked state

Throws

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

public void setContentAlignment (int alignment)

Sets the alignment of the text in the Switch. The parameter is a combination of values from Alignment

Related XML Attributes

contentAlignment

Parameters

alignment	The new alignment of the button's text

Throws

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

public void setDefaultText (String text)

Sets the default text of the Switch.

Limitations

This method has an effect only in Android.

Related XML Attributes

defaultText

Parameters

text	the label string

Throws

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

public void setDefaultText (int resId)

Sets the default text of the Switch.

Limitations

This method has an effect only in Android.

Parameters

resId	the string resource id

Throws

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

public void setFont (Font font)

Sets the Switch 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 setTextColor (Color color)

Sets the Switch's text color.

Related XML Attributes

textColor

Parameters

color	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 setTextOff (String off)

Sets the text displayed when the button is not in the checked state.

Related XML Attributes

textOff

Throws

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

public void setTextOff (int resId)

Sets the text displayed when the button is in the unchecked state.

Parameters

resId	the string resource id

Throws

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

public void setTextOn (int resId)

Sets the text displayed when the button is in the checked state.

Parameters

resId	the string resource id

Throws

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

public void setTextOn (String on)

Sets the text displayed when the button is in the checked state.

Related XML Attributes

textOn

Throws

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

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 toggle ()

Change the checked state of the view to the inverse of its current state.

Throws

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

Interfaces

Classes

Enums

Exceptions

Switch

Class Overview

Handling switch changes

Default properties

Cross Platform Considerations

See Also

Summary

XML Attributes

checked

Related Methods

checkedColor

Related Methods

contentAlignment

Related Methods

defaultText

Related Methods

font

Related Methods

textColor

Related Methods

textOff

Related Methods

textOn

Related Methods

textSize

Related Methods

Public Constructors

public Switch ()

Public Methods

public boolean isChecked ()

Returns

public void setCheckChangedListener (CheckChangedListener checkChangedListener)

Parameters

public void setChecked (boolean checked)

Related XML Attributes

Parameters

Throws

public void setCheckedColor (Color color)

Related XML Attributes

Parameters

Throws

public void setContentAlignment (int alignment)

Related XML Attributes

Parameters

Throws

See Also

public void setDefaultText (String text)

Limitations

Related XML Attributes

Parameters

Throws

public void setDefaultText (int resId)

Limitations

Parameters

Throws

public void setFont (Font font)

Related XML Attributes

Parameters

Throws

public void setTextColor (Color color)

Related XML Attributes

Parameters

Throws

public void setTextOff (String off)

Related XML Attributes

Throws

public void setTextOff (int resId)

Parameters

Throws

public void setTextOn (int resId)

Parameters

Throws

public void setTextOn (String on)

Related XML Attributes

Throws

public void setTextSize (int sizeInDp)