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.

Method Summary

Modifier and Type	Method and Description
static android.graphics.drawable.Drawable	createElevationShadow(android.content.Context context, int elevation, ElevationUtil.Orientation orientation) Creates and returns a drawable, which can be used to emulate the shadow of an elevated view on pre-Lollipop devices.
static int	getElevationShadowWidth(android.content.Context context, int elevation, ElevationUtil.Orientation orientation) Returns the width of the drawable, which can be used to emulate the 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

Method Detail

createElevationShadow

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

Creates and returns a drawable, which can be used to emulate the shadow of an elevated view on pre-Lollipop devices.

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 5

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 or BOTTOM

Returns:

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

getElevationShadowWidth

public static int getElevationShadowWidth(android.content.Context context,
                                          int elevation,
                                          ElevationUtil.Orientation orientation)

Returns the width of the drawable, which can be used to emulate the shadow of an elevated view on pre-Lollipop devices.

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 5

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 or BOTTOM

Returns:

The width of the drawable in pixels as an Integer value or 0, if the given elevation is 0