public class

CheckBox

extends View

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

Class Overview

A CheckBox represents a text with a check item into screen in order to intercept events (touch and keys) to set a binary state (checked/unchecked).

Handling Check changes

A typical use of CheckBox could be:

 CheckChangedListener checkboxListener = new CheckChangedListener() {
 	public void onCheckChange(View source, boolean checked) {
 		// do some stuff
 	}
 };
 CheckBox myCheckBox = new CheckBox("Text of the checkbox");
 myCheckBox.setCheckChangedListener(checkboxListener);
 layout.add(myCheckBox);

Default properties

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

focusable (limited to some devices)
clickable
enabled
no text
unchecked
width content stretch : MATCH_PARENT.
height content stretch : MATCH_CONTENT.
content alignment : LEFT|VCENTER.

Summary

XML Attributes
Attribute Name	Related Method	Description
checked	setChecked(boolean)	To check the checkbox
font	setFont(Font)	Font resource id: Res.font.FONT_XXXX
text	setText(int)	Res.string.XXXX or a text
textColor	setTextColor(Color)	#AARRGGBB or a color
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
	CheckBox() Constructs a default checkbox without text and unchecked state.
	CheckBox(String text) Constructs a default checkbox with the given text and unchecked
	CheckBox(String text, boolean checked) Constructs a default checkbox with the given text and given checked state
	CheckBox(int resId) Constructs a default checkbox with the text corresponding to the given string id and unchecked
	CheckBox(int resId, boolean checked) Constructs a default checkbox with the text corresponding to the given string id and given checked state

Public Methods
String	getText() Returns the current text of the checkbox.
boolean	isChecked() Return the checked state of the check box
void	setCheckChangedListener(CheckChangedListener listener) Sets a listener that will listen for the checked state of the checkbox When the checked state of the check box changes, the onCheckChange() method of the listener is called, by passing as a first argument the check box, and as a second argument a boolean indicating if the check box is checked or not
void	setChecked(boolean checked) Check or uncheck the checkbox
void	setFont(Font font) Sets the checkbox text font.
void	setText(String text) Sets the text of the checkbox
void	setText(int resId) Sets the text of the checkbox
void	setTextColor(Color color) Sets the text color of this checkbox's text
void	setTextSize(int sizeInDp) Sets the text size to a given value (in dp).

[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)

font

Font resource id: Res.font.FONT_XXXX

Related Methods

setFont(Font)

text

Res.string.XXXX or a text

Related Methods

setText(int)

textColor

#AARRGGBB or a color

Related Methods

setTextColor(Color)

Public Constructors

public CheckBox ()

Constructs a default checkbox without text and unchecked state.

public CheckBox (String text)

Constructs a default checkbox with the given text and unchecked

Parameters

text	the text of this check box

public CheckBox (String text, boolean checked)

Constructs a default checkbox with the given text and given checked state

Parameters

text	the text of this check box
checked	if the checkbox is checked

public CheckBox (int resId)

Constructs a default checkbox with the text corresponding to the given string id and unchecked

Parameters

resId	the string id assigned to this check box

public CheckBox (int resId, boolean checked)

Constructs a default checkbox with the text corresponding to the given string id and given checked state

Parameters

resId	the string id assigned to this check box
checked	if the checkbox is checked

Public Methods

public String getText ()

Returns the current text of the checkbox. Returns an empty string ("") if there is no text.

Related XML Attributes

text

Returns

the current text of the checkbox. Returns an empty string ("") if there is no text.

public boolean isChecked ()

Return the checked state of the check box

Related XML Attributes

checked

Returns

true if the check box is checked, else false

public void setCheckChangedListener (CheckChangedListener listener)

Sets a listener that will listen for the checked state of the checkbox When the checked state of the check box changes, the onCheckChange() method of the listener is called, by passing as a first argument the check box, and as a second argument a boolean indicating if the check box is checked or not

Parameters

listener	Checkbox state change listener

public void setChecked (boolean checked)

Check or uncheck the checkbox

Related XML Attributes

checked

Parameters

checked	new checked state of the check box : true to check, false to uncheck

Throws

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

public void setFont (Font font)

Sets the checkbox 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 setText (String text)

Sets the text of the checkbox

Related XML Attributes

text

Parameters

text	The new text

Throws

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

public void setText (int resId)

Sets the text of the checkbox

Related XML Attributes

text

Parameters

resId	the string id assigned to this check box

Throws

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

public void setTextColor (Color color)

Sets the text color of this checkbox's text

Related XML Attributes

textColor

Parameters

color	The color to set (with the alpha channel)

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

Interfaces

Classes

Enums

Exceptions

CheckBox

Class Overview

Handling Check changes

Default properties

Summary

XML Attributes

checked

Related Methods

font

Related Methods

text

Related Methods

textColor

Related Methods

textSize

Related Methods

Public Constructors

public CheckBox ()

public CheckBox (String text)

Parameters

public CheckBox (String text, boolean checked)

Parameters

public CheckBox (int resId)

Parameters

public CheckBox (int resId, boolean checked)

Parameters

Public Methods

public String getText ()

Related XML Attributes

Returns

public boolean isChecked ()

Related XML Attributes

Returns

public void setCheckChangedListener (CheckChangedListener listener)

Parameters

public void setChecked (boolean checked)

Related XML Attributes

Parameters

Throws

public void setFont (Font font)

Related XML Attributes

Parameters

Throws

public void setText (String text)

Related XML Attributes

Parameters

Throws

public void setText (int resId)

Related XML Attributes

Parameters

Throws

public void setTextColor (Color color)

Related XML Attributes

Parameters

Throws

public void setTextSize (int sizeInDp)

Related XML Attributes

Parameters