Android APIs
public final class

ColorFilterDimmer

extends Object
java.lang.Object
   ↳ android.support.v17.leanback.graphics.ColorFilterDimmer

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

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 The View to apply the ColorFilter to.

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

Creates a ColorFilterDimmer for the given color and levels..

Parameters
dimmer The ColorFilterCache for dim color.
activeLevel The level of dimming when the View is in its active state. Must be a float value between 0.0 and 1.0.
dimmedLevel The level of dimming when the View is in its dimmed state. Must be a float value between 0.0 and 1.0.

public static ColorFilterDimmer createDefault (Context context)

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

Parameters
context A Context used to retrieve Resources.
Returns
  • A ColorFilterDimmer with the default dim color and levels.

public ColorFilter getColorFilter ()

Gets the ColorFilter set to the current dim level.

Returns
  • The current ColorFilter.

public Paint getPaint ()

Gets the Paint object set to the current dim level.

Returns
  • The current Paint object.

public void setActiveLevel (float level)

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

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