com.groupdocs.editor.htmlcss.css.datatypes

Class ArgbColor

java.lang.Object

com.aspose.ms.System.ValueType<T>

com.aspose.ms.lang.Struct<ArgbColor>

com.groupdocs.editor.htmlcss.css.datatypes.ArgbColor

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ICssDataType>, ICssDataType

public class ArgbColor
extends com.aspose.ms.lang.Struct<ArgbColor>
implements ICssDataType

Represents one color value in ARGB format with converters and serializers

This type is designed to be useful for (but not limited to) CSS operations. See more: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArgbColor.Keywords

Constructor Summary

Constructors

Constructor and Description
ArgbColor()
ArgbColor(int r, int g, int b)

Method Summary

Modifier and Type	Method and Description
boolean	equals(ArgbColor other) Checks two ArgbColor colors for equality
boolean	equals(ICssDataType other) Checks two ArgbColor colors for equality
boolean	equals(Object other) Tests if another object is equal to this ArgbColor instance.
static ArgbColor	fromColor(Color color) Creates one ArgbColor value from specified Color
static ArgbColor	fromRgb(int red, int green, int blue) Creates one ArgbColor value from specified Red, Green, Blue channels, while Alpha channel is fully opaque
static ArgbColor	fromRgba(int red, int green, int blue, int alpha) Creates one ArgbColor value from specified Red, Green, Blue, and Alpha channels
static ArgbColor	fromSingleValueRgb(byte value) Creates a fully opaque (A=255) color from single value, which will be applied to all channels
int	getA() Gets the alpha part of the color.
double	getAlpha() Gets the alpha part of the color in percent (0..1).
int	getB() Gets the blue part of the color.
int	getG() Gets the green part of the color.
int	getR() Gets the red part of the color.
int	getValue() Gets the Int32 value of the color.
int	hashCode() Returns a hash code that defines the current color.
boolean	isDefault() Indicates whether this ArgbColor instance is default (Transparent) - all 4 channels are set to 0
boolean	isEmpty() Uninitialized color - all 4 channels are set to 0.
boolean	isFullyOpaque() Indicates whether this ArgbColor instance is fully opaque, without transparency (its Alpha channel has max value)
boolean	isFullyTransparent() Indicates whether this ArgbColor instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect.
boolean	isTranslucent() Indicates whether this ArgbColor instance is translucent (not fully transparent, but also not fully opaque)
static boolean	op_Equality(ArgbColor left, ArgbColor right) Compares two colors and returns a boolean indicating if the two do match.
static boolean	op_Inequality(ArgbColor left, ArgbColor right) Compares two colors and returns a boolean indicating if the two do not match.
String	serializeDefault() Serializes this ArgbColor instance to the most appropriate CSS function notation depending on translucency
String	toRGB() Serializes this ArgbColor instance to the 'rgb' CSS function notation
String	toRGBA() Serializes this ArgbColor instance to the 'rgba' CSS function notation
String	toString() Same as serializeDefault()
Color	toSystemColor() Converts a value of this ArgbColor instance to the Color instance and returns it

Methods inherited from class com.aspose.ms.System.ValueType

Clone, CloneTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgbColor

public ArgbColor()

ArgbColor

public ArgbColor(int r,
                 int g,
                 int b)

Method Detail

equals

public final boolean equals(ArgbColor other)

Checks two ArgbColor colors for equality

Parameters:

other - The other ArgbColor color

Returns:

True if both colors or equal, otherwise false.

equals

public final boolean equals(ICssDataType other)

Checks two ArgbColor colors for equality

Parameters:

other - The other ArgbColor color, casted to the ICssDataType

Returns:

True if both colors or equal, otherwise false.

equals

public boolean equals(Object other)

Tests if another object is equal to this ArgbColor instance.

Specified by:

equals in interface com.aspose.ms.System.IEquatable<ICssDataType>

Overrides:

equals in class Object

Parameters:

other - The object to test with.

Returns:

True if the two objects are equal, otherwise false.

fromColor

public static ArgbColor fromColor(Color color)

Creates one ArgbColor value from specified Color

Parameters:

color -

Returns:

fromRgb

public static ArgbColor fromRgb(int red,
                                int green,
                                int blue)

Creates one ArgbColor value from specified Red, Green, Blue channels, while Alpha channel is fully opaque

Parameters:

red - Red channel value

green - Green channel value

blue - Blue channel value

Returns:

New ArgbColor value

fromRgba

public static ArgbColor fromRgba(int red,
                                 int green,
                                 int blue,
                                 int alpha)

Creates one ArgbColor value from specified Red, Green, Blue, and Alpha channels

Parameters:

red - Red channel value

green - Green channel value

blue - Blue channel value

alpha - Alpha channel value

Returns:

New ArgbColor value

fromSingleValueRgb

public static ArgbColor fromSingleValueRgb(byte value)

Creates a fully opaque (A=255) color from single value, which will be applied to all channels

Parameters:

value - A byte value, same for Red, Green, and Blue channels

Returns:

New ArgbColor instance

getA

public final int getA()

Gets the alpha part of the color.

getAlpha

public final double getAlpha()

Gets the alpha part of the color in percent (0..1).

getB

public final int getB()

Gets the blue part of the color.

getG

public final int getG()

Gets the green part of the color.

getR

public final int getR()

Gets the red part of the color.

getValue

public final int getValue()

Gets the Int32 value of the color.

hashCode

public int hashCode()

Returns a hash code that defines the current color.

Overrides:

hashCode in class Object

Returns:

The integer value of the hashcode.

isDefault

public final boolean isDefault()

Indicates whether this ArgbColor instance is default (Transparent) - all 4 channels are set to 0

Specified by:

isDefault in interface ICssDataType

Returns:

isEmpty

public final boolean isEmpty()

Uninitialized color - all 4 channels are set to 0. Same as Default and Transparent.

isFullyOpaque

public final boolean isFullyOpaque()

Indicates whether this ArgbColor instance is fully opaque, without transparency (its Alpha channel has max value)

isFullyTransparent

public final boolean isFullyTransparent()

Indicates whether this ArgbColor instance is fully transparent - its Alpha channel has the min (0) value, so other R, G, and B channels has no visible effect.

isTranslucent

public final boolean isTranslucent()

Indicates whether this ArgbColor instance is translucent (not fully transparent, but also not fully opaque)

op_Equality

public static boolean op_Equality(ArgbColor left,
                                  ArgbColor right)

Compares two colors and returns a boolean indicating if the two do match.

Parameters:

left - The first color to use.

right - The second color to use.

Returns:

True if both colors are equal, otherwise false.

op_Inequality

public static boolean op_Inequality(ArgbColor left,
                                    ArgbColor right)

Compares two colors and returns a boolean indicating if the two do not match.

Parameters:

left - The first color to use.

right - The second color to use.

Returns:

True if both colors are not equal, otherwise false.

serializeDefault

public final String serializeDefault()

Serializes this ArgbColor instance to the most appropriate CSS function notation depending on translucency

Specified by:

serializeDefault in interface ICssDataType

Returns:

A string with 'rgba(r, g, b, a)' or 'rgb(r, g, b)' format

toRGB

public final String toRGB()

Serializes this ArgbColor instance to the 'rgb' CSS function notation

Returns:

A string with 'rgb(r, g, b)' format

toRGBA

public final String toRGBA()

Serializes this ArgbColor instance to the 'rgba' CSS function notation

Returns:

A string with 'rgba(r, g, b, a)' format

toString

public String toString()

Same as serializeDefault()

Overrides:

toString in class Object

Returns:

Same return value as in serializeDefault()

toSystemColor

public final Color toSystemColor()

Converts a value of this ArgbColor instance to the Color instance and returns it

Returns:

New Color instance