Skip to content

Most visited

Recently visited

navigation

CheckedTextView

public class CheckedTextView
extends TextView implements Checkable

java.lang.Object
   ↳ android.view.View
     ↳ android.widget.TextView
       ↳ android.widget.CheckedTextView
Known Direct Subclasses


An extension to TextView that supports the Checkable interface and displays.

This is useful when used in a ListView where the setChoiceMode has been set to something other than CHOICE_MODE_NONE.

Summary

XML attributes

android:checkMark Drawable used for the check mark graphic. 
android:checkMarkTint Tint to apply to the check mark. 
android:checkMarkTintMode Blending mode used to apply the check mark tint. 
android:checked Indicates the initial checked state of this text. 

Inherited XML attributes

From class android.widget.TextView
From class android.view.View

Inherited constants

From class android.view.View

Inherited fields

From class android.view.View

Public constructors

CheckedTextView(Context context)
CheckedTextView(Context context, AttributeSet attrs)
CheckedTextView(Context context, AttributeSet attrs, int defStyleAttr)
CheckedTextView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Public methods

void drawableHotspotChanged(float x, float y)

This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view.

CharSequence getAccessibilityClassName()

Return the class name of this object to be used for accessibility purposes.

Drawable getCheckMarkDrawable()

Gets the checkmark drawable

ColorStateList getCheckMarkTintList()

Returns the tint applied to the check mark drawable, if specified.

PorterDuff.Mode getCheckMarkTintMode()

Returns the blending mode used to apply the tint to the check mark drawable, if specified.

boolean isChecked()
void jumpDrawablesToCurrentState()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

void onRestoreInstanceState(Parcelable state)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().

void onRtlPropertiesChanged(int layoutDirection)

Called when any RTL property (layout direction or text direction or text alignment) has been changed.

Parcelable onSaveInstanceState()

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.

void setCheckMarkDrawable(Drawable d)

Set the check mark to the specified drawable.

void setCheckMarkDrawable(int resId)

Sets the check mark to the drawable with the specified resource ID.

void setCheckMarkTintList(ColorStateList tint)

Applies a tint to the check mark drawable.

void setCheckMarkTintMode(PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setCheckMarkTintList(ColorStateList) to the check mark drawable.

void setChecked(boolean checked)

Sets the checked state of this view.

void setVisibility(int visibility)

Set the enabled state of this view.

void toggle()

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

Protected methods

void drawableStateChanged()

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

int[] onCreateDrawableState(int extraSpace)

Generate the new Drawable state for this view.

void onDraw(Canvas canvas)

Implement this to do your drawing.

boolean verifyDrawable(Drawable who)

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.

Inherited methods

From class android.widget.TextView
From class android.view.View
From class java.lang.Object
From interface android.view.ViewTreeObserver.OnPreDrawListener
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource
From interface android.widget.Checkable

XML attributes

android:checkMark

Drawable used for the check mark graphic.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol checkMark.

Related methods:

android:checkMarkTint

Tint to apply to the check mark.

Must be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol checkMarkTint.

Related methods:

android:checkMarkTintMode

Blending mode used to apply the check mark tint.

Must be one of the following constant values.

ConstantValueDescription
src_over3 The tint is drawn on top of the drawable. [Sa + (1 - Sa)*Da, Rc = Sc + (1 - Sa)*Dc]
src_in5 The tint is masked by the alpha channel of the drawable. The drawable’s color channels are thrown out. [Sa * Da, Sc * Da]
src_atop9 The tint is drawn above the drawable, but with the drawable’s alpha channel masking the result. [Da, Sc * Da + (1 - Sa) * Dc]
multiply14 Multiplies the color and alpha channels of the drawable with those of the tint. [Sa * Da, Sc * Dc]
screen15 [Sa + Da - Sa * Da, Sc + Dc - Sc * Dc]
add16 Combines the tint and drawable color and alpha channels, clamping the result to valid color values. Saturate(S + D)

This corresponds to the global attribute resource symbol checkMarkTintMode.

Related methods:

android:checked

Indicates the initial checked state of this text.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol checked.

Public constructors

CheckedTextView

Added in API level 1
CheckedTextView (Context context)

Parameters
context Context

CheckedTextView

Added in API level 1
CheckedTextView (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

CheckedTextView

Added in API level 1
CheckedTextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

CheckedTextView

Added in API level 21
CheckedTextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

Public methods

drawableHotspotChanged

Added in API level 21
void drawableHotspotChanged (float x, 
                float y)

This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view.

Dispatching to child views is handled by dispatchDrawableHotspotChanged(float, float).

Be sure to call through to the superclass when overriding this function.

Parameters
x float: hotspot x coordinate
y float: hotspot y coordinate

getAccessibilityClassName

Added in API level 23
CharSequence getAccessibilityClassName ()

Return the class name of this object to be used for accessibility purposes. Subclasses should only override this if they are implementing something that should be seen as a completely new class of view when used by accessibility, unrelated to the class it is deriving from. This is used to fill in AccessibilityNodeInfo.setClassName.

Returns
CharSequence

getCheckMarkDrawable

Added in API level 16
Drawable getCheckMarkDrawable ()

Gets the checkmark drawable

Related XML Attributes:

Returns
Drawable The drawable use to represent the checkmark, if any.

See also:

getCheckMarkTintList

Added in API level 21
ColorStateList getCheckMarkTintList ()

Returns the tint applied to the check mark drawable, if specified.

Related XML Attributes:

Returns
ColorStateList the tint applied to the check mark drawable

See also:

getCheckMarkTintMode

Added in API level 21
PorterDuff.Mode getCheckMarkTintMode ()

Returns the blending mode used to apply the tint to the check mark drawable, if specified.

Related XML Attributes:

Returns
PorterDuff.Mode the blending mode used to apply the tint to the check mark drawable

See also:

isChecked

Added in API level 1
boolean isChecked ()

Returns
boolean

jumpDrawablesToCurrentState

Added in API level 11
void jumpDrawablesToCurrentState ()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Also calls jumpToCurrentState() if there is a StateListAnimator attached to this view.

onRestoreInstanceState

Added in API level 1
void onRestoreInstanceState (Parcelable state)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state Parcelable: The frozen state that had previously been returned by onSaveInstanceState().

onRtlPropertiesChanged

Added in API level 17
void onRtlPropertiesChanged (int layoutDirection)

Called when any RTL property (layout direction or text direction or text alignment) has been changed. Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction. The default implementation does nothing.

Parameters
layoutDirection int: the direction of the layout

onSaveInstanceState

Added in API level 1
Parcelable onSaveInstanceState ()

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view.

Returns
Parcelable Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

setCheckMarkDrawable

Added in API level 1
void setCheckMarkDrawable (Drawable d)

Set the check mark to the specified drawable.

When this view is checked, the drawable's state set will include state_checked.

Related XML Attributes:

Parameters
d Drawable: the drawable to use for the check mark

See also:

setCheckMarkDrawable

Added in API level 1
void setCheckMarkDrawable (int resId)

Sets the check mark to the drawable with the specified resource ID.

When this view is checked, the drawable's state set will include state_checked.

Related XML Attributes:

Parameters
resId int: the resource identifier of drawable to use as the check mark

See also:

setCheckMarkTintList

Added in API level 21
void setCheckMarkTintList (ColorStateList tint)

Applies a tint to the check mark drawable. Does not modify the current tint mode, which is SRC_IN by default.

Subsequent calls to setCheckMarkDrawable(Drawable) will automatically mutate the drawable and apply the specified tint and tint mode using setTintList(ColorStateList).

Related XML Attributes:

Parameters
tint ColorStateList: the tint to apply, may be null to clear tint

See also:

setCheckMarkTintMode

Added in API level 21
void setCheckMarkTintMode (PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setCheckMarkTintList(ColorStateList) to the check mark drawable. The default mode is SRC_IN.

Related XML Attributes:

Parameters
tintMode PorterDuff.Mode: the blending mode used to apply the tint, may be null to clear tint

See also:

setChecked

Added in API level 1
void setChecked (boolean checked)

Sets the checked state of this view.

Parameters
checked boolean: true set the state to checked, false to uncheck

setVisibility

Added in API level 1
void setVisibility (int visibility)

Set the enabled state of this view.

Parameters
visibility int: One of VISIBLE, INVISIBLE, or GONE.

toggle

Added in API level 1
void toggle ()

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

Protected methods

drawableStateChanged

Added in API level 1
void drawableStateChanged ()

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

If the View has a StateListAnimator, it will also be called to run necessary state change animations.

Be sure to call through to the superclass when overriding this function.

onCreateDrawableState

Added in API level 1
int[] onCreateDrawableState (int extraSpace)

Generate the new Drawable state for this view. This is called by the view system when the cached Drawable state is determined to be invalid. To retrieve the current state, you should use getDrawableState().

Parameters
extraSpace int: if non-zero, this is the number of extra entries you would like in the returned array in which you can place your own states.
Returns
int[] Returns an array holding the current Drawable state of the view.

onDraw

Added in API level 1
void onDraw (Canvas canvas)

Implement this to do your drawing.

Parameters
canvas Canvas: the canvas on which the background will be drawn

verifyDrawable

Added in API level 1
boolean verifyDrawable (Drawable who)

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled.

Be sure to call through to the super class when overriding this function.

Parameters
who Drawable: The Drawable to verify. Return true if it is one you are displaying, else return the result of calling through to the super class.
Returns
boolean boolean If true than the Drawable is being displayed in the view; else false and it is not allowed to animate.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.