# ColorOverlayDimmer added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1 Summary:[Methods](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#) # ColorOverlayDimmer | This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings). ` public final class ColorOverlayDimmer ` ` extends Object `` ` |---|----------------------------------------------------------| | java.lang.Object || | ↳ | android.support.v17.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](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#applyToColor(int))`(int color) ` Change the RGB of the color according to current dim level. | | ` static `[ColorOverlayDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer) | ` `[createColorOverlayDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#createColorOverlayDimmer(int, float, float))`(int dimColor, float activeLevel, float dimmedLevel) ` Creates a ColorOverlayDimmer for the given color and levels. | | ` static `[ColorOverlayDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer) | ` `[createDefault](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#createDefault(android.content.Context))`(`[Context](https://developer.android.com/reference/android/content/Context.html)` context) ` Creates a default ColorOverlayDimmer. | | ` void` | ` `[drawColorOverlay](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#drawColorOverlay(android.graphics.Canvas, android.view.View, boolean))`(`[Canvas](https://developer.android.com/reference/android/graphics/Canvas.html)` c, `[View](https://developer.android.com/reference/android/view/View.html)` v, boolean includePadding) ` Draw a dim color overlay on top of a child View inside the canvas of the parent View. | | ` int` | ` `[getAlpha](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#getAlpha())`() ` Returns the alpha value for the dimmer. | | ` float` | ` `[getAlphaFloat](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#getAlphaFloat())`() ` Returns the float value between 0 and 1 corresponding to alpha between 0 and 255. | | ` `[Paint](https://developer.android.com/reference/android/graphics/Paint.html) | ` `[getPaint](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#getPaint())`() ` Returns the Paint object set to the current alpha value. | | ` boolean` | ` `[needsDraw](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#needsDraw())`() ` Returns whether the dimmer needs to draw. | | ` void` | ` `[setActiveLevel](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#setActiveLevel(float))`(float level) ` Sets the active level of the dimmer. | | ### Inherited methods | |-----------------------|---| | [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer#)From class` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | || ## Public methods ### applyToColor added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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 added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer) |
| ### createDefault added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` ColorOverlayDimmer createDefault (Context context) ``` Creates a default ColorOverlayDimmer.
| Parameters || |-----------|------------------| | `context` | `Context`
| | Returns || |------------------------------------------------------------------------------------------------------------------------|--------| | [ColorOverlayDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer) |
| ### drawColorOverlay added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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 added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` int getAlpha () ``` Returns the alpha value for the dimmer.
| Returns || |-------|--------| | `int` |
| ### getAlphaFloat added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` float getAlphaFloat () ``` Returns the float value between 0 and 1 corresponding to alpha between 0 and 255.
| Returns || |---------|--------| | `float` |
| ### getPaint added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` Paint getPaint () ``` Returns the Paint object set to the current alpha value.
| Returns || |------------------------------------------------------------------------------|--------| | [Paint](https://developer.android.com/reference/android/graphics/Paint.html) |
| ### needsDraw added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` boolean needsDraw () ``` Returns whether the dimmer needs to draw.
| Returns || |-----------|--------| | `boolean` |
| ### setActiveLevel added in[version 22.1.0](https://developer.android.com/topic/libraries/support-library/revisions) ``` 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).
| - ## Classes - [BoundsRule](https://developer.android.com/reference/android/support/v17/leanback/graphics/BoundsRule) - [BoundsRule.ValueRule](https://developer.android.com/reference/android/support/v17/leanback/graphics/BoundsRule.ValueRule) - [ColorFilterCache](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorFilterCache) - [ColorFilterDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorFilterDimmer) - [ColorOverlayDimmer](https://developer.android.com/reference/android/support/v17/leanback/graphics/ColorOverlayDimmer) - [CompositeDrawable](https://developer.android.com/reference/android/support/v17/leanback/graphics/CompositeDrawable) - [CompositeDrawable.ChildDrawable](https://developer.android.com/reference/android/support/v17/leanback/graphics/CompositeDrawable.ChildDrawable) - [FitWidthBitmapDrawable](https://developer.android.com/reference/android/support/v17/leanback/graphics/FitWidthBitmapDrawable)