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

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

Class Brightness

java.lang.Object

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

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

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

public class Brightness
extends AbstractColorFactor<Brightness>

This ColorSegment represents the brightness of a Color. The brightness is a factor indicating the amount of light emitted by a Color.

Since:

1.0.0

See Also:

• GenericColor.getBrightness()

Field Summary

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

BYTE_MAX, MAX_VALUE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Brightness	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

Brightness

public Brightness(double value)

The constructor.

Parameters:

value - is the value.

Brightness

public Brightness(String value)

The constructor.

Parameters:

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

Method Details

newInstance

protected Brightness newInstance(double value)

Description copied from class: ColorSegment

Creates a new instance with the given value.

Specified by:

newInstance in class ColorSegment<Brightness>

Parameters:

value - is the value.

Returns:

the new instance.

toString

public String toString()

Description copied from class: ColorSegment

Overrides:

toString in class AbstractColorFactor<Brightness>

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).