de.mrapp.android.util

Class ElevationUtil

java.lang.Object

de.mrapp.android.util.ElevationUtil

public final class ElevationUtil
extends java.lang.Object

An utility class, which provides static methods, which allow to emulate elevations of views on pre-Lollipop devices.

Since:

1.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElevationUtil.Orientation Contains all possible orientations of a shadow in relation to an elevated view.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ELEVATION The maximum supported elevation in dp.

Method Summary

Modifier and Type	Method and Description
static android.graphics.Bitmap	createElevationShadow(android.content.Context context, int elevation, ElevationUtil.Orientation orientation) Creates and returns a bitmap, which can be used to emulate a shadow of an elevated view on pre-Lollipop devices.
static android.graphics.Bitmap	createElevationShadow(android.content.Context context, int elevation, ElevationUtil.Orientation orientation, boolean parallelLight) Creates and returns a bitmap, which can be used to emulate a shadow of an elevated view on pre-Lollipop devices.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_ELEVATION

public static final int MAX_ELEVATION

The maximum supported elevation in dp.

See Also:

Constant Field Values

Method Detail

createElevationShadow

public static android.graphics.Bitmap createElevationShadow(android.content.Context context,
                                                            int elevation,
                                                            ElevationUtil.Orientation orientation)

Creates and returns a bitmap, which can be used to emulate a shadow of an elevated view on pre-Lollipop devices. By default a non-parallel illumination of the view is emulated, which causes the shadow at its bottom to appear a bit more intense than the shadows to its left and right and a lot more intense than the shadow at its top.

Parameters:

context - The context, which should be used, as an instance of the class Context. The context may not be null

elevation - The elevation, which should be emulated, in dp as an Integer value. The elevation must be at least 0 and at maximum the value of the constant MAX_ELEVATION

orientation - The orientation of the shadow in relation to the elevated view as a value of the enum ElevationUtil.Orientation. The orientation may either be LEFT, RIGHT, TOP, BOTTOM, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT or BOTTOM_RIGHT

Returns:

The bitmap, which has been created, as an instance of the class Bitmap or null, if the given elevation is 0

createElevationShadow

public static android.graphics.Bitmap createElevationShadow(android.content.Context context,
                                                            int elevation,
                                                            ElevationUtil.Orientation orientation,
                                                            boolean parallelLight)

Creates and returns a bitmap, which can be used to emulate a shadow of an elevated view on pre-Lollipop devices. This method furthermore allows to specify, whether parallel illumination of the view should be emulated, which causes the shadows at all of its sides to appear identically.

Parameters:

context - The context, which should be used, as an instance of the class Context. The context may not be null

elevation - The elevation, which should be emulated, in dp as an Integer value. The elevation must be at least 0 and at maximum the value of the constant MAX_ELEVATION

orientation - The orientation of the shadow in relation to the elevated view as a value of the enum ElevationUtil.Orientation. The orientation may either be LEFT, RIGHT, TOP, BOTTOM, TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT or BOTTOM_RIGHT

parallelLight - True, if parallel light should be emulated, false otherwise

Returns:

The bitmap, which has been created, as an instance of the class Bitmap or null, if the given elevation is 0