Nested classes

interface CompoundButton.OnCheckedChangeListener

Interface definition for a callback to be invoked when the checked state of a compound button changed. 

XML attributes

android:button

Drawable used for the button graphic (for example, checkbox and radio button). 

android:buttonTint Tint to apply to the button graphic. 

android:buttonTintMode Blending mode used to apply the button graphic tint. 

Inherited fields

From class android.view.View

Public methods

void autofill(AutofillValue value)

Automatically fills the content of this view with the value.

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.

int getAutofillType()

Describes the autofill type of this view, so an AutofillService can create the proper AutofillValue when autofilling the view.

AutofillValue getAutofillValue()

Gets the TextView's current text for AutoFill.

Drawable getButtonDrawable() BlendMode getButtonTintBlendMode() ColorStateList getButtonTintList() PorterDuff.Mode getButtonTintMode() int getCompoundPaddingLeft()

Returns the left padding of the view, plus space for the left Drawable if any.

int getCompoundPaddingRight()

Returns the right padding of the view, plus space for the right Drawable if any.

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

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.

boolean performClick()

Call this view's OnClickListener, if it is defined.

void setButtonDrawable(int resId)

Sets a drawable as the compound button image given its resource identifier.

void setButtonDrawable(Drawable drawable)

Sets a drawable as the compound button image.

void setButtonIcon(Icon icon)

Sets the button of this CompoundButton to the specified Icon.

void setButtonTintBlendMode(BlendMode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(android.content.res.ColorStateList)} to the button drawable.

void setButtonTintList(ColorStateList tint)

Applies a tint to the button drawable.

void setButtonTintMode(PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(android.content.res.ColorStateList)} to the button drawable.

void setChecked(boolean checked)

Changes the checked state of this button.

void setOnCheckedChangeListener(CompoundButton.OnCheckedChangeListener listener)

Register a callback to be invoked when the checked state of this button changes.

void setStateDescription(CharSequence stateDescription)

This function is called when an instance or subclass sets the state description.

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.

ConstantValueDescriptionadd10Combines the tint and drawable color and alpha channels, clamping the result to valid color values. Saturate(S + D)multiplyeMultiplies the color and alpha channels of the drawable with those of the tint. [Sa * Da, Sc * Dc]screenf[Sa + Da - Sa * Da, Sc + Dc - Sc * Dc]src_atop9The tint is drawn above the drawable, but with the drawable’s alpha channel masking the result. [Da, Sc * Da + (1 - Sa) * Dc]src_in5The tint is masked by the alpha channel of the drawable. The drawable’s color channels are thrown out. [Sa * Da, Sc * Da]src_over3The tint is drawn on top of the drawable. [Sa + (1 - Sa)*Da, Rc = Sc + (1 - Sa)*Dc]

CompoundButton

public CompoundButton (Context context)

CompoundButton

public CompoundButton (Context context, 
                AttributeSet attrs)

CompoundButton

public CompoundButton (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

CompoundButton

public CompoundButton (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

autofill

public void autofill (AutofillValue value)

Automatically fills the content of this view with the value.

Views support the Autofill Framework mainly by:

• Providing the metadata defining what the view means and how it can be autofilled.
• Implementing the methods that autofill the view.

onProvideAutofillStructure(android.view.ViewStructure, int) is responsible for the former, this method is responsible for latter.

This method does nothing by default, but when overridden it typically:

1. Checks if the provided value matches the expected type (which is defined by getAutofillType()).
2. Checks if the view is editable - if it isn't, it should return right away.
3. Call the proper getter method on AutofillValue to fetch the actual value.
4. Pass the actual value to the equivalent setter in the view.

For example, a text-field view could implement the method this way:

 @Override
 public void autofill(AutofillValue value) {
   if (!value.isText() || !this.isEditable()) {
      return;
   }
   CharSequence text = value.getTextValue();
   if (text != null) {
     this.setText(text);
   }
 }
 

If the value is updated asynchronously, the next call to AutofillManager#notifyValueChanged(View) must happen after the value was changed to the autofilled value. If not, the view will not be considered autofilled.

Note: After this method is called, the value returned by getAutofillValue() must be equal to the value passed to it, otherwise the view will not be highlighted as autofilled.

drawableHotspotChanged

public 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.

If you override this method you must call through to the superclass implementation.

getAccessibilityClassName

public 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.

getAutofillType

public int getAutofillType ()

Describes the autofill type of this view, so an AutofillService can create the proper AutofillValue when autofilling the view.

By default returns AUTOFILL_TYPE_NONE, but views should override it to properly support the Autofill Framework.

getAutofillValue

public AutofillValue getAutofillValue ()

Gets the TextView's current text for AutoFill. The value is trimmed to 100K chars if longer.

getButtonDrawable

public Drawable getButtonDrawable ()

getButtonTintBlendMode

public BlendMode getButtonTintBlendMode ()

Related XML Attributes:

• android:buttonTintMode

getButtonTintList

public ColorStateList getButtonTintList ()

Related XML Attributes:

• android:buttonTint

getButtonTintMode

public PorterDuff.Mode getButtonTintMode ()

Related XML Attributes:

• android:buttonTintMode

getCompoundPaddingLeft

public int getCompoundPaddingLeft ()

Returns the left padding of the view, plus space for the left Drawable if any.

getCompoundPaddingRight

public int getCompoundPaddingRight ()

Returns the right padding of the view, plus space for the right Drawable if any.

isChecked

public boolean isChecked ()

jumpDrawablesToCurrentState

public void jumpDrawablesToCurrentState ()

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

Also calls StateListAnimator#jumpToCurrentState() if there is a StateListAnimator attached to this view.
If you override this method you must call through to the superclass implementation.

onRestoreInstanceState

public 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.

If you override this method you must call through to the superclass implementation.

onSaveInstanceState

public 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.

If you override this method you must call through to the superclass implementation.

performClick

public boolean performClick ()

Call this view's OnClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc.

setButtonDrawable

public void setButtonDrawable (int resId)

Sets a drawable as the compound button image given its resource identifier.

Related XML Attributes:

• android:button

setButtonDrawable

public void setButtonDrawable (Drawable drawable)

Sets a drawable as the compound button image.

Related XML Attributes:

• android:button

setButtonIcon

public void setButtonIcon (Icon icon)

Sets the button of this CompoundButton to the specified Icon.

setButtonTintBlendMode

public void setButtonTintBlendMode (BlendMode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(android.content.res.ColorStateList)} to the button drawable. The default mode is PorterDuff.Mode#SRC_IN.

Related XML Attributes:

• android:buttonTintMode

setButtonTintList

public void setButtonTintList (ColorStateList tint)

Applies a tint to the button drawable. Does not modify the current tint mode, which is PorterDuff.Mode#SRC_IN by default.

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

Related XML Attributes:

• android:buttonTint

setButtonTintMode

public void setButtonTintMode (PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(android.content.res.ColorStateList)} to the button drawable. The default mode is PorterDuff.Mode#SRC_IN.

Related XML Attributes:

• android:buttonTintMode

setChecked

public void setChecked (boolean checked)

Changes the checked state of this button.

setOnCheckedChangeListener

public void setOnCheckedChangeListener (CompoundButton.OnCheckedChangeListener listener)

Register a callback to be invoked when the checked state of this button changes.

setStateDescription

public void setStateDescription (CharSequence stateDescription)

This function is called when an instance or subclass sets the state description. Once this is called and the argument is not null, the app developer will be responsible for updating state description when checked state changes and we will not set state description in setChecked(boolean). App developers can restore the default behavior by setting the argument to null. If setChecked(boolean) is called first and then setStateDescription is called, two state change events will be merged by event throttling and we can still get the correct state description.

toggle

public void toggle ()

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

drawableStateChanged

protected 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.

If you override this method you must call through to the superclass implementation.

onCreateDrawableState

protected 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().

onDraw

protected void onDraw (Canvas canvas)

Implement this to do your drawing.

verifyDrawable

protected 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.

If you override this method you must call through to the superclass implementation.