Module io.github.mmm.ui.api.core

Package io.github.mmm.ui.api.datatype.color

Class Saturation

java.lang.Object

io.github.mmm.ui.api.datatype.color.ColorSegment<SELF>

io.github.mmm.ui.api.datatype.color.AbstractColorFactor<Saturation>

io.github.mmm.ui.api.datatype.color.Saturation

public class Saturation
extends AbstractColorFactor<Saturation>

This ColorSegment is a factor that represents the colorfulness of a stimulus relative to its own brightness.
ATTENTION:
The saturation has different definitions for ColorModel.HSB and ColorModel.HSL. Hence transformation from other ColorModels like ColorModel.RGB differs and will return different results for Saturation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from class io.github.mmm.ui.api.datatype.color.AbstractColorFactor

BYTE_MAX, MAX_VALUE

Constructor Summary

Constructors

Constructor	Description
Saturation(double value)	The constructor.
Saturation(String value)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected Saturation	newInstance(double value)	Creates a new instance with the given value.
String	toString()

Methods inherited from class io.github.mmm.ui.api.datatype.color.AbstractColorFactor

getMax, getValueAsByte, getValueAsFactor, toByteString

Methods inherited from class io.github.mmm.ui.api.datatype.color.ColorSegment

decrease, equals, getMin, getValue, getValueAsPercent, hashCode, increase, invert, toFactorString, toPercentString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Saturation

public Saturation(double value)

The constructor.

Parameters:

value - is the value.

Saturation

public Saturation(String value)

The constructor.

Parameters:

value - is the value given as factor or percent String.

Method Details

newInstance

protected Saturation newInstance(double value)

Description copied from class: ColorSegment

Creates a new instance with the given value.

Specified by:

newInstance in class ColorSegment<Saturation>

Parameters:

value - is the value.

Returns:

the new instance.

toString

public String toString()

Description copied from class: ColorSegment

Overrides:

toString in class AbstractColorFactor<Saturation>

Returns:

the default String representation. Depending on the type this might be the same as ColorSegment.toFactorString() but it might also be an absolute integer (e.g. in the range [0, 255] for RGBA segments).