added in version 26.1.0
belongs to Maven artifact com.android.support:support-compat:28.0.0-alpha1

Summary: Methods | Inherited Methods | [Expand All]

IconCompat

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class IconCompat
extends Object

java.lang.Object
↳	android.support.v4.graphics.drawable.IconCompat

---

Helper for accessing features in Icon.

Summary

Public methods
static IconCompat	createWithAdaptiveBitmap(Bitmap bits) Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by AdaptiveIconDrawable.
static IconCompat	createWithBitmap(Bitmap bits) Create an Icon pointing to a bitmap in memory.
static IconCompat	createWithContentUri(String uri) Create an Icon pointing to an image file specified by URI.
static IconCompat	createWithContentUri(Uri uri) Create an Icon pointing to an image file specified by URI.
static IconCompat	createWithData(byte[] data, int offset, int length) Create an Icon pointing to a compressed bitmap stored in a byte array.
static IconCompat	createWithResource(Context context, int resId) Create an Icon pointing to a drawable resource.
Icon	toIcon() Convert this compat object to Icon object.

Inherited methods
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()

Public methods

createWithAdaptiveBitmap

added in version 26.1.0

IconCompat createWithAdaptiveBitmap (Bitmap bits)

Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by AdaptiveIconDrawable.

Parameters
bits	Bitmap: A valid Bitmap object

Returns
IconCompat

See also:

• createWithAdaptiveBitmap(Bitmap)

createWithBitmap

added in version 26.1.0

IconCompat createWithBitmap (Bitmap bits)

Create an Icon pointing to a bitmap in memory.

Parameters
bits	Bitmap: A valid Bitmap object

Returns
IconCompat

See also:

• createWithBitmap(Bitmap)

createWithContentUri

added in version 26.1.0

IconCompat createWithContentUri (String uri)

Create an Icon pointing to an image file specified by URI.

Parameters
uri	String: A uri referring to local content:// or file:// image data.

Returns
IconCompat

See also:

• createWithContentUri(String)

createWithContentUri

added in version 26.1.0

IconCompat createWithContentUri (Uri uri)

Create an Icon pointing to an image file specified by URI.

Parameters
uri	Uri: A uri referring to local content:// or file:// image data.

Returns
IconCompat

See also:

• createWithContentUri(String)

createWithData

added in version 26.1.0

IconCompat createWithData (byte[] data, 
                int offset, 
                int length)

Create an Icon pointing to a compressed bitmap stored in a byte array.

Parameters
data	byte: Byte array storing compressed bitmap data of a type that BitmapFactory can decode (see Bitmap.CompressFormat).
offset	int: Offset into data at which the bitmap data starts
length	int: Length of the bitmap data

Returns
IconCompat

See also:

• createWithData(byte[], int, int)

createWithResource

added in version 26.1.0

IconCompat createWithResource (Context context, 
                int resId)

Create an Icon pointing to a drawable resource.

Parameters
context	Context: The context for the application whose resources should be used to resolve the given resource ID.
resId	int: ID of the drawable resource

Returns
IconCompat

See also:

• createWithResource(Context, int)

toIcon

added in version 27.1.0

Icon toIcon ()

Convert this compat object to Icon object.

Returns
Icon	Icon object

• Classes

  • DrawableCompat
  • IconCompat
  • RoundedBitmapDrawable
  • RoundedBitmapDrawableFactory