com.esri.arcgis.carto
Class RasterRGBRenderer

java.lang.Object
  com.esri.arcgis.carto.RasterRGBRenderer

All Implemented Interfaces:

IColorChannelMapping, IDisplayTableExchange, IGlobeRasterStretch, IIdentify, ILegendInfo, IRasterDisplayProps, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterRendererUpdate, IRasterRGBRenderer, IRasterRGBRenderer2, IRasterStretch, IRasterStretch2, IRasterStretch3, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class RasterRGBRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterRGBRenderer, IRasterRGBRenderer2, IGlobeRasterStretch, IRasterStretch, IRasterStretch2, IRasterStretch3, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterDisplayProps, IIdentify, ILegendInfo, IDisplayAdmin, IColorChannelMapping, IDisplayTableExchange, IRasterRendererUpdate, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable

COM Class 'RasterRGBRenderer'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A true-color RGB renderer.' 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.carto.IRasterRGBRenderer2

IID, IID9e69b838_e78f_44c1_867f_b5932d5eeb49, xxDummy

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

IID577f186f_7037_11d2_9f29_00c04f8ed1d7

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

IID, IIDb055b13e_ceb8_406f_a179_1e838f51e30b, xxDummy

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

IID, IID48bb9988_8250_11d3_aba2_0008c73fca1c, xxDummy

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

IID, IID51ee1518_7261_4fdd_99c7_b4e35cfc7da0, xxDummy

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

IID, IID30f1c42e_4a45_4564_8f08_76a2cd42f661, xxDummy

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

IID, IID6f5322d1_3790_11d2_8d26_0000f8780535, xxDummy

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

IID, IID36695416_2a62_4f24_a97c_5b60f40cf311, xxDummy

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

IID, IID2546feb5_7334_41c7_9160_0b15ba62c809, xxDummy

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

IID, IIDa6a46058_92f3_11d3_aba5_0008c73fca1c, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy

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

IID, IID8d12e222_2507_41b5_a21c_5a56a031705b, xxDummy

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

IID, IID56448e92_9ef7_11d4_b286_00508bcdc7c8, xxDummy

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

IID, IID76877c54_c010_4550_a202_bc882196af40, 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

RasterRGBRenderer()
Constructs a RasterRGBRenderer using ArcGIS Engine.

RasterRGBRenderer(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterRGBRenderer theRasterRGBRenderer = (RasterRGBRenderer) obj;

Method Summary

void	adaptRaster(IRaster pRaster) Adapts to the new raster.
boolean	canRender(IRaster raster) Indicates if the raster can be rendered.
void	copy(IRasterRenderer pSource) Selects a raster as the current copy object.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(IRaster raster, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Draws the raster on the display.
boolean	equals(java.lang.Object o) Compare this object with another
int	getAlphaBandIndex() The band to be represented in Alpha.
IColor	getBackgroundColor() Background display color.
java.lang.Object	getBackgroundValue() The list of background value(s).
double	getBackgroundValues() Indicates whether an array of background values is being used.
java.lang.Object	getBandIndices() The band indices being used in the mapping.
int	getBlueBandIndex() Band to be represented in blue.
int	getBrightnessValue() Brightness value for a raster.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getContrastValue() Contrast value for a raster.
java.lang.String	getDescription() The description of the raster renderer.
int	getDisplayResolutionFactor() Display resolution factor.
ITable	getDisplayTable() The renderer display table.
java.lang.Object	getGammaValue() The list of Gamma value(s).
int	getGreenBandIndex() Band to be represented in green.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
java.lang.String	getName() The name of the raster renderer.
IColor	getNoDataColor() Nodata color for a raster.
IRaster	getRaster() Raster to be rendered.
int	getRedBandIndex() Band to be represented in red.
int	getResamplingType() Resampling method for displaying a raster.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IArray	getSpecificationHistogram() The statistics for histogram specification stretch.
double	getStandardDeviationsParam() Standard deviation parameter for the stretch renderer.
IArray	getStretchStats() The global raster stretch statistics.
int	getStretchStatsType() The current stretch statistics type.
int	getStretchType() Current stretch type.
int	getTransparencyValue() Transparency value for a raster.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
boolean	isBackground() Indicates if a background value is being used.
void	isDirty() isDirty
boolean	isGlobeLayerRenderer() Indicates whether it is a ArcGlobe layer renderer.
boolean	isInvert() Indicates if the stretch is inverted.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUpdated() Indicates whether the renderer requires updating.
boolean	isUseAlphaBand() Indicates if the Alpha band is used.
boolean	isUseBlueBand() Indicates if the blue band is used.
boolean	isUseDefaultMapping() Indicates whether the default mapping is being used.
boolean	isUseGamma() Indicates if Gamma stretch should be applied.
boolean	isUseGreenBand() Indicates if the green band is used.
boolean	isUseRedBand() Indicates if the red band is used.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
void	load(IStream pstm) load
void	queryBandIndices(int[] redIndex, int[] greenIndex, int[] blueIndex) Band numbers for red, green, and blue bands.
void	readExternal(java.io.ObjectInput in)
void	recreateRaster(IRasterDataset pDataset, IRaster pRaster) Recreates a raster, if necessary, from a given RasterDataset.
void	release() Release a RasterRGBRenderer.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAlphaBandIndex(int pIndex) The band to be represented in Alpha.
void	setBackground(boolean b) Indicates if a background value is being used.
void	setBackgroundColorByRef(IColor ppColor) Background display color.
void	setBackgroundValue(java.lang.Object background) The list of background value(s).
void	setBackgroundValues(double[] pBkg) Indicates whether an array of background values is being used.
void	setBandIndices(int redIndex, int greenIndex, int blueIndex) Band numbers for red, green, and blue bands.
void	setBandIndices(java.lang.Object vIndex) The band indices being used in the mapping.
void	setBlueBandIndex(int blueIndex) Band to be represented in blue.
void	setBrightnessValue(int pValue) Brightness value for a raster.
void	setContrastValue(int iValue) Contrast value for a raster.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setDisplayTableByRef(ITable ppTable) The renderer display table.
void	setGammaValue(java.lang.Object pGamma) The list of Gamma value(s).
void	setGreenBandIndex(int greenIndex) Band to be represented in green.
void	setInvert(boolean pInvert) Indicates if the stretch is inverted.
void	setIsGlobeLayerRenderer(boolean flag) Indicates whether it is a ArcGlobe layer renderer.
void	setNoDataColorByRef(IColor ppColor) Nodata color for a raster.
void	setRasterByRef(IRaster raster) Raster to be rendered.
void	setRedBandIndex(int redIndex) Band to be represented in red.
void	setResamplingType(int pResamplingType) Resampling method for displaying a raster.
void	setSpecificationHistogramByRef(IArray pRGBStats) The statistics for histogram specification stretch.
void	setStandardDeviationsParam(double param) Standard deviation parameter for the stretch renderer.
void	setStretchStatsByRef(IArray ppRGBStats) The global raster stretch statistics.
void	setStretchStatsType(int stats) The current stretch statistics type.
void	setStretchType(int en_stretch) Current stretch type.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTransparencyValue(int pValue) Transparency value for a raster.
void	setUseAlphaBand(boolean pUse) Indicates if the Alpha band is used.
void	setUseBlueBand(boolean bBand) Indicates if the blue band is used.
void	setUseDefaultMapping(boolean bIsDefault) Indicates whether the default mapping is being used.
void	setUseGamma(boolean pUseGamma) Indicates if Gamma stretch should be applied.
void	setUseGreenBand(boolean bBand) Indicates if the green band is used.
void	setUseRedBand(boolean bBand) Indicates if the red band is used.
void	update() Updates the renderer for any changes that have been made.
void	update(IRasterLayer pRasterLayer) Updates this raster renderer using a given raster layer.
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

RasterRGBRenderer

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

Constructs a RasterRGBRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterRGBRenderer

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

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

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

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 RasterRGBRenderer.

Specified by:

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

setBandIndices

public void setBandIndices(int redIndex,
                           int greenIndex,
                           int blueIndex)
                    throws java.io.IOException,
                           AutomationException

Band numbers for red, green, and blue bands.

Specified by:

setBandIndices in interface IRasterRGBRenderer

Parameters:

redIndex - The redIndex (in)

greenIndex - The greenIndex (in)

blueIndex - The blueIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBandIndices

public void queryBandIndices(int[] redIndex,
                             int[] greenIndex,
                             int[] blueIndex)
                      throws java.io.IOException,
                             AutomationException

Band numbers for red, green, and blue bands.

Specified by:

queryBandIndices in interface IRasterRGBRenderer

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRedBandIndex

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

Band to be represented in red.

Specified by:

getRedBandIndex in interface IRasterRGBRenderer

Returns:

The redIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRedBandIndex

public void setRedBandIndex(int redIndex)
                     throws java.io.IOException,
                            AutomationException

Band to be represented in red.

Specified by:

setRedBandIndex in interface IRasterRGBRenderer

Parameters:

redIndex - The redIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGreenBandIndex

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

Band to be represented in green.

Specified by:

getGreenBandIndex in interface IRasterRGBRenderer

Returns:

The greenIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGreenBandIndex

public void setGreenBandIndex(int greenIndex)
                       throws java.io.IOException,
                              AutomationException

Band to be represented in green.

Specified by:

setGreenBandIndex in interface IRasterRGBRenderer

Parameters:

greenIndex - The greenIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBlueBandIndex

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

Band to be represented in blue.

Specified by:

getBlueBandIndex in interface IRasterRGBRenderer

Returns:

The blueIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBlueBandIndex

public void setBlueBandIndex(int blueIndex)
                      throws java.io.IOException,
                             AutomationException

Band to be represented in blue.

Specified by:

setBlueBandIndex in interface IRasterRGBRenderer

Parameters:

blueIndex - The blueIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseRedBand

public boolean isUseRedBand()
                     throws java.io.IOException,
                            AutomationException

Indicates if the red band is used.

Specified by:

isUseRedBand in interface IRasterRGBRenderer

Returns:

The bBand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseRedBand

public void setUseRedBand(boolean bBand)
                   throws java.io.IOException,
                          AutomationException

Indicates if the red band is used.

Specified by:

setUseRedBand in interface IRasterRGBRenderer

Parameters:

bBand - The bBand (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseGreenBand

public boolean isUseGreenBand()
                       throws java.io.IOException,
                              AutomationException

Indicates if the green band is used.

Specified by:

isUseGreenBand in interface IRasterRGBRenderer

Returns:

The bBand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseGreenBand

public void setUseGreenBand(boolean bBand)
                     throws java.io.IOException,
                            AutomationException

Indicates if the green band is used.

Specified by:

setUseGreenBand in interface IRasterRGBRenderer

Parameters:

bBand - The bBand (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseBlueBand

public boolean isUseBlueBand()
                      throws java.io.IOException,
                             AutomationException

Indicates if the blue band is used.

Specified by:

isUseBlueBand in interface IRasterRGBRenderer

Returns:

The bBand

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseBlueBand

public void setUseBlueBand(boolean bBand)
                    throws java.io.IOException,
                           AutomationException

Indicates if the blue band is used.

Specified by:

setUseBlueBand in interface IRasterRGBRenderer

Parameters:

bBand - The bBand (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAlphaBandIndex

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

The band to be represented in Alpha.

Specified by:

getAlphaBandIndex in interface IRasterRGBRenderer2

Returns:

The pIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAlphaBandIndex

public void setAlphaBandIndex(int pIndex)
                       throws java.io.IOException,
                              AutomationException

The band to be represented in Alpha.

Specified by:

setAlphaBandIndex in interface IRasterRGBRenderer2

Parameters:

pIndex - The pIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseAlphaBand

public boolean isUseAlphaBand()
                       throws java.io.IOException,
                              AutomationException

Indicates if the Alpha band is used.

Specified by:

isUseAlphaBand in interface IRasterRGBRenderer2

Returns:

The pUse

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseAlphaBand

public void setUseAlphaBand(boolean pUse)
                     throws java.io.IOException,
                            AutomationException

Indicates if the Alpha band is used.

Specified by:

setUseAlphaBand in interface IRasterRGBRenderer2

Parameters:

pUse - The pUse (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGlobeLayerRenderer

public boolean isGlobeLayerRenderer()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether it is a ArcGlobe layer renderer.

Specified by:

isGlobeLayerRenderer in interface IGlobeRasterStretch

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsGlobeLayerRenderer

public void setIsGlobeLayerRenderer(boolean flag)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether it is a ArcGlobe layer renderer.

Specified by:

setIsGlobeLayerRenderer in interface IGlobeRasterStretch

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchType

public void setStretchType(int en_stretch)
                    throws java.io.IOException,
                           AutomationException

Current stretch type.

Specified by:

setStretchType in interface IRasterStretch

Specified by:

setStretchType in interface IRasterStretch2

Parameters:

en_stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStretchType

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

Current stretch type.

Specified by:

getStretchType in interface IRasterStretch

Specified by:

getStretchType in interface IRasterStretch2

Returns:

A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

public void setStandardDeviationsParam(double param)
                                throws java.io.IOException,
                                       AutomationException

Standard deviation parameter for the stretch renderer.

Specified by:

setStandardDeviationsParam in interface IRasterStretch

Specified by:

setStandardDeviationsParam in interface IRasterStretch2

Parameters:

param - The param (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandardDeviationsParam

public double getStandardDeviationsParam()
                                  throws java.io.IOException,
                                         AutomationException

Standard deviation parameter for the stretch renderer.

Specified by:

getStandardDeviationsParam in interface IRasterStretch

Specified by:

getStandardDeviationsParam in interface IRasterStretch2

Returns:

The param

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInvert

public void setInvert(boolean pInvert)
               throws java.io.IOException,
                      AutomationException

Indicates if the stretch is inverted.

Specified by:

setInvert in interface IRasterStretch

Specified by:

setInvert in interface IRasterStretch2

Parameters:

pInvert - The pInvert (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isInvert

public boolean isInvert()
                 throws java.io.IOException,
                        AutomationException

Indicates if the stretch is inverted.

Specified by:

isInvert in interface IRasterStretch

Specified by:

isInvert in interface IRasterStretch2

Returns:

The pInvert

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(boolean b)
                   throws java.io.IOException,
                          AutomationException

Indicates if a background value is being used.

Specified by:

setBackground in interface IRasterStretch

Specified by:

setBackground in interface IRasterStretch2

Parameters:

b - The b (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBackground

public boolean isBackground()
                     throws java.io.IOException,
                            AutomationException

Indicates if a background value is being used.

Specified by:

isBackground in interface IRasterStretch

Specified by:

isBackground in interface IRasterStretch2

Returns:

The b

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundValues

public double getBackgroundValues()
                           throws java.io.IOException,
                                  AutomationException

Indicates whether an array of background values is being used.

Specified by:

getBackgroundValues in interface IRasterStretch

Returns:

The pBkg

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

public void setBackgroundValues(double[] pBkg)
                         throws java.io.IOException,
                                AutomationException

Indicates whether an array of background values is being used.

Specified by:

setBackgroundValues in interface IRasterStretch

Parameters:

pBkg - The pBkg (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Background display color.

Specified by:

getBackgroundColor in interface IRasterStretch

Specified by:

getBackgroundColor in interface IRasterStretch2

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.

setBackgroundColorByRef

public void setBackgroundColorByRef(IColor ppColor)
                             throws java.io.IOException,
                                    AutomationException

Background display color.

Specified by:

setBackgroundColorByRef in interface IRasterStretch

Specified by:

setBackgroundColorByRef in interface IRasterStretch2

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundValue

public java.lang.Object getBackgroundValue()
                                    throws java.io.IOException,
                                           AutomationException

The list of background value(s).

Specified by:

getBackgroundValue in interface IRasterStretch2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundValue

public void setBackgroundValue(java.lang.Object background)
                        throws java.io.IOException,
                               AutomationException

The list of background value(s).

Specified by:

setBackgroundValue in interface IRasterStretch2

Parameters:

background - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchStatsType

public void setStretchStatsType(int stats)
                         throws java.io.IOException,
                                AutomationException

The current stretch statistics type.

Specified by:

setStretchStatsType in interface IRasterStretch2

Parameters:

stats - A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStretchStatsType

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

The current stretch statistics type.

Specified by:

getStretchStatsType in interface IRasterStretch2

Returns:

A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchStatsByRef

public void setStretchStatsByRef(IArray ppRGBStats)
                          throws java.io.IOException,
                                 AutomationException

The global raster stretch statistics.

Specified by:

setStretchStatsByRef in interface IRasterStretch2

Parameters:

ppRGBStats - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStretchStats

public IArray getStretchStats()
                       throws java.io.IOException,
                              AutomationException

The global raster stretch statistics.

Specified by:

getStretchStats in interface IRasterStretch2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpecificationHistogramByRef

public void setSpecificationHistogramByRef(IArray pRGBStats)
                                    throws java.io.IOException,
                                           AutomationException

The statistics for histogram specification stretch.

Specified by:

setSpecificationHistogramByRef in interface IRasterStretch2

Parameters:

pRGBStats - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpecificationHistogram

public IArray getSpecificationHistogram()
                                 throws java.io.IOException,
                                        AutomationException

The statistics for histogram specification stretch.

Specified by:

getSpecificationHistogram in interface IRasterStretch2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseGamma

public void setUseGamma(boolean pUseGamma)
                 throws java.io.IOException,
                        AutomationException

Indicates if Gamma stretch should be applied.

Specified by:

setUseGamma in interface IRasterStretch3

Parameters:

pUseGamma - The pUseGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseGamma

public boolean isUseGamma()
                   throws java.io.IOException,
                          AutomationException

Indicates if Gamma stretch should be applied.

Specified by:

isUseGamma in interface IRasterStretch3

Returns:

The pUseGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGammaValue

public void setGammaValue(java.lang.Object pGamma)
                   throws java.io.IOException,
                          AutomationException

The list of Gamma value(s).

Specified by:

setGammaValue in interface IRasterStretch3

Parameters:

pGamma - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGammaValue

public java.lang.Object getGammaValue()
                               throws java.io.IOException,
                                      AutomationException

The list of Gamma value(s).

Specified by:

getGammaValue in interface IRasterStretch3

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IRaster raster)
                  throws java.io.IOException,
                         AutomationException

Indicates if the raster can be rendered.

Specified by:

canRender in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

The pCanRender

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(IRaster raster)
                    throws java.io.IOException,
                           AutomationException

Raster to be rendered.

Specified by:

setRasterByRef in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

Raster to be rendered.

Specified by:

getRaster in interface IRasterRenderer

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IRaster raster,
                 int drawPhase,
                 IDisplay pDisplay,
                 ITrackCancel pTrackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the raster on the display.

Specified by:

draw in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUpdated

public boolean isUpdated()
                  throws java.io.IOException,
                         AutomationException

Indicates whether the renderer requires updating.

Specified by:

isUpdated in interface IRasterRenderer

Returns:

The pUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates the renderer for any changes that have been made.

Specified by:

update in interface IRasterRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRasterRenderer pSource)
          throws java.io.IOException,
                 AutomationException

Selects a raster as the current copy object.

Specified by:

copy in interface IRasterRenderer

Parameters:

pSource - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingType

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

Resampling method for displaying a raster.

Specified by:

getResamplingType in interface IRasterRenderer

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingType

public void setResamplingType(int pResamplingType)
                       throws java.io.IOException,
                              AutomationException

Resampling method for displaying a raster.

Specified by:

setResamplingType in interface IRasterRenderer

Parameters:

pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

public void setDisplayResolutionFactor(int pnFactor)
                                throws java.io.IOException,
                                       AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

setDisplayResolutionFactor in interface IRasterRenderer

Parameters:

pnFactor - The pnFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

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

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

getDisplayResolutionFactor in interface IRasterRenderer

Returns:

The pnFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

recreateRaster

public void recreateRaster(IRasterDataset pDataset,
                           IRaster pRaster)
                    throws java.io.IOException,
                           AutomationException

Recreates a raster, if necessary, from a given RasterDataset.

Specified by:

recreateRaster in interface IRasterRenderer2

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adaptRaster

public void adaptRaster(IRaster pRaster)
                 throws java.io.IOException,
                        AutomationException

Adapts to the new raster.

Specified by:

adaptRaster in interface IRasterRenderer2

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (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 raster renderer.

Specified by:

getName in interface IRasterRendererInfo

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the raster renderer.

Specified by:

getDescription in interface IRasterRendererInfo

Returns:

The pDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContrastValue

public void setContrastValue(int iValue)
                      throws java.io.IOException,
                             AutomationException

Contrast value for a raster.

Specified by:

setContrastValue in interface IRasterDisplayProps

Parameters:

iValue - The iValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrastValue

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

Contrast value for a raster.

Specified by:

getContrastValue in interface IRasterDisplayProps

Returns:

The iValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightnessValue

public void setBrightnessValue(int pValue)
                        throws java.io.IOException,
                               AutomationException

Brightness value for a raster.

Specified by:

setBrightnessValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightnessValue

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

Brightness value for a raster.

Specified by:

getBrightnessValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparencyValue

public void setTransparencyValue(int pValue)
                          throws java.io.IOException,
                                 AutomationException

Transparency value for a raster.

Specified by:

setTransparencyValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparencyValue

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

Transparency value for a raster.

Specified by:

getTransparencyValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataColor

public IColor getNoDataColor()
                      throws java.io.IOException,
                             AutomationException

Nodata color for a raster.

Specified by:

getNoDataColor in interface IRasterDisplayProps

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.

setNoDataColorByRef

public void setNoDataColorByRef(IColor ppColor)
                         throws java.io.IOException,
                                AutomationException

Nodata color for a raster.

Specified by:

setNoDataColorByRef in interface IRasterDisplayProps

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

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

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

A reference to a com.esri.arcgis.carto.ILegendItem

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws java.io.IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseDefaultMapping

public boolean isUseDefaultMapping()
                            throws java.io.IOException,
                                   AutomationException

Indicates whether the default mapping is being used.

Specified by:

isUseDefaultMapping in interface IColorChannelMapping

Returns:

The bIsDefault

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseDefaultMapping

public void setUseDefaultMapping(boolean bIsDefault)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the default mapping is being used.

Specified by:

setUseDefaultMapping in interface IColorChannelMapping

Parameters:

bIsDefault - The bIsDefault (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandIndices

public java.lang.Object getBandIndices()
                                throws java.io.IOException,
                                       AutomationException

The band indices being used in the mapping.

Specified by:

getBandIndices in interface IColorChannelMapping

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandIndices

public void setBandIndices(java.lang.Object vIndex)
                    throws java.io.IOException,
                           AutomationException

The band indices being used in the mapping.

Specified by:

setBandIndices in interface IColorChannelMapping

Parameters:

vIndex - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayTableByRef

public void setDisplayTableByRef(ITable ppTable)
                          throws java.io.IOException,
                                 AutomationException

The renderer display table.

Specified by:

setDisplayTableByRef in interface IDisplayTableExchange

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws java.io.IOException,
                              AutomationException

The renderer display table.

Specified by:

getDisplayTable in interface IDisplayTableExchange

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRasterLayer pRasterLayer)
            throws java.io.IOException,
                   AutomationException

Updates this raster renderer using a given raster layer.

Specified by:

update in interface IRasterRendererUpdate

Parameters:

pRasterLayer - A reference to a com.esri.arcgis.carto.IRasterLayer (in)

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