Package com.helger.css.decl

Class CSSHSLA

java.lang.Object

com.helger.css.decl.CSSHSLA

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<CSSHSLA>, ICSSColor, ICSSVersionAware, ICSSWriteable

@NotThreadSafe
public class CSSHSLA
extends Object
implements ICSSWriteable, ICSSVersionAware, ICSSColor, com.helger.commons.lang.ICloneable<CSSHSLA>

Represents a single HSLA color value (hue, saturation, lightness, opacity).

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
CSSHSLA(float fHue, float fSaturation, float fLightness, float fOpacity)	Constructor
CSSHSLA(int nHue, int nSaturation, int nLightness, float fOpacity)	Constructor
CSSHSLA(CSSHSLA aOther)	Copy constructor
CSSHSLA(CSSHSL aOther, float fOpacity)	Constructor
CSSHSLA(CSSHSL aOther, String sOpacity)	Constructor
CSSHSLA(String sHue, String sSaturation, String sLightness, String sOpacity)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getAsCSSString(ICSSWriterSettings aSettings, int nIndentLevel)	Get the contents of this object as a serialized CSS string for writing to an output.
CSSHSL	getAsHSL()
String	getAsString()
CSSHSLA	getClone()
String	getHue()
String	getLightness()
ECSSVersion	getMinimumCSSVersion()
String	getOpacity()
String	getSaturation()
int	hashCode()
CSSHSLA	setHue(String sHue)
CSSHSLA	setLightness(String sLightness)
CSSHSLA	setOpacity(String sOpacity)
CSSHSLA	setSaturation(String sSaturation)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.css.ICSSWriteable

getAsCSSString, getAsCSSString

Constructor Detail

CSSHSLA

public CSSHSLA(@Nonnull
               CSSHSLA aOther)

Copy constructor

Parameters:

aOther - The object to copy the data from. May not be null.

CSSHSLA

public CSSHSLA(@Nonnull
               CSSHSL aOther,
               float fOpacity)

Constructor

Parameters:

aOther - The HSL value to use as the basis. May not be null.

fOpacity - Opacity part. Is fitted to a value between 0 and 1.

Since:

3.8.3

CSSHSLA

public CSSHSLA(@Nonnull
               CSSHSL aOther,
               @Nonnull @Nonempty
               String sOpacity)

Constructor

Parameters:

aOther - The HSL value to use as the basis. May not be null.

sOpacity - Opacity part. May neither be null nor empty.

Since:

3.8.3

CSSHSLA

public CSSHSLA(int nHue,
               int nSaturation,
               int nLightness,
               float fOpacity)

Constructor

Parameters:

nHue - Hue value. Is scaled to the range 0-360

nSaturation - Saturation value. Is cut to the range 0-100 (percentage)

nLightness - Lightness value. Is cut to the range 0-100 (percentage)

fOpacity - Opacity - is scaled to 0-1

CSSHSLA

public CSSHSLA(float fHue,
               float fSaturation,
               float fLightness,
               float fOpacity)

Constructor

Parameters:

fHue - Hue value. Is scaled to the range 0-360

fSaturation - Saturation value. Is cut to the range 0-100 (percentage)

fLightness - Lightness value. Is cut to the range 0-100 (percentage)

fOpacity - Opacity - is scaled to 0-1

CSSHSLA

public CSSHSLA(@Nonnull @Nonempty
               String sHue,
               @Nonnull @Nonempty
               String sSaturation,
               @Nonnull @Nonempty
               String sLightness,
               @Nonnull @Nonempty
               String sOpacity)

Method Detail

getHue

@Nonnull
@Nonempty
public final String getHue()

Returns:

hue part

setHue

@Nonnull
public final CSSHSLA setHue(@Nonnull @Nonempty
                            String sHue)

getSaturation

@Nonnull
@Nonempty
public final String getSaturation()

Returns:

saturation part

setSaturation

@Nonnull
public final CSSHSLA setSaturation(@Nonnull @Nonempty
                                   String sSaturation)

getLightness

@Nonnull
@Nonempty
public final String getLightness()

Returns:

lightness part

setLightness

@Nonnull
public final CSSHSLA setLightness(@Nonnull @Nonempty
                                  String sLightness)

getOpacity

@Nonnull
@Nonempty
public final String getOpacity()

Returns:

opacity part

setOpacity

@Nonnull
public final CSSHSLA setOpacity(@Nonnull @Nonempty
                                String sOpacity)

getAsHSL

@Nonnull
public CSSHSL getAsHSL()

Returns:

This value as HSL value without the opacity. Never null.

Since:

3.8.3

getAsString

@Nonnull
@Nonempty
public String getAsString()

Specified by:

getAsString in interface ICSSColor

Returns:

The textual representation of the color.

Since:

3.8.3

getAsCSSString

@Nonnull
@Nonempty
public String getAsCSSString(@Nonnull
                             ICSSWriterSettings aSettings,
                             @Nonnegative
                             int nIndentLevel)

Description copied from interface: ICSSWriteable

Get the contents of this object as a serialized CSS string for writing to an output.

Specified by:

getAsCSSString in interface ICSSWriteable

Parameters:

aSettings - The settings to be used to format the output. May not be null.

nIndentLevel - The current indentation level

Returns:

The content of this object as CSS string. Never null.

getMinimumCSSVersion

@Nonnull
public ECSSVersion getMinimumCSSVersion()

Specified by:

getMinimumCSSVersion in interface ICSSVersionAware

Returns:

The minimum CSS version that is required to read or write this artifact. May not be null.

getClone

@Nonnull
public CSSHSLA getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<CSSHSLA>

Since:

3.8.3

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object