ScRgbColor Class

A color in the scRGB color space.

Declaration

public final class ScRgbColor extends Struct<ScRgbColor> implements Cloneable, IEquatable<ScRgbColor>

Implements

java.lang.Cloneable

com.devexpress.system.IEquatable<com.devexpress.docs.ScRgbColor>

Inherited Members

com.devexpress.system.Struct.equals(java.lang.Object)

com.devexpress.system.Struct.getHashCode()

com.devexpress.system.Struct.hashCode()

java.lang.Object.clone()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.toString()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.Struct

ScRgbColor

Constructors

ScRgbColor() Constructor

Initializes a new instance of the ScRgbColor class.

Declaration

public ScRgbColor()

ScRgbColor(double scR, double scG, double scB) Constructor

Initializes a new instance of the ScRgbColor class with specified settings.

Declaration

public ScRgbColor(double scR, double scG, double scB)

Parameters

Name	Type	Description
scR	double	The ScRGB red color value.
scG	double	The ScRGB green color value.
scB	double	The ScRGB blue color value.

ScRgbColor(ScRgbColor other) Constructor

Initializes a new instance of the ScRgbColor class with specified settings.

Declaration

public ScRgbColor(ScRgbColor other)

Parameters

Name	Type	Description
other	ScRgbColor	The ScRgbColor object to copy from.

Methods

clone() Method

Creates a copy of the current ScRgbColor object.

Declaration

public ScRgbColor clone()

Returns

Type	Description
ScRgbColor	A new ScRgbColor object that is a copy of the current object.

equals(Object obj) Method

Determines whether the specified object is equal to the current object.

Declaration

public boolean equals(Object obj)

Parameters

Name	Type	Description
obj	Object	The object to compare with the current object.

Returns

Type	Description
boolean	true if the specified object is equal to the current object; otherwise, false.

equals(ScRgbColor other) Method

Determines whether the specified object is equal to the current object.

Declaration

public boolean equals(ScRgbColor other)

Parameters

Name	Type	Description
other	ScRgbColor	The object to compare with the current object.

Returns

Type	Description
boolean	true if the specified object is equal to the current object; otherwise, false.

getDefaultValue() Method

Gets the default value of the ScRgbColor structure.

Declaration

public static ScRgbColor getDefaultValue()

Returns

Type	Description
ScRgbColor	The default value.

getScB() Method

Returns the ScRGB blue color value.

Declaration

public double getScB()

Returns

Type	Description
double	The ScRGB blue color value.

getScG() Method

Returns the ScRGB green color value.

Declaration

public double getScG()

Returns

Type	Description
double	The ScRGB green color value.

getScR() Method

Returns the ScRGB red color value.

Declaration

public double getScR()

Returns

Type	Description
double	The ScRGB red color value.

hashCode() Method

Returns the hash code for the current ScRgbColor object.

Declaration

public int hashCode()

Returns

Type	Description
int	A hash code value for the current object.

setScB(double value) Method

Specifies the ScRGB blue color value.

Declaration

public void setScB(double value)

Parameters

Name	Type	Description
value	double	The ScRGB blue color value.

setScG(double value) Method

Specifies the ScRGB green color value.

Declaration

public void setScG(double value)

Parameters

Name	Type	Description
value	double	The ScRGB green color value.

setScR(double value) Method

Specifies the ScRGB red color value.

Declaration

public void setScR(double value)

Parameters

Name	Type	Description
value	double	The ScRGB red color value.

toRgb() Method

Converts ScRGB color values to RGB color values.

Declaration

public Color toRgb()

Returns

Type	Description
Color	The RGB color value.

toRgb(int scR, int scG, int scB) Method

Converts the specified ScRGB color values to RGB color values.

Declaration

public static Color toRgb(int scR, int scG, int scB)

Parameters

Name	Type	Description
scR	int	The ScRGB red color value.
scG	int	The ScRGB green color value.
scB	int	The ScRGB blue color value.

Returns

Type	Description
Color	The RGB color value.