belongs to Maven artifact com.android.support:palette-v7:28.0.0-alpha1
Target.Builder
public
static
final
class
Target.Builder
extends Object
| java.lang.Object | |
| ↳ | android.support.v7.graphics.Target.Builder |
Builder class for generating custom Target instances.
Summary
Public constructors | |
|---|---|
Target.Builder()
Create a new |
|
Target.Builder(Target target)
Create a new builder based on an existing |
|
Public methods | |
|---|---|
Target
|
build()
Builds and returns the resulting |
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 | |
|---|---|
From
class
java.lang.Object
| |
Public constructors
Target.Builder
Target.Builder (Target target)
Create a new builder based on an existing Target.
| Parameters | |
|---|---|
target |
Target |
Public methods
build
Target build ()
Builds and returns the resulting Target.
| Returns | |
|---|---|
Target |
|
setExclusive
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
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 |
|
See also:
setMaximumLightness
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
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
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
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
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
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 |
|
See also:
setTargetLightness
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
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 |
|
Interfaces
Classes