Android APIs
public static final class

Palette.Swatch

extends Object
java.lang.Object
   ↳ android.support.v7.graphics.Palette.Swatch

Class Overview

Represents a color swatch generated from an image's palette. The RGB color can be retrieved by calling getRgb().

Summary

Public Constructors
Palette.Swatch(int color, int population)
Public Methods
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
int getBodyTextColor()
Returns an appropriate color to use for any 'body' text which is displayed over this Palette.Swatch's color.
float[] getHsl()
Return this swatch's HSL values.
int getPopulation()
int getRgb()
int getTitleTextColor()
Returns an appropriate color to use for any 'title' text which is displayed over this Palette.Swatch's color.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Palette.Swatch (int color, int population)

Public Methods

public boolean equals (Object o)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public int getBodyTextColor ()

Returns an appropriate color to use for any 'body' text which is displayed over this Palette.Swatch's color. This color is guaranteed to have sufficient contrast.

public float[] getHsl ()

Return this swatch's HSL values. hsv[0] is Hue [0 .. 360) hsv[1] is Saturation [0...1] hsv[2] is Lightness [0...1]

public int getPopulation ()

Returns
  • the number of pixels represented by this swatch

public int getRgb ()

Returns
  • this swatch's RGB color value

public int getTitleTextColor ()

Returns an appropriate color to use for any 'title' text which is displayed over this Palette.Swatch's color. This color is guaranteed to have sufficient contrast.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

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

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.