IconCompat

Kotlin |Java

open class IconCompat : CustomVersionedParcelable

androidx.core.graphics.drawable.IconCompat

Helper for accessing features in android.graphics.drawable.Icon.

Summary

Constants
static Int	TYPE_ADAPTIVE_BITMAP An icon that was created using createWithAdaptiveBitmap.
static Int	TYPE_BITMAP An icon that was created using createWithBitmap(Bitmap).
static Int	TYPE_DATA An icon that was created using createWithData(byte[], int, int).
static Int	TYPE_RESOURCE An icon that was created using #createWithResource.
static Int	TYPE_UNKNOWN Value returned when the type of an Icon cannot be determined.
static Int	TYPE_URI An icon that was created using #createWithContentUri.
static Int	TYPE_URI_ADAPTIVE_BITMAP An icon that was created using #createWithAdaptiveBitmapContentUri.

Public methods
open static IconCompat?	createFromBundle(@NonNull bundle: Bundle) Extracts an icon from a bundle that was added using toBundle().
open static IconCompat?	createFromIcon(@NonNull context: Context, @NonNull icon: Icon) Creates an IconCompat from an Icon.
open static IconCompat!	createWithAdaptiveBitmap(bits: Bitmap!) Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by android.graphics.drawable.AdaptiveIconDrawable.
open static IconCompat	createWithAdaptiveBitmapContentUri(@NonNull uri: String) Create an Icon pointing to an image file specified by URI.
open static IconCompat	createWithAdaptiveBitmapContentUri(@NonNull uri: Uri) Create an Icon pointing to an image file specified by URI.
open static IconCompat!	createWithBitmap(bits: Bitmap!) Create an Icon pointing to a bitmap in memory.
open static IconCompat!	createWithContentUri(uri: String!) Create an Icon pointing to an image file specified by URI.
open static IconCompat!	createWithContentUri(uri: Uri!) Create an Icon pointing to an image file specified by URI.
open static IconCompat!	createWithData(data: ByteArray!, offset: Int, length: Int) Create an Icon pointing to a compressed bitmap stored in a byte array.
open static IconCompat!	createWithResource(context: Context!, @DrawableRes resId: Int) Create an Icon pointing to a drawable resource.
open Int	getResId() Gets the resource id used to create this icon.
open String	getResPackage() Gets the package used to create this icon.
open Int	getType() Gets the type of the icon provided.
open Uri	getUri() Gets the uri used to create this icon.
open Drawable?	loadDrawable(@NonNull context: Context) Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary.
open Unit	onPostParceling()
open Unit	onPreParceling(isStream: Boolean)
open IconCompat!	setTint(@ColorInt tint: Int) Store a color to use whenever this Icon is drawn.
open IconCompat!	setTintList(tintList: ColorStateList!) Store a color to use whenever this Icon is drawn.
open IconCompat!	setTintMode(mode: Mode!) Store a blending mode to use whenever this Icon is drawn.
open Bundle	toBundle() Adds this Icon to a Bundle that can be read back with the same parameters to createFromBundle(Bundle).
open Icon	toIcon()
open Icon	toIcon(@Nullable context: Context?) Convert this compat object to Icon object.
open String	toString()

Constants

TYPE_ADAPTIVE_BITMAP

static val TYPE_ADAPTIVE_BITMAP: Int

An icon that was created using createWithAdaptiveBitmap.

Value: Icon.TYPE_ADAPTIVE_BITMAP

TYPE_BITMAP

static val TYPE_BITMAP: Int

An icon that was created using createWithBitmap(Bitmap).

Value: Icon.TYPE_BITMAP

TYPE_DATA

static val TYPE_DATA: Int

An icon that was created using createWithData(byte[], int, int).

Value: Icon.TYPE_DATA

TYPE_RESOURCE

static val TYPE_RESOURCE: Int

An icon that was created using #createWithResource.

Value: Icon.TYPE_RESOURCE

TYPE_UNKNOWN

static val TYPE_UNKNOWN: Int

Value returned when the type of an Icon cannot be determined.

Value: -1

TYPE_URI

static val TYPE_URI: Int

An icon that was created using #createWithContentUri.

Value: Icon.TYPE_URI

TYPE_URI_ADAPTIVE_BITMAP

static val TYPE_URI_ADAPTIVE_BITMAP: Int

An icon that was created using #createWithAdaptiveBitmapContentUri.

Value: Icon.TYPE_URI_ADAPTIVE_BITMAP

Public methods

createFromBundle

@Nullable open static fun createFromBundle(@NonNull bundle: Bundle): IconCompat?

Extracts an icon from a bundle that was added using toBundle().

createFromIcon

@RequiresApi(23) @Nullable open static fun createFromIcon(
    @NonNull context: Context, 
    @NonNull icon: Icon
): IconCompat?

Creates an IconCompat from an Icon.

createWithAdaptiveBitmap

open static fun createWithAdaptiveBitmap(bits: Bitmap!): IconCompat!

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

Parameters
bits	Bitmap!: A valid android.graphics.Bitmap object

See Also

• android.graphics.drawable.Icon#createWithAdaptiveBitmap(Bitmap)

createWithAdaptiveBitmapContentUri

@NonNull open static fun createWithAdaptiveBitmapContentUri(@NonNull uri: String): IconCompat

Create an Icon pointing to an image file specified by URI. Image file should follow the icon design guideline defined by AdaptiveIconDrawable.

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

See Also

• android.graphics.drawable.Icon#createWithAdaptiveBitmapContentUri(String)

createWithAdaptiveBitmapContentUri

@NonNull open static fun createWithAdaptiveBitmapContentUri(@NonNull uri: Uri): IconCompat

Create an Icon pointing to an image file specified by URI. Image file should follow the icon design guideline defined by AdaptiveIconDrawable.

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

See Also

• android.graphics.drawable.Icon#createWithAdaptiveBitmapContentUri(String)

createWithBitmap

open static fun createWithBitmap(bits: Bitmap!): IconCompat!

Create an Icon pointing to a bitmap in memory.

Parameters
bits	Bitmap!: A valid android.graphics.Bitmap object

See Also

• android.graphics.drawable.Icon#createWithBitmap(Bitmap)

createWithContentUri

open static fun createWithContentUri(uri: String!): IconCompat!

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

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

See Also

• android.graphics.drawable.Icon#createWithContentUri(String)

createWithContentUri

open static fun createWithContentUri(uri: Uri!): IconCompat!

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

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

See Also

• android.graphics.drawable.Icon#createWithContentUri(String)

createWithData

open static fun createWithData(
    data: ByteArray!, 
    offset: Int, 
    length: Int
): IconCompat!

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

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

See Also

• android.graphics.drawable.Icon#createWithData(byte[], int, int)

createWithResource

open static fun createWithResource(
    context: Context!, 
    @DrawableRes resId: Int
): IconCompat!

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

See Also

• android.graphics.drawable.Icon#createWithResource(Context, int)

getResId

@IdRes open fun getResId(): Int

Gets the resource id used to create this icon.

Only valid for icons of type TYPE_RESOURCE. Note: This resource may not be available if the application changes at all, and it is up to the caller to ensure safety if this resource is re-used and/or persisted.

getResPackage

@NonNull open fun getResPackage(): String

Gets the package used to create this icon.

Only valid for icons of type TYPE_RESOURCE. Note: This package may not be available if referenced in the future, and it is up to the caller to ensure safety if this package is re-used and/or persisted.

getType

open fun getType(): Int

Gets the type of the icon provided.

Note that new types may be added later, so callers should guard against other types being returned.

getUri

@NonNull open fun getUri(): Uri

Gets the uri used to create this icon.

Only valid for icons of type TYPE_URI. Note: This uri may not be available in the future, and it is up to the caller to ensure safety if this uri is re-used and/or persisted.

loadDrawable

@Nullable open fun loadDrawable(@NonNull context: Context): Drawable?

Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary.

Parameters
context	Context: Context in which to load the drawable; used to access Resources, for example.

Return
Drawable?	A fresh instance of a drawable for this image, yours to keep.

onPostParceling

open fun onPostParceling(): Unit

onPreParceling

open fun onPreParceling(isStream: Boolean): Unit

setTint

open fun setTint(@ColorInt tint: Int): IconCompat!

Store a color to use whenever this Icon is drawn.

Parameters
tint	Int: a color, as in Drawable#setTint(int)

Return
IconCompat!	this same object, for use in chained construction

setTintList

open fun setTintList(tintList: ColorStateList!): IconCompat!

Store a color to use whenever this Icon is drawn.

Parameters
tintList	ColorStateList!: as in Drawable#setTintList(ColorStateList), null to remove tint

Return
IconCompat!	this same object, for use in chained construction

setTintMode

open fun setTintMode(mode: Mode!): IconCompat!

Store a blending mode to use whenever this Icon is drawn.

Parameters
mode	Mode!: a blending mode, as in Drawable#setTintMode(PorterDuff.Mode), may be null

Return
IconCompat!	this same object, for use in chained construction

toBundle

@NonNull open fun toBundle(): Bundle

Adds this Icon to a Bundle that can be read back with the same parameters to createFromBundle(Bundle).

toIcon

@RequiresApi(23) @NonNull open fun toIcon(): Icon

Deprecated: Use toIcon(Context) to generate the Icon object.

toIcon

@RequiresApi(23) @NonNull open fun toIcon(@Nullable context: Context?): Icon

Convert this compat object to Icon object.

Return
Icon	Icon object

toString

@NonNull open fun toString(): String