Most visited

Recently visited

Results for

Icon

public final class Icon
extends Object implements Parcelable

java.lang.Object
↳	android.graphics.drawable.Icon

An umbrella container for several serializable graphics representations, including Bitmaps, compressed bitmap images (e.g. JPG or PNG), and drawable resources (including vectors). Much ink has been spilled on the best way to load images, and many clients may have different needs when it comes to threading and fetching. This class is therefore focused on encapsulation rather than behavior.

Summary

Nested classes
`interface`	`Icon.OnDrawableLoadedListener` Implement this interface to receive a callback when `loadDrawableAsync` is finished and your Drawable is ready.

Constants
`int`	`TYPE_ADAPTIVE_BITMAP` An icon that was created using `Icon#createWithAdaptiveBitmap`.
`int`	`TYPE_BITMAP` An icon that was created using `Icon#createWithBitmap(Bitmap)`.
`int`	`TYPE_DATA` An icon that was created using `Icon#createWithData(byte[], int, int)`.
`int`	`TYPE_RESOURCE` An icon that was created using `Icon#createWithResource`.
`int`	`TYPE_URI` An icon that was created using `Icon#createWithContentUri` or `Icon#createWithFilePath(String)`.
`int`	`TYPE_URI_ADAPTIVE_BITMAP` An icon that was created using `Icon#createWithAdaptiveBitmapContentUri`.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<Icon>`	`CREATOR`

Public methods
`static Icon`	`createWithAdaptiveBitmap(Bitmap bits)` Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by `AdaptiveIconDrawable`.
`static Icon`	`createWithAdaptiveBitmapContentUri(String uri)` Create an Icon pointing to an image file specified by URI.
`static Icon`	`createWithAdaptiveBitmapContentUri(Uri uri)` Create an Icon pointing to an image file specified by URI.
`static Icon`	`createWithBitmap(Bitmap bits)` Create an Icon pointing to a bitmap in memory.
`static Icon`	`createWithContentUri(String uri)` Create an Icon pointing to an image file specified by URI.
`static Icon`	`createWithContentUri(Uri uri)` Create an Icon pointing to an image file specified by URI.
`static Icon`	`createWithData(byte[] data, int offset, int length)` Create an Icon pointing to a compressed bitmap stored in a byte array.
`static Icon`	`createWithFilePath(String path)` Create an Icon pointing to an image file specified by path.
`static Icon`	`createWithResource(String resPackage, int resId)` Create an Icon pointing to a drawable resource.
`static Icon`	`createWithResource(Context context, int resId)` Create an Icon pointing to a drawable resource.
`int`	`describeContents()` Parcelable interface
`int`	`getResId()` Gets the resource used to create this icon.
`String`	`getResPackage()` Gets the package used to create this icon.
`int`	`getType()` Gets the type of the icon provided.
`Uri`	`getUri()` Gets the uri used to create this icon.
`Drawable`	`loadDrawable(Context context)` Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary.
`void`	`loadDrawableAsync(Context context, Message andThen)` Invokes `loadDrawable(android.content.Context)` on the given `Handler` and then sends `andThen` to the same Handler when finished.
`void`	`loadDrawableAsync(Context context, Icon.OnDrawableLoadedListener listener, Handler handler)` Invokes `loadDrawable(android.content.Context)` on a background thread and notifies the `listener` on the `handler` when finished.
`Icon`	`setTint(int tint)` Store a color to use whenever this Icon is drawn.
`Icon`	`setTintBlendMode(BlendMode mode)` Store a blending mode to use whenever this Icon is drawn.
`Icon`	`setTintList(ColorStateList tintList)` Store a color to use whenever this Icon is drawn.
`Icon`	`setTintMode(PorterDuff.Mode mode)` Store a blending mode to use whenever this Icon is drawn.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

TYPE_ADAPTIVE_BITMAP

public static final int TYPE_ADAPTIVE_BITMAP

An icon that was created using Icon#createWithAdaptiveBitmap.

See also:

getType()

Constant Value: 5 (0x00000005)

TYPE_BITMAP

public static final int TYPE_BITMAP

An icon that was created using Icon#createWithBitmap(Bitmap).

See also:

getType()

Constant Value: 1 (0x00000001)

TYPE_DATA

public static final int TYPE_DATA

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

See also:

getType()

Constant Value: 3 (0x00000003)

TYPE_RESOURCE

public static final int TYPE_RESOURCE

An icon that was created using Icon#createWithResource.

See also:

getType()

Constant Value: 2 (0x00000002)

TYPE_URI

public static final int TYPE_URI

An icon that was created using Icon#createWithContentUri or Icon#createWithFilePath(String).

See also:

getType()

Constant Value: 4 (0x00000004)

TYPE_URI_ADAPTIVE_BITMAP

public static final int TYPE_URI_ADAPTIVE_BITMAP

An icon that was created using Icon#createWithAdaptiveBitmapContentUri.

See also:

getType()

Constant Value: 6 (0x00000006)

Fields

CREATOR

public static final Creator<Icon> CREATOR

Public methods

createWithAdaptiveBitmap

public static Icon 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
`Icon`

createWithAdaptiveBitmapContentUri

public static Icon createWithAdaptiveBitmapContentUri (String uri)

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. This value cannot be `null`.

Returns
`Icon`	This value cannot be `null`.

createWithAdaptiveBitmapContentUri

public static Icon createWithAdaptiveBitmapContentUri (Uri uri)

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. This value cannot be `null`.

Returns
`Icon`	This value cannot be `null`.

createWithBitmap

public static Icon createWithBitmap (Bitmap bits)

Create an Icon pointing to a bitmap in memory.

Parameters
`bits`	`Bitmap`: A valid `Bitmap` object

Returns
`Icon`

createWithContentUri

public static Icon 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
`Icon`

createWithContentUri

public static Icon 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
`Icon`

createWithData

public static Icon 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
`Icon`

createWithFilePath

public static Icon createWithFilePath (String path)

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

Parameters
`path`	`String`: A path to a file that contains compressed bitmap data of a type that `BitmapFactory` can decode.

Returns
`Icon`

createWithResource

public static Icon createWithResource (String resPackage, 
                int resId)

Create an Icon pointing to a drawable resource.

Parameters
`resPackage`	`String`: Name of the package containing the resource in question
`resId`	`int`: ID of the drawable resource

Returns
`Icon`

createWithResource

public static Icon 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
`Icon`

describeContents

public int describeContents ()

Parcelable interface

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getResId

public int getResId ()

Gets the resource 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.

Returns
`int`

getResPackage

public String getResPackage ()

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.

Returns
`String`	This value cannot be `null`.

getType

public int getType ()

Gets the type of the icon provided.

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

Returns
`int`	Value is `TYPE_BITMAP`, `TYPE_RESOURCE`, `TYPE_DATA`, `TYPE_URI`, `TYPE_ADAPTIVE_BITMAP`, or `TYPE_URI_ADAPTIVE_BITMAP`

getUri

public Uri getUri ()

Gets the uri used to create this icon.

Only valid for icons of type TYPE_URI and TYPE_URI_ADAPTIVE_BITMAP. 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.

Returns
`Uri`	This value cannot be `null`.

loadDrawable

public Drawable loadDrawable (Context context)

Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary. Depending on the type of image, this may not be something you want to do on the UI thread, so consider using loadDrawableAsync instead.

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

Returns
`Drawable`	A fresh instance of a drawable for this image, yours to keep.

loadDrawableAsync

public void loadDrawableAsync (Context context, 
                Message andThen)

Invokes loadDrawable(android.content.Context) on the given Handler and then sends andThen to the same Handler when finished.

Parameters
`context`	`Context`: `Context` in which to load the drawable; see `loadDrawable(android.content.Context)`
`andThen`	`Message`: `Message` to send to its target once the drawable is available. The `obj` property is populated with the Drawable.

loadDrawableAsync

public void loadDrawableAsync (Context context, 
                Icon.OnDrawableLoadedListener listener, 
                Handler handler)

Invokes loadDrawable(android.content.Context) on a background thread and notifies the listener on the handler when finished.

Parameters
`context`	`Context`: `Context` in which to load the drawable; see `loadDrawable(android.content.Context)`
`listener`	`Icon.OnDrawableLoadedListener`: to be `notified` when `loadDrawable(android.content.Context)` finished
`handler`	`Handler`: `Handler` on which to notify the `listener`

setTint

public Icon setTint (int tint)

Store a color to use whenever this Icon is drawn.

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

Returns
`Icon`	this same object, for use in chained construction

setTintBlendMode

public Icon setTintBlendMode (BlendMode mode)

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

Parameters
`mode`	`BlendMode`: a blending mode, as in `Drawable#setTintMode(PorterDuff.Mode)`, may be null This value cannot be `null`.

Returns
`Icon`	this same object, for use in chained construction

setTintList

public Icon setTintList (ColorStateList tintList)

Store a color to use whenever this Icon is drawn.

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

Returns
`Icon`	this same object, for use in chained construction

setTintMode

public Icon setTintMode (PorterDuff.Mode mode)

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

Parameters
`mode`	`PorterDuff.Mode`: a blending mode, as in `Drawable#setTintMode(PorterDuff.Mode)`, may be null This value cannot be `null`.

Returns
`Icon`	this same object, for use in chained construction

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Most visited

Recently visited

Results for

Icon

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

TYPE_ADAPTIVE_BITMAP

TYPE_BITMAP

TYPE_DATA

TYPE_RESOURCE

TYPE_URI

TYPE_URI_ADAPTIVE_BITMAP

Fields

CREATOR

Public methods

createWithAdaptiveBitmap

createWithAdaptiveBitmapContentUri

createWithAdaptiveBitmapContentUri

createWithBitmap

createWithContentUri

createWithContentUri

createWithData

createWithFilePath

createWithResource

createWithResource

describeContents

getResId

getResPackage

getType

getUri

loadDrawable

loadDrawableAsync

loadDrawableAsync

setTint

setTintBlendMode

setTintList

setTintMode

toString

writeToParcel