Most visited

Recently visited

Summary: Methods | Inherited Methods | [Expand All]

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.

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.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

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.

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`

ColorOverlayDimmer createDefault (Context context)

Creates a default ColorOverlayDimmer.

Parameters
`context`	`Context`

Returns
`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.

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.

int getAlpha ()

Returns the alpha value for the dimmer.

Returns
`int`

float getAlphaFloat ()

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

Returns
`float`

Paint getPaint ()

Returns the Paint object set to the current alpha value.

Returns
`Paint`

boolean needsDraw ()

Returns whether the dimmer needs to draw.

Returns
`boolean`

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