added in version 22.1.0
belongs to Maven artifact


public final class ColorOverlayDimmer
extends Object


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


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

From class java.lang.Object

Public methods


added in version 22.1.0
int applyToColor (int color)

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

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

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


added in version 22.1.0