added in version 1.0.0
belongs to Maven artifact androidx.palette:palette:1.0.0-beta01

Target.Builder

public static final class Target.Builder
extends Object

java.lang.Object
   ↳ androidx.palette.graphics.Target.Builder


Builder class for generating custom Target instances.

Summary

Public constructors

Target.Builder()

Create a new Target builder from scratch.

Target.Builder(Target target)

Create a new builder based on an existing Target.

Public methods

Target build()

Builds and returns the resulting Target.

Target.Builder setExclusive(boolean exclusive)

Set whether any color selected for this target is exclusive to this target only.

Target.Builder setLightnessWeight(float weight)

Set the weight of importance that this target will place on lightness values.

Target.Builder setMaximumLightness(float value)

Set the maximum lightness value for this target.

Target.Builder setMaximumSaturation(float value)

Set the maximum saturation value for this target.

Target.Builder setMinimumLightness(float value)

Set the minimum lightness value for this target.

Target.Builder setMinimumSaturation(float value)

Set the minimum saturation value for this target.

Target.Builder setPopulationWeight(float weight)

Set the weight of importance that this target will place on a color's population within the image.

Target.Builder setSaturationWeight(float weight)

Set the weight of importance that this target will place on saturation values.

Target.Builder setTargetLightness(float value)

Set the target/ideal lightness value for this target.

Target.Builder setTargetSaturation(float value)

Set the target/ideal saturation value for this target.

Inherited methods

Public constructors

Target.Builder

added in version 1.0.0
public Target.Builder ()

Create a new Target builder from scratch.

Target.Builder

added in version 1.0.0
public Target.Builder (Target target)

Create a new builder based on an existing Target.

Parameters
target Target

Public methods

build

added in version 1.0.0
public Target build ()

Builds and returns the resulting Target.

Returns
Target

setExclusive

added in version 1.0.0
public Target.Builder setExclusive (boolean exclusive)

Set whether any color selected for this target is exclusive to this target only. Defaults to true.

Parameters
exclusive boolean: true if any the color is exclusive to this target, or false is the color can be selected for other targets.

Returns
Target.Builder

setLightnessWeight

added in version 1.0.0
public Target.Builder setLightnessWeight (float weight)

Set the weight of importance that this target will place on lightness values.

The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.

A weight of 0 means that it has no weight, and thus has no bearing on the selection.

Parameters
weight float

Value is 0.0 or greater.

Returns
Target.Builder

setMaximumLightness

added in version 1.0.0
public Target.Builder setMaximumLightness (float value)

Set the maximum lightness value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder

setMaximumSaturation

added in version 1.0.0
public Target.Builder setMaximumSaturation (float value)

Set the maximum saturation value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder

setMinimumLightness

added in version 1.0.0
public Target.Builder setMinimumLightness (float value)

Set the minimum lightness value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder

setMinimumSaturation

added in version 1.0.0
public Target.Builder setMinimumSaturation (float value)

Set the minimum saturation value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder

setPopulationWeight

added in version 1.0.0
public Target.Builder setPopulationWeight (float weight)

Set the weight of importance that this target will place on a color's population within the image.

The larger the weight, relative to the other weights, the more important that a color's population being close to the most populous has on selection.

A weight of 0 means that it has no weight, and thus has no bearing on the selection.

Parameters
weight float

Value is 0.0 or greater.

Returns
Target.Builder

setSaturationWeight

added in version 1.0.0
public Target.Builder setSaturationWeight (float weight)

Set the weight of importance that this target will place on saturation values.

The larger the weight, relative to the other weights, the more important that a color being close to the target value has on selection.

A weight of 0 means that it has no weight, and thus has no bearing on the selection.

Parameters
weight float

Value is 0.0 or greater.

Returns
Target.Builder

setTargetLightness

added in version 1.0.0
public Target.Builder setTargetLightness (float value)

Set the target/ideal lightness value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder

setTargetSaturation

added in version 1.0.0
public Target.Builder setTargetSaturation (float value)

Set the target/ideal saturation value for this target.

Parameters
value float

Value is between 0.0 and 1.0 inclusive.

Returns
Target.Builder