com.esri.arcgis.display
Interface IColorRamp

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IAlgorithmicColorRamp, IMultiPartColorRamp, IPresetColorRamp, IRandomColorRamp

All Known Implementing Classes:

AlgorithmicColorRamp, IAlgorithmicColorRampProxy, IColorRampProxy, IMultiPartColorRampProxy, IPresetColorRampProxy, IRandomColorRampProxy, MultiPartColorRamp, PresetColorRamp, RandomColorRamp

public interface IColorRamp
extends java.io.Serializable

COM Interface 'IColorRamp'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to the methods and properties common to all color ramp objects.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDbeb87091_c0b4_11d0_8379_080009b996cc
static int	xxDummy Deprecated. Internal use only

Method Summary

void	createRamp(boolean[] ok) Generates a color ramp with length determined by Size value.
IColor	getColor(int index) The color at the given index position.
IEnumColors	getColors() The list of colors.
java.lang.String	getName() The name of the color ramp.
int	getSize() The number of colors that will be generated by the CreateRamp method.
void	setName(java.lang.String pName) The name of the color ramp.
void	setSize(int count) The number of colors that will be generated by the CreateRamp method.

Field Detail

IIDbeb87091_c0b4_11d0_8379_080009b996cc

static final int IIDbeb87091_c0b4_11d0_8379_080009b996cc

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setName

void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException

The name of the color ramp.

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the color ramp.

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSize

void setSize(int count)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSize

int getSize()
            throws java.io.IOException,
                   AutomationException

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

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColors

IEnumColors getColors()
                      throws java.io.IOException,
                             AutomationException

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

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

IColor getColor(int index)
                throws java.io.IOException,
                       AutomationException

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

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

void createRamp(boolean[] ok)
                throws java.io.IOException,
                       AutomationException

Generates a color ramp with length determined by Size value.

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.