com.esri.arcgis.display
Class RandomColorRamp

java.lang.Object
  extended by com.esri.arcgis.display.RandomColorRamp
All Implemented Interfaces:
IColorRamp, IRandomColorRamp, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

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

COM Class 'RandomColorRamp'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Defines a random color ramp, where ramp is a list of randomly picked 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.display.IRandomColorRamp
IID, IIDbeb87095_c0b4_11d0_8379_080009b996cc, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IColorRamp
IIDbeb87091_c0b4_11d0_8379_080009b996cc
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Constructor Summary
RandomColorRamp()
          Constructs a RandomColorRamp using ArcGIS Engine.
RandomColorRamp(java.lang.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(java.lang.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 java.lang.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).
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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).
 java.lang.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(java.io.ObjectInput in)
           
 void release()
          Release a RandomColorRamp.
 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(java.lang.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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

RandomColorRamp

public RandomColorRamp()
                throws java.io.IOException,
                       java.net.UnknownHostException
Constructs a RandomColorRamp using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RandomColorRamp

public RandomColorRamp(java.lang.Object obj)
                throws java.io.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:
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()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a RandomColorRamp.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setSeed

public void setSeed(int seed)
             throws java.io.IOException,
                    AutomationException
The seed of the random number generator.

Specified by:
setSeed in interface IRandomColorRamp
Parameters:
seed - The seed (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeed

public int getSeed()
            throws java.io.IOException,
                   AutomationException
The seed of the random number generator.

Specified by:
getSeed in interface IRandomColorRamp
Returns:
The seed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseSeed

public void setUseSeed(boolean useSeed)
                throws java.io.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.

Specified by:
setUseSeed in interface IRandomColorRamp
Parameters:
useSeed - The useSeed (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseSeed

public boolean isUseSeed()
                  throws java.io.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.

Specified by:
isUseSeed in interface IRandomColorRamp
Returns:
The useSeed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinValue

public void setMinValue(int minValue)
                 throws java.io.IOException,
                        AutomationException
The minimum value (0-100).

Specified by:
setMinValue in interface IRandomColorRamp
Parameters:
minValue - The minValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinValue

public int getMinValue()
                throws java.io.IOException,
                       AutomationException
The minimum value (0-100).

Specified by:
getMinValue in interface IRandomColorRamp
Returns:
The minValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxValue

public void setMaxValue(int maxValue)
                 throws java.io.IOException,
                        AutomationException
The maximum value (0-100).

Specified by:
setMaxValue in interface IRandomColorRamp
Parameters:
maxValue - The maxValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxValue

public int getMaxValue()
                throws java.io.IOException,
                       AutomationException
The maximum value (0-100).

Specified by:
getMaxValue in interface IRandomColorRamp
Returns:
The maxValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinSaturation

public void setMinSaturation(int minSaturation)
                      throws java.io.IOException,
                             AutomationException
The minimum saturation (0-100).

Specified by:
setMinSaturation in interface IRandomColorRamp
Parameters:
minSaturation - The minSaturation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinSaturation

public int getMinSaturation()
                     throws java.io.IOException,
                            AutomationException
The minimum saturation (0-100).

Specified by:
getMinSaturation in interface IRandomColorRamp
Returns:
The minSaturation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxSaturation

public void setMaxSaturation(int maxSaturation)
                      throws java.io.IOException,
                             AutomationException
The maximum saturation (0-100).

Specified by:
setMaxSaturation in interface IRandomColorRamp
Parameters:
maxSaturation - The maxSaturation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSaturation

public int getMaxSaturation()
                     throws java.io.IOException,
                            AutomationException
The maximum saturation (0-100).

Specified by:
getMaxSaturation in interface IRandomColorRamp
Returns:
The maxSaturation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartHue

public void setStartHue(int startHue)
                 throws java.io.IOException,
                        AutomationException
The start hue (0-360).

Specified by:
setStartHue in interface IRandomColorRamp
Parameters:
startHue - The startHue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStartHue

public int getStartHue()
                throws java.io.IOException,
                       AutomationException
The start hue (0-360).

Specified by:
getStartHue in interface IRandomColorRamp
Returns:
The startHue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndHue

public void setEndHue(int endHue)
               throws java.io.IOException,
                      AutomationException
The end hue (0-360).

Specified by:
setEndHue in interface IRandomColorRamp
Parameters:
endHue - The endHue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndHue

public int getEndHue()
              throws java.io.IOException,
                     AutomationException
The end hue (0-360).

Specified by:
getEndHue in interface IRandomColorRamp
Returns:
The endHue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException
The name of the color ramp.

Specified by:
setName in interface IColorRamp
Parameters:
pName - The pName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the color ramp.

Specified by:
getName in interface IColorRamp
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int count)
             throws java.io.IOException,
                    AutomationException
The number of colors that will be generated by the CreateRamp method.

Specified by:
setSize in interface IColorRamp
Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public int getSize()
            throws java.io.IOException,
                   AutomationException
The number of colors that will be generated by the CreateRamp method.

Specified by:
getSize in interface IColorRamp
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColors

public IEnumColors getColors()
                      throws java.io.IOException,
                             AutomationException
The list of colors. Call CreateRamp before calling this method.

Specified by:
getColors in interface IColorRamp
Returns:
A reference to a com.esri.arcgis.display.IEnumColors
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor(int index)
                throws java.io.IOException,
                       AutomationException
The color at the given index position. Call CreateRamp before calling this method.

Specified by:
getColor in interface IColorRamp
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRamp

public void createRamp(boolean[] ok)
                throws java.io.IOException,
                       AutomationException
Generates a color ramp with length determined by Size value.

Specified by:
createRamp in interface IColorRamp
Parameters:
ok - The ok (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException