CompoundButtonCompat

Helper for accessing CompoundButton methods introduced after API level 4 in a backwards compatible fashion.

Summary

XML Attributes
Attribute Name	Related Method	Description
android:buttonTintMode	getButtonTintMode(CompoundButton)	Blending mode used to apply the button graphic tint.

XML Attributes

Attribute Name

Related Method

Description

android:buttonTintMode

getButtonTintMode(CompoundButton)

Blending mode used to apply the button graphic tint.

Public Methods
static Drawable	getButtonDrawable(CompoundButton button) Returns the drawable used as the compound button image
static ColorStateList	getButtonTintList(CompoundButton button) Returns the tint applied to the button drawable
static PorterDuff.Mode	getButtonTintMode(CompoundButton button)
static void	setButtonTintList(CompoundButton button, ColorStateList tint) Applies a tint to the button drawable.
static void	setButtonTintMode(CompoundButton button, PorterDuff.Mode tintMode) Specifies the blending mode used to apply the tint specified by `setButtonTintList(CompoundButton, ColorStateList)`} to the button drawable.

Public Methods

static Drawable

getButtonDrawable(CompoundButton button)

Returns the drawable used as the compound button image

static ColorStateList

getButtonTintList(CompoundButton button)

Returns the tint applied to the button drawable

static PorterDuff.Mode

getButtonTintMode(CompoundButton button)

static void

setButtonTintList(CompoundButton button, ColorStateList tint)

Applies a tint to the button drawable.

static void

setButtonTintMode(CompoundButton button, PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(CompoundButton, ColorStateList)} to the button drawable.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

XML Attributes

android:buttonTintMode

Blending mode used to apply the button graphic tint.

Must be one of the following constant values.

Constant	Value	Description
`src_over`	3	The tint is drawn on top of the drawable. [Sa + (1 - Sa)Da, Rc = Sc + (1 - Sa)Dc]
`src_in`	5	The tint is masked by the alpha channel of the drawable. The drawable’s color channels are thrown out. [Sa * Da, Sc * Da]
`src_atop`	9	The tint is drawn above the drawable, but with the drawable’s alpha channel masking the result. [Da, Sc * Da + (1 - Sa) * Dc]
`multiply`	14	Multiplies the color and alpha channels of the drawable with those of the tint. [Sa * Da, Sc * Dc]
`screen`	15	[Sa + Da - Sa * Da, Sc + Dc - Sc * Dc]
`add`	16	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 buttonTintMode.

Related Methods

getButtonTintMode(CompoundButton)

Public Methods

public static Drawable getButtonDrawable (CompoundButton button)

Returns the drawable used as the compound button image

public static PorterDuff.Mode getButtonTintMode (CompoundButton button)

Related XML Attributes

android:buttonTintMode

Returns

the blending mode used to apply the tint to the button drawable

public static void setButtonTintList (CompoundButton button, ColorStateList tint)

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

Subsequent calls to setButtonDrawable(Drawable) should automatically mutate the drawable and apply the specified tint and tint mode using setTintList(Drawable, ColorStateList).

Parameters

tint	the tint to apply, may be `null` to clear tint

public static void setButtonTintMode (CompoundButton button, PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setButtonTintList(CompoundButton, ColorStateList)} to the button drawable. The default mode is SRC_IN.

Parameters

tintMode	the blending mode used to apply the tint, may be `null` to clear tint

Results

Interfaces

Classes

Class Overview

Summary

XML Attributes

android:buttonTintMode

Related Methods

Public Methods

public static Drawable getButtonDrawable (CompoundButton button)

See Also

public static ColorStateList getButtonTintList (CompoundButton button)

See Also

public static PorterDuff.Mode getButtonTintMode (CompoundButton button)

Related XML Attributes

Returns

See Also

public static void setButtonTintList (CompoundButton button, ColorStateList tint)

Parameters

See Also

public static void setButtonTintMode (CompoundButton button, PorterDuff.Mode tintMode)

Parameters

See Also

java.lang.Object
↳	android.support.v4.widget.CompoundButtonCompat