com.esri.arcgis.display
Class RandomColorRamp

java.lang.Object
  com.esri.arcgis.display.RandomColorRamp

All Implemented Interfaces:

IColorRamp, IRandomColorRamp, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class RandomColorRamp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRandomColorRamp, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable

Defines a random color ramp, where ramp is a list of randomly picked colors.

Description

Use RandomColorRamp to create a set of colors that is randomly determined based on potential restrictions to the Hue, Saturation, and Value ranges.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RandomColorRamp()
Constructs a RandomColorRamp using ArcGIS Engine.

RandomColorRamp(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RandomColorRamp theRandomColorRamp = (RandomColorRamp) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	createRamp(boolean[] ok) Generates a color ramp with length determined by Size value.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IColor	getColor(int index) The color at the given index position.
IEnumColors	getColors() The list of colors.
int	getEndHue() The end hue (0-360).
int	getMaxSaturation() The maximum saturation (0-100).
int	getMaxValue() The maximum value (0-100).
int	getMinSaturation() The minimum saturation (0-100).
int	getMinValue() The minimum value (0-100).
String	getName() The name of the color ramp.
int	getSeed() The seed of the random number generator.
int	getSize() The number of colors that will be generated by the CreateRamp method.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStartHue() The start hue (0-360).
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isUseSeed() Indicates if a seed is used when the ramp is generated.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEndHue(int endHue) The end hue (0-360).
void	setMaxSaturation(int maxSaturation) The maximum saturation (0-100).
void	setMaxValue(int maxValue) The maximum value (0-100).
void	setMinSaturation(int minSaturation) The minimum saturation (0-100).
void	setMinValue(int minValue) The minimum value (0-100).
void	setName(String pName) The name of the color ramp.
void	setSeed(int seed) The seed of the random number generator.
void	setSize(int count) The number of colors that will be generated by the CreateRamp method.
void	setStartHue(int startHue) The start hue (0-360).
void	setUseSeed(boolean useSeed) Indicates if a seed is used when the ramp is generated.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RandomColorRamp

public RandomColorRamp()
                throws IOException,
                       UnknownHostException

Constructs a RandomColorRamp using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RandomColorRamp

public RandomColorRamp(Object obj)
                throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setSeed

public void setSeed(int seed)
             throws IOException,
                    AutomationException

The seed of the random number generator.

Description

Seed is any number that is different than the one you might have just used with a specific IRandomColorRamp .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSeed in interface IRandomColorRamp

Parameters:

seed - The seed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeed

public int getSeed()
            throws IOException,
                   AutomationException

The seed of the random number generator.

Description

Seed is any number that is different than the one you might have just used with a specific IRandomColorRamp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSeed in interface IRandomColorRamp

Returns:

The seed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSeed

public void setUseSeed(boolean useSeed)
                throws IOException,
                       AutomationException

Indicates if a seed is used when the ramp is generated. Set this property to True without changing the Seed to generate identical color ramps in succession.

Description

UseSeed is whether or not the IRandomColorRamp will use a random seed. If not, then the same sequence of random colors will be generated each time a specific color ramp is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUseSeed in interface IRandomColorRamp

Parameters:

useSeed - The useSeed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSeed

public boolean isUseSeed()
                  throws IOException,
                         AutomationException

Indicates if a seed is used when the ramp is generated. Set this property to True without changing the Seed to generate identical color ramps in succession.

Description

UseSeed is whether or not the IRandomColorRamp will use a random seed. If not, then the same sequence of random colors will be generated each time a specific color ramp is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUseSeed in interface IRandomColorRamp

Returns:

The useSeed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinValue

public void setMinValue(int minValue)
                 throws IOException,
                        AutomationException

The minimum value (0-100).

Description

MinValue is minimum value any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinValue in interface IRandomColorRamp

Parameters:

minValue - The minValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinValue

public int getMinValue()
                throws IOException,
                       AutomationException

The minimum value (0-100).

Description

MinValue is minimum value any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinValue in interface IRandomColorRamp

Returns:

The minValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxValue

public void setMaxValue(int maxValue)
                 throws IOException,
                        AutomationException

The maximum value (0-100).

Description

MaxValue is maximum value any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxValue in interface IRandomColorRamp

Parameters:

maxValue - The maxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxValue

public int getMaxValue()
                throws IOException,
                       AutomationException

The maximum value (0-100).

Description

MaxValue is maximum value any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxValue in interface IRandomColorRamp

Returns:

The maxValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinSaturation

public void setMinSaturation(int minSaturation)
                      throws IOException,
                             AutomationException

The minimum saturation (0-100).

Description

MinSaturation is minimum saturation any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinSaturation in interface IRandomColorRamp

Parameters:

minSaturation - The minSaturation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinSaturation

public int getMinSaturation()
                     throws IOException,
                            AutomationException

The minimum saturation (0-100).

Description

MinSaturation is minimum saturation any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinSaturation in interface IRandomColorRamp

Returns:

The minSaturation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSaturation

public void setMaxSaturation(int maxSaturation)
                      throws IOException,
                             AutomationException

The maximum saturation (0-100).

Description

MaxSaturation is maximum saturation any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxSaturation in interface IRandomColorRamp

Parameters:

maxSaturation - The maxSaturation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSaturation

public int getMaxSaturation()
                     throws IOException,
                            AutomationException

The maximum saturation (0-100).

Description

MaxSaturation is maximum saturation any random color can be (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxSaturation in interface IRandomColorRamp

Returns:

The maxSaturation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartHue

public void setStartHue(int startHue)
                 throws IOException,
                        AutomationException

The start hue (0-360).

Description

StartHue is minimum hue any random color can be (0-360).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStartHue in interface IRandomColorRamp

Parameters:

startHue - The startHue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

getStartHue

public int getStartHue()
                throws IOException,
                       AutomationException

The start hue (0-360).

Description

StartHue is minimum hue any random color can be (0-360).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStartHue in interface IRandomColorRamp

Returns:

The startHue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

setEndHue

public void setEndHue(int endHue)
               throws IOException,
                      AutomationException

The end hue (0-360).

Description

EndHue is maximum hue any random color can be (0-360).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEndHue in interface IRandomColorRamp

Parameters:

endHue - The endHue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

getEndHue

public int getEndHue()
              throws IOException,
                     AutomationException

The end hue (0-360).

Description

EndHue is maximum hue any random color can be (0-360).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEndHue in interface IRandomColorRamp

Returns:

The endHue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

The name of the color ramp.

Description

Name is the name of an instance of a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IColorRamp

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the color ramp.

Description

Name is the name of an instance of a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IColorRamp

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int count)
             throws IOException,
                    AutomationException

The number of colors that will be generated by the CreateRamp method.

Description

Size is the number of colors that will be generated when the CreateRamp method is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSize in interface IColorRamp

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

public int getSize()
            throws IOException,
                   AutomationException

The number of colors that will be generated by the CreateRamp method.

Description

Size is the number of colors that will be generated when the CreateRamp method is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSize in interface IColorRamp

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColors

public IEnumColors getColors()
                      throws IOException,
                             AutomationException

The list of colors. Call CreateRamp before calling this method.

Description

Colors is how you can populate an IEnumColors object in order to easily retrieve the colors in a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColors in interface IColorRamp

Returns:

A reference to a com.esri.arcgis.display.IEnumColors

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor(int index)
                throws IOException,
                       AutomationException

The color at the given index position. Call CreateRamp before calling this method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getColor in interface IColorRamp

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRamp

public void createRamp(boolean[] ok)
                throws IOException,
                       AutomationException

Generates a color ramp with length determined by Size value.

Description

CreateRamp generates the number of colors in a color ramp as specified in the Size property. The boolean pOK is a mask, i.e., you supply the boolean object and the method will set its value. Generally speaking pOK will only return false if a property is missing.

Remarks

Use the CreateRamp after you have set the other properties like Size and the colors specific paramters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

createRamp in interface IColorRamp

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IPresetColorRamp, IMultiPartColorRamp, IAlgorithmicColorRamp, IColorRamp.getColor(int), IRandomColorRamp, IColorRamp.createRamp(boolean[]), IColorRamp

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException