added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

ColorFilterDimmer

public final class ColorFilterDimmer
extends Object

java.lang.Object
   ↳ androidx.leanback.graphics.ColorFilterDimmer


Helper class for applying a dim level to a View. The ColorFilterDimmer uses a ColorFilter in a Paint object to dim the view according to the currently active level.

Summary

Public methods

void applyFilterToView(View view)

Apply current the ColorFilter to a View.

static ColorFilterDimmer create(ColorFilterCache dimmer, float activeLevel, float dimmedLevel)

Creates a ColorFilterDimmer for the given color and levels..

static ColorFilterDimmer createDefault(Context context)

Creates a default ColorFilterDimmer.

ColorFilter getColorFilter()

Gets the ColorFilter set to the current dim level.

Paint getPaint()

Gets the Paint object set to the current dim level.

void setActiveLevel(float level)

Sets the active level of the dimmer.

Inherited methods

Public methods

applyFilterToView

added in version 1.0.0
public void applyFilterToView (View view)

Apply current the ColorFilter to a View. This method will set the hardware layer of the view when applying a filter, and remove it when not applying a filter.

Parameters
view View: The View to apply the ColorFilter to.

create

added in version 1.0.0
public static ColorFilterDimmer create (ColorFilterCache dimmer, 
                float activeLevel, 
                float dimmedLevel)

Creates a ColorFilterDimmer for the given color and levels..

Parameters
dimmer ColorFilterCache: The ColorFilterCache for dim color.

activeLevel float: The level of dimming when the View is in its active state. Must be a float value between 0.0 and 1.0.

dimmedLevel float: The level of dimming when the View is in its dimmed state. Must be a float value between 0.0 and 1.0.

Returns
ColorFilterDimmer

createDefault

added in version 1.0.0
public static ColorFilterDimmer createDefault (Context context)

Creates a default ColorFilterDimmer. Uses the default color and level for the dimmer.

Parameters
context Context: A Context used to retrieve Resources.

Returns
ColorFilterDimmer A ColorFilterDimmer with the default dim color and levels.

getColorFilter

added in version 1.0.0
public ColorFilter getColorFilter ()

Gets the ColorFilter set to the current dim level.

Returns
ColorFilter The current ColorFilter.

getPaint

added in version 1.0.0
public Paint getPaint ()

Gets the Paint object set to the current dim level.

Returns
Paint The current Paint object.

setActiveLevel

added in version 1.0.0
public void setActiveLevel (float level)

Sets the active level of the dimmer. Updates the ColorFilter based on the level.

Parameters
level float: A float between 0 (fully dim) and 1 (fully active).