de.mrapp.android.util

Class BitmapUtil

java.lang.Object

de.mrapp.android.util.BitmapUtil

public final class BitmapUtil
extends java.lang.Object

An utility class, which provides static methods, which allow to create and edit bitmaps.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static android.graphics.Bitmap	clipCircle(android.graphics.Bitmap bitmap) Clips the corners of a bitmap in order to transform it into a round shape.
static android.graphics.Bitmap	clipCircle(android.graphics.Bitmap bitmap, int size) Clips the corners of a bitmap in order to transform it into a round shape.
static android.graphics.Bitmap	clipCircle(android.graphics.Bitmap bitmap, int borderWidth, int borderColor) Clips the corners of a bitmap in order to transform it into a round shape.
static android.graphics.Bitmap	clipCircle(android.graphics.Bitmap bitmap, int size, int borderWidth, int borderColor) Clips the corners of a bitmap in order to transform it into a round shape.
static android.graphics.Bitmap	clipSquare(android.graphics.Bitmap bitmap) Clips the long edge of a bitmap, if its width and height are not equal, in order to form it into a square.
static android.graphics.Bitmap	clipSquare(android.graphics.Bitmap bitmap, int size) Clips the long edge of a bitmap, if its width and height are not equal, in order to form it into a square.
static android.graphics.Bitmap	clipSquare(android.graphics.Bitmap bitmap, int borderWidth, int borderColor) Clips the long edge of a bitmap, if its width and height are not equal, in order to transform it into a square.
static android.graphics.Bitmap	clipSquare(android.graphics.Bitmap bitmap, int size, int borderWidth, int borderColor) Clips the long edge of a bitmap, if its width and height are not equal, in order to transform it into a square.
static android.graphics.Bitmap	colorToBitmap(int width, int height, int color) Creates and returns a bitmap from a specific color.
static byte[]	compressToByteArray(android.graphics.Bitmap bitmap, android.graphics.Bitmap.CompressFormat format, int quality) Compresses a specific bitmap and returns it as a byte array.
static void	compressToFile(android.graphics.Bitmap bitmap, java.io.File file, android.graphics.Bitmap.CompressFormat format, int quality) Compresses a specific bitmap and stores it within a file.
static android.graphics.Bitmap	drawableToBitmap(android.graphics.drawable.Drawable drawable) Creates and returns a bitmap from a specific drawable.
static <any>	getImageDimensions(android.content.Context context, int resourceId) Returns the width and height of a specific image resource.
static <any>	getImageDimensions(java.io.File file) Returns the width and height of a specific image file.
static android.graphics.Bitmap	loadThumbnail(android.content.Context context, int resourceId, int maxWidth, int maxHeight) Loads a downsampled thumbnail of a specific image resource while maintaining its aspect ratio.
static android.graphics.Bitmap	loadThumbnail(java.io.File file, int maxWidth, int maxHeight) Loads a downsampled thumbnail of a specific image file while maintaining its aspect ratio.
static android.graphics.Bitmap	resize(android.graphics.Bitmap bitmap, int width, int height) Resizes a bitmap to a specific width and height.
static <any>	splitHorizontally(android.graphics.Bitmap bitmap) Splits a specific bitmap horizontally at half.
static <any>	splitHorizontally(android.graphics.Bitmap bitmap, int splitPoint) Splits a specific bitmap horizontally at a specific split point.
static <any>	splitVertically(android.graphics.Bitmap bitmap) Splits a specific bitmap vertically at half.
static <any>	splitVertically(android.graphics.Bitmap bitmap, int splitPoint) Splits a specific bitmap vertically at a specific split point.
static android.graphics.Bitmap	textToBitmap(android.content.Context context, int width, int height, int backgroundColor, java.lang.CharSequence text, float textSize, int textColor) Creates and returns a bitmap from a specific text.
static android.graphics.Bitmap	textToBitmap(android.content.Context context, int width, int height, int backgroundColor, java.lang.CharSequence text, float textSize, int textColor, android.graphics.Typeface typeface) Creates and returns a bitmap from a specific text.
static android.graphics.Bitmap	tile(android.graphics.Bitmap bitmap, int width, int height) Creates and returns a bitmap with a specific width and height by tiling another bitmap.
static android.graphics.Bitmap	tint(android.graphics.Bitmap bitmap, int color) Creates and returns a bitmap by overlaying it with a specific color.

Methods inherited from class java.lang.Object

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

Method Detail

clipCircle

public static android.graphics.Bitmap clipCircle(android.graphics.Bitmap bitmap)

Clips the corners of a bitmap in order to transform it into a round shape. Bitmaps, whose width and height are not equal, will be clipped to a square beforehand.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

Returns:

The clipped bitmap as an instance of the class Bitmap

clipCircle

public static android.graphics.Bitmap clipCircle(android.graphics.Bitmap bitmap,
                                                 int size)

Clips the corners of a bitmap in order to transform it into a round shape. Additionally, the bitmap is resized to a specific size. Bitmaps, whose width and height are not equal, will be clipped to a square beforehand.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

size - The size, the bitmap should be resized to, as an Integer value in pixels. The size must be at least 1

Returns:

The clipped bitmap as an instance of the class Bitmap

clipCircle

public static android.graphics.Bitmap clipCircle(android.graphics.Bitmap bitmap,
                                                 int borderWidth,
                                                 int borderColor)

Clips the corners of a bitmap in order to transform it into a round shape. Additionally, a border will be added. Bitmaps, whose width and height are not equal, will be clipped to a square beforehand.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

borderWidth - The width of the border as an Integer value in pixels. The width must be at least 0

borderColor - The color of the border as an Integer value

Returns:

The clipped bitmap as an instance of the class Bitmap

clipCircle

public static android.graphics.Bitmap clipCircle(android.graphics.Bitmap bitmap,
                                                 int size,
                                                 int borderWidth,
                                                 int borderColor)

Clips the corners of a bitmap in order to transform it into a round shape. Additionally, the bitmap is resized to a specific size and a border will be added. Bitmaps, whose width and height are not equal, will be clipped to a square beforehand.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

size - The size, the bitmap should be resized to, as an Integer value in pixels. The size must be at least 1

borderWidth - The width of the border as an Integer value in pixels. The width must be at least 0

borderColor - The color of the border as an Integer value

Returns:

The clipped bitmap as an instance of the class Bitmap

clipSquare

public static android.graphics.Bitmap clipSquare(android.graphics.Bitmap bitmap)

Clips the long edge of a bitmap, if its width and height are not equal, in order to form it into a square.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

Returns:

The clipped bitmap as an instance of the class Bitmap

clipSquare

public static android.graphics.Bitmap clipSquare(android.graphics.Bitmap bitmap,
                                                 int size)

Clips the long edge of a bitmap, if its width and height are not equal, in order to form it into a square. Additionally, the bitmap is resized to a specific size.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

size - The size, the bitmap should be resized to, as an Integer value in pixels. The size must be at least 1

Returns:

The clipped bitmap as an instance of the class Bitmap

clipSquare

public static android.graphics.Bitmap clipSquare(android.graphics.Bitmap bitmap,
                                                 int borderWidth,
                                                 int borderColor)

Clips the long edge of a bitmap, if its width and height are not equal, in order to transform it into a square. Additionally, a border will be added.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

borderWidth - The width of the border as an Integer value in pixels. The width must be at least 0

borderColor - The color of the border as an Integer value

Returns:

The clipped bitmap as an instance of the class Bitmap

clipSquare

public static android.graphics.Bitmap clipSquare(android.graphics.Bitmap bitmap,
                                                 int size,
                                                 int borderWidth,
                                                 int borderColor)

Clips the long edge of a bitmap, if its width and height are not equal, in order to transform it into a square. Additionally, the bitmap is resized to a specific size and a border will be added.

Parameters:

bitmap - The bitmap, which should be clipped, as an instance of the class Bitmap. The bitmap may not be null

size - The size, the bitmap should be resized to, as an Integer value in pixels. The size must be at least 1

borderWidth - The width of the border as an Integer value in pixels. The width must be at least 0

borderColor - The color of the border as an Integer value

Returns:

The clipped bitmap as an instance of the class Bitmap

resize

public static android.graphics.Bitmap resize(android.graphics.Bitmap bitmap,
                                             int width,
                                             int height)

Resizes a bitmap to a specific width and height. If the ratio between width and height differs from the bitmap's original ratio, the bitmap is stretched.

Parameters:

bitmap - The bitmap, which should be resized, as an instance of the class Bitmap. The bitmap may not be null

width - The width, the bitmap should be resized to, as an Integer value in pixels. The width must be at least 1

height - The height, the bitmap should be resized to, as an Integer value in pixels. The height must be at least 1

Returns:

The resized bitmap as an instance of the class Bitmap

splitHorizontally

public static <any> splitHorizontally(android.graphics.Bitmap bitmap)

Splits a specific bitmap horizontally at half.

Parameters:

bitmap - The bitmap, which should be split, as an instance of the class Bitmap. The bitmap may not be null

Returns:

A pair, which contains the two bitmaps, which the original bitmap has been split into, as an instance of the class Pair

splitHorizontally

public static <any> splitHorizontally(android.graphics.Bitmap bitmap,
                                      int splitPoint)

Splits a specific bitmap horizontally at a specific split point.

Parameters:

bitmap - The bitmap, which should be split, as an instance of the class Bitmap. The bitmap may not be null

splitPoint - The row, the bitmap should be split at, counted from the top edge in pixels as an Integer value

Returns:

A pair, which contains the two bitmaps, the original bitmap has been split into, as an instance of the class Pair

splitVertically

public static <any> splitVertically(android.graphics.Bitmap bitmap)

Splits a specific bitmap vertically at half.

Parameters:

bitmap - The bitmap, which should be split, as an instance of the class Bitmap. The bitmap may not be null

Returns:

A pair, which contains the two bitmaps, the original bitmap has been split into, as an instance of the class Pair

splitVertically

public static <any> splitVertically(android.graphics.Bitmap bitmap,
                                    int splitPoint)

Splits a specific bitmap vertically at a specific split point.

Parameters:

bitmap - The bitmap, which should be split, as an instance of the class Bitmap. The bitmap may not be null

splitPoint - The column, the bitmap should be split at, counted from the left edge in pixels as an Integer value

Returns:

A pair, which contains the two bitmaps, the original bitmap has been split into, as an instance of the class Pair

tile

public static android.graphics.Bitmap tile(android.graphics.Bitmap bitmap,
                                           int width,
                                           int height)

Creates and returns a bitmap with a specific width and height by tiling another bitmap.

Parameters:

bitmap - The bitmap, which should be tiled, as an instance of the class Bitmap. The bitmap may not be null

width - The width of the bitmap as an Integer value in pixels. The width must be at least 1

height - The height of the bitmap as an Integer value in pixels. The height must be at least 1

Returns:

The bitmap, which has been created as an instance of the class Bitmap

tint

public static android.graphics.Bitmap tint(android.graphics.Bitmap bitmap,
                                           int color)

Creates and returns a bitmap by overlaying it with a specific color.

Parameters:

bitmap - The bitmap, which should be tinted, as an instance of the class Bitmap. The bitmap may not be null

color - The color, which should be used for tinting, as an Integer value

Returns:

The bitmap, which has been created, as an instance of the class Bitmap

drawableToBitmap

public static android.graphics.Bitmap drawableToBitmap(android.graphics.drawable.Drawable drawable)

Creates and returns a bitmap from a specific drawable.

Parameters:

drawable - The drawable, which should be converted, as an instance of the class Drawable. The drawable may not be null

Returns:

The bitmap, which has been created, as an instance of the class Bitmap

textToBitmap

public static android.graphics.Bitmap textToBitmap(android.content.Context context,
                                                   int width,
                                                   int height,
                                                   int backgroundColor,
                                                   java.lang.CharSequence text,
                                                   float textSize,
                                                   int textColor)

Creates and returns a bitmap from a specific text. The text is centered.

Parameters:

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

width - The width of the bitmap, which should be created, in pixels as an Integer value

height - The height of the bitmap, which should be created, in pixels as an Integer value

backgroundColor - The background color of the bitmap, which should be created, as an Integer value

text - The text, the bitmap should be created from, as an instance of the type CharSequence. The text may neither be null, nor empty

textSize - The text size, which should be used, in sp as an Integer value

textColor - The text color, which should be used, as an Integer value The color of the text

Returns:

The bitmap, which has been created, as an instance of the class Bitmap

textToBitmap

public static android.graphics.Bitmap textToBitmap(android.content.Context context,
                                                   int width,
                                                   int height,
                                                   int backgroundColor,
                                                   java.lang.CharSequence text,
                                                   float textSize,
                                                   int textColor,
                                                   android.graphics.Typeface typeface)

Creates and returns a bitmap from a specific text. The text is centered.

Parameters:

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

width - The width of the bitmap, which should be created, in pixels as an Integer value

height - The height of the bitmap, which should be created, in pixels as an Integer value

backgroundColor - The background color of the bitmap, which should be created, as an Integer value

text - The text, the bitmap should be created from, as an instance of the type CharSequence. The text may neither be null, nor empty

textSize - The text size, which should be used, in sp as an Integer value

textColor - The text color, which should be used, as an Integer value The color of the text

typeface - The typeface, which should be used, as a value of the enum Typeface or null, if the default typeface should be used

Returns:

The bitmap, which has been created, as an instance of the class Bitmap

colorToBitmap

public static android.graphics.Bitmap colorToBitmap(int width,
                                                    int height,
                                                    int color)

Creates and returns a bitmap from a specific color.

Parameters:

width - The width of the bitmap, which should be created, in pixels as an Integer value. The width must be at least 1

height - The height of the bitmap, which should be created, in pixels as an Integer value. The height must be at least 1

color - The color, which should be used, as an Integer value

Returns:

The bitmap, which has been created, as an instance of the class Bitmap

getImageDimensions

public static <any> getImageDimensions(java.io.File file)
                                throws java.io.IOException

Returns the width and height of a specific image file.

Parameters:

file - The image file, whose width and height should be returned, as an instance of the class File. The file may not be null. The file must exist and must not be a directory

Returns:

A pair, which contains the width and height of the given image file, as an instance of the class Pair

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while decoding the image file

getImageDimensions

public static <any> getImageDimensions(android.content.Context context,
                                       int resourceId)
                                throws java.io.IOException

Returns the width and height of a specific image resource.

Parameters:

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

resourceId - The resource id of the image resource, whose width and height should be returned, as an Integer value. The resource id must correspond to a valid drawable resource

Returns:

A pair, which contains the width and height of the given image resource, as an instance of the class Pair

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while decoding the image resource

loadThumbnail

public static android.graphics.Bitmap loadThumbnail(java.io.File file,
                                                    int maxWidth,
                                                    int maxHeight)
                                             throws java.io.IOException

Loads a downsampled thumbnail of a specific image file while maintaining its aspect ratio.

Parameters:

file - The image file, which should be loaded, as an instance of the class File. The file may not be null. The file must exist and must not be a directory

maxWidth - The maximum width of the thumbnail in pixels as an Integer value. The maximum width must be at least 1

maxHeight - The maximum height of the thumbnail in pixels as an Integer value. The maximum height must be at least 1

Returns:

The thumbnail, which has been loaded, as an instance of the class Bitmap

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while decoding the image file

loadThumbnail

public static android.graphics.Bitmap loadThumbnail(android.content.Context context,
                                                    int resourceId,
                                                    int maxWidth,
                                                    int maxHeight)
                                             throws java.io.IOException

Loads a downsampled thumbnail of a specific image resource while maintaining its aspect ratio.

Parameters:

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

resourceId - The resource id of the image resource, which should be loaded, as an Integer value. The resource id must correspond to a valid drawable resource

maxWidth - The maximum width of the thumbnail in pixels as an Integer value. The maximum width must be at least 1

maxHeight - The maximum height of the thumbnail in pixels as an Integer value. The maximum height must be at least 1

Returns:

The thumbnail, which has been loaded, as an instance of the class Bitmap

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while decoding the image resource

compressToFile

public static void compressToFile(android.graphics.Bitmap bitmap,
                                  java.io.File file,
                                  android.graphics.Bitmap.CompressFormat format,
                                  int quality)
                           throws java.io.IOException

Compresses a specific bitmap and stores it within a file.

Parameters:

bitmap - The bitmap, which should be compressed, as an instance of the class Bitmap. The bitmap may not be null

file - The file, the bitmap should be compressed to, as an instance of the class File. The file may not be null

format - The format, which should be used to compress the bitmap, as a value of the enum Bitmap.CompressFormat. The format must either be JPEG, PNG or WEBP

quality - The quality, which should be used to compress the bitmap, as an Integer value. The quality must be at least 0 (lowest quality) and at maximum 100 (highest quality)

Throws:

java.io.FileNotFoundException - The exception, which is thrown, if the given file could not be opened for writing

java.io.IOException - The exception, which is thrown, if an error occurs while compressing the bitmap

compressToByteArray

public static byte[] compressToByteArray(android.graphics.Bitmap bitmap,
                                         android.graphics.Bitmap.CompressFormat format,
                                         int quality)
                                  throws java.io.IOException

Compresses a specific bitmap and returns it as a byte array.

Parameters:

bitmap - The bitmap, which should be compressed, as an instance of the class Bitmap. The bitmap may not be null

format - The format, which should be used to compress the bitmap, as a value of the enum Bitmap.CompressFormat. The format must either be JPEG, PNG or WEBP

quality - The quality, which should be used to compress the bitmap, as an Integer value. The quality must be at least 0 (lowest quality) and at maximum 100 (highest quality)

Returns:

The byte array, the given bitmap has been compressed to, as a Byte array

Throws:

java.io.IOException - The exception, which is thrown, if an error occurs while compressing the bitmap