ColorFilterDimmer

Added in 1.1.0

Kotlin |Java

class 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 functions
`Unit`	`applyFilterToView(view: View!)` Apply current the ColorFilter to a View.
`java-static ColorFilterDimmer!`	`create(dimmer: ColorFilterCache!, activeLevel: Float, dimmedLevel: Float)` Creates a ColorFilterDimmer for the given color and levels..
`java-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.
`Unit`	`setActiveLevel(level: Float)` Sets the active level of the dimmer.

Public functions

applyFilterToView

Added in 1.1.0

fun applyFilterToView(view: View!): Unit

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 1.1.0

java-static fun create(dimmer: ColorFilterCache!, activeLevel: Float, dimmedLevel: Float): ColorFilterDimmer!

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.

createDefault

Added in 1.1.0

java-static fun createDefault(context: Context!): ColorFilterDimmer!

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 1.1.0

fun getColorFilter(): ColorFilter!

Gets the ColorFilter set to the current dim level.

Returns
`ColorFilter!`	The current ColorFilter.

getPaint

Added in 1.1.0

fun getPaint(): Paint!

Gets the Paint object set to the current dim level.

Returns
`Paint!`	The current Paint object.

setActiveLevel

Added in 1.1.0

fun setActiveLevel(level: Float): Unit

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).