Skip to content

Most visited

Recently visited

navigation

WallpaperColors

public final class WallpaperColors
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.WallpaperColors


Provides information about the colors of a wallpaper.

Exposes the 3 most visually representative colors of a wallpaper. Can be either getPrimaryColor(), getSecondaryColor() or getTertiaryColor().

Summary

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<WallpaperColors> CREATOR

Public constructors

WallpaperColors(Parcel parcel)
WallpaperColors(Color primaryColor, Color secondaryColor, Color tertiaryColor)

Constructs a new object from three colors.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

static WallpaperColors fromBitmap(Bitmap bitmap)

Constructs WallpaperColors from a bitmap.

static WallpaperColors fromDrawable(Drawable drawable)

Constructs WallpaperColors from a drawable.

Color getPrimaryColor()

Gets the most visually representative color of the wallpaper.

Color getSecondaryColor()

Gets the second most preeminent color of the wallpaper.

Color getTertiaryColor()

Gets the third most preeminent color of the wallpaper.

int hashCode()

Returns a hash code value for the object.

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
From interface android.os.Parcelable

Fields

CREATOR

added in API level 27
Creator<WallpaperColors> CREATOR

Public constructors

WallpaperColors

added in API level 27
WallpaperColors (Parcel parcel)

Parameters
parcel Parcel

WallpaperColors

added in API level 27
WallpaperColors (Color primaryColor, 
                Color secondaryColor, 
                Color tertiaryColor)

Constructs a new object from three colors.

Parameters
primaryColor Color: Primary color.

This value must never be null.

secondaryColor Color: Secondary color.

This value may be null.

tertiaryColor Color: Tertiary color.

This value may be null.

See also:

Public methods

describeContents

added in API level 27
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

added in API level 27
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

fromBitmap

added in API level 27
WallpaperColors fromBitmap (Bitmap bitmap)

Constructs WallpaperColors from a bitmap.

Main colors will be extracted from the bitmap.

Parameters
bitmap Bitmap: Source where to extract from.

This value must never be null.

Returns
WallpaperColors

fromDrawable

added in API level 27
WallpaperColors fromDrawable (Drawable drawable)

Constructs WallpaperColors from a drawable.

Main colors will be extracted from the drawable.

Parameters
drawable Drawable: Source where to extract from.

Returns
WallpaperColors

getPrimaryColor

added in API level 27
Color getPrimaryColor ()

Gets the most visually representative color of the wallpaper. "Visually representative" means easily noticeable in the image, probably happening at high frequency.

Returns
Color A color.

This value will never be null.

getSecondaryColor

added in API level 27
Color getSecondaryColor ()

Gets the second most preeminent color of the wallpaper. Can be null.

Returns
Color A color, may be null.

getTertiaryColor

added in API level 27
Color getTertiaryColor ()

Gets the third most preeminent color of the wallpaper. Can be null.

Returns
Color A color, may be null.

hashCode

added in API level 27
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

toString

added in API level 27
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

added in API level 27
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_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)