Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.
Android 0.0.0 Developer Preview
belongs to Maven artifact androidx.leanback:leanback:1.1.0-alpha01

ColorOverlayDimmer

public final class ColorOverlayDimmer
extends Object

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


Helper class for assigning a dim color to Paint. It holds the alpha value for the current active level.

Summary

Public methods

int applyToColor(int color)

Change the RGB of the color according to current dim level.

static ColorOverlayDimmer createColorOverlayDimmer(int dimColor, float activeLevel, float dimmedLevel)

Creates a ColorOverlayDimmer for the given color and levels.

static ColorOverlayDimmer createDefault(Context context)

Creates a default ColorOverlayDimmer.

void drawColorOverlay(Canvas c, View v, boolean includePadding)

Draw a dim color overlay on top of a child View inside the canvas of the parent View.

int getAlpha()

Returns the alpha value for the dimmer.

float getAlphaFloat()

Returns the float value between 0 and 1 corresponding to alpha between 0 and 255.

Paint getPaint()

Returns the Paint object set to the current alpha value.

boolean needsDraw()

Returns whether the dimmer needs to draw.

void setActiveLevel(float level)

Sets the active level of the dimmer.

Inherited methods

Public methods

applyToColor

public int applyToColor (int color)

Change the RGB of the color according to current dim level. Maintains the alpha value of the color.

Parameters
color int: The color to apply the dim level to.

Returns
int A color with the RGB values adjusted by the alpha of the current dim level.

createColorOverlayDimmer

public static ColorOverlayDimmer createColorOverlayDimmer (int dimColor, 
                float activeLevel, 
                float dimmedLevel)

Creates a ColorOverlayDimmer for the given color and levels.

Parameters
dimColor int: The color for fully dimmed. Only the RGB values are used; the alpha channel is ignored.

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
ColorOverlayDimmer

createDefault

public static ColorOverlayDimmer createDefault (Context context)

Creates a default ColorOverlayDimmer.

Parameters
context Context

Returns
ColorOverlayDimmer

drawColorOverlay

public void drawColorOverlay (Canvas c, 
                View v, 
                boolean includePadding)

Draw a dim color overlay on top of a child View inside the canvas of the parent View.

Parameters
c Canvas: Canvas of the parent View.

v View: A child of the parent View.

includePadding boolean: Set to true to draw overlay on padding area of the View.

getAlpha

public int getAlpha ()

Returns the alpha value for the dimmer.

Returns
int

getAlphaFloat

public float getAlphaFloat ()

Returns the float value between 0 and 1 corresponding to alpha between 0 and 255.

Returns
float

getPaint

public Paint getPaint ()

Returns the Paint object set to the current alpha value.

Returns
Paint

needsDraw

public boolean needsDraw ()

Returns whether the dimmer needs to draw.

Returns
boolean

setActiveLevel

public void setActiveLevel (float level)

Sets the active level of the dimmer. Updates the alpha value based on the level.

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