com.esri.arcgis.carto

Class RgbColorDescription

java.lang.Object

com.esri.arcgis.carto.RgbColorDescription

All Implemented Interfaces:

IColorDescription, IRGBColorDescription, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RgbColorDescription
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IColorDescription, IRGBColorDescription

COM Class 'RgbColorDescription'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriCarto.tlb'

Description 'A color description to describe RGB, red, green, blue colors.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.carto.IColorDescription

IID, IID54624289_e314_4d7f_85a3_53ddfc57cf55, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IRGBColorDescription

IID, IID8e8ca536_36ea_4b06_8fa3_636074c5b162, xxDummy

Constructor Summary

Constructors

Constructor and Description
RgbColorDescription() Constructs a RgbColorDescription using ArcGIS Engine.
RgbColorDescription(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RgbColorDescription theRgbColorDescription = (RgbColorDescription) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
byte	getAlpha() The Alpha Blending value.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getRGB() The RGB value of color.
int	hashCode() the hashcode for this object
void	queryRGB(int[] r, int[] g, int[] b) Gets the red, green, blue components of a color respectively.
void	release() Release this COM object reference
void	setAlpha(byte alphaValue) The Alpha Blending value.
void	setRGB(int rGB) The RGB value of color.
void	setRGB(int r, int g, int b) Sets red, green, blue components of a color respectively.

Methods inherited from class java.lang.Object

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

Constructor Detail

RgbColorDescription

public RgbColorDescription()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a RgbColorDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RgbColorDescription

public RgbColorDescription(java.lang.Object obj)
                    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RgbColorDescription theRgbColorDescription = (RgbColorDescription) obj;

Construct a RgbColorDescription using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RgbColorDescription.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setRGB

public void setRGB(int rGB)
            throws java.io.IOException,
                   AutomationException

The RGB value of color.

Specified by:

setRGB in interface IColorDescription

Parameters:

rGB - The rGB (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRGB

public int getRGB()
           throws java.io.IOException,
                  AutomationException

The RGB value of color.

Specified by:

getRGB in interface IColorDescription

Returns:

The rGB (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlpha

public void setAlpha(byte alphaValue)
              throws java.io.IOException,
                     AutomationException

The Alpha Blending value. (0 for transparent, 255 for opaque).

Specified by:

setAlpha in interface IColorDescription

Specified by:

setAlpha in interface IRGBColorDescription

Parameters:

alphaValue - An unsigned byte (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlpha

public byte getAlpha()
              throws java.io.IOException,
                     AutomationException

The Alpha Blending value. (0 for transparent, 255 for opaque).

Specified by:

getAlpha in interface IColorDescription

Specified by:

getAlpha in interface IRGBColorDescription

Returns:

An unsigned byte

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRGB

public void setRGB(int r,
                   int g,
                   int b)
            throws java.io.IOException,
                   AutomationException

Sets red, green, blue components of a color respectively. 0-255 is the valid range of values.

Specified by:

setRGB in interface IRGBColorDescription

Parameters:

r - The r (in)

g - The g (in)

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryRGB

public void queryRGB(int[] r,
                     int[] g,
                     int[] b)
              throws java.io.IOException,
                     AutomationException

Gets the red, green, blue components of a color respectively.

Specified by:

queryRGB in interface IRGBColorDescription

Parameters:

r - The r (out: use single element array)

g - The g (out: use single element array)

b - The b (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.