com.esri.arcgis.carto
Class RasterRendererMakerDefault

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

All Implemented Interfaces:

IRasterRendererMaker, IRasterRendererMaker2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterRendererMakerDefault
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterRendererMaker, IRasterRendererMaker2

A way to determine which renderer is used for the default display of a raster dataset.

Description

The RasterRendererMakerDefault object is used by the system to determine the default renderer used to display a raster. The default renderer is used when a raster is initially added to ArcMap, ArcScene, ArcGlobe or the raster is displayed in ArcCatalog. The renderer can later be changed in ArcMap, ArcScene, and ArcGlobe, but is not adjustable within ArcCatalog. Custom renderer maker objects can be created if you wish to use different renderer defaults than those provided by this object. This object can be cocreated to see which renderer will be used by default for any raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterRendererMakerDefault()
Constructs a RasterRendererMakerDefault using ArcGIS Engine.

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

Method Summary

IRasterRenderer	createDefaultRasterRenderer(IRaster pRaster) Returns the raster renderer which should be used for the default display of the input raster.
IRasterRenderer	createDefaultRasterRenderer(IRasterDataset pRasterDataset) Returns the raster renderer which should be used for the default display of the input raster.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getPriority() Controls the order in which renderer makers are selected.
int	hashCode() the hashcode for this object

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

RasterRendererMakerDefault

public RasterRendererMakerDefault()
                           throws IOException,
                                  UnknownHostException

Constructs a RasterRendererMakerDefault using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterRendererMakerDefault

public RasterRendererMakerDefault(Object obj)
                           throws IOException

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

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

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

createDefaultRasterRenderer

public IRasterRenderer createDefaultRasterRenderer(IRaster pRaster)
                                            throws IOException,
                                                   AutomationException

Returns the raster renderer which should be used for the default display of the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createDefaultRasterRenderer in interface IRasterRendererMaker

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException

Controls the order in which renderer makers are selected. Higher priority renderer makers are called first.

Remarks

The priority method returns the priority of this renderer maker relative to others in the system. Renderer makers are called with decreasing priority until a renderer is provided for a raster. As soon as a renderer is returned, the priority of the RasterRendererMakerDefault is 0. The CreateRasterDefaultRenderer method returns the renderer that will be used by default for the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPriority in interface IRasterRendererMaker

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDefaultRasterRenderer

public IRasterRenderer createDefaultRasterRenderer(IRasterDataset pRasterDataset)
                                            throws IOException,
                                                   AutomationException

Returns the raster renderer which should be used for the default display of the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createDefaultRasterRenderer in interface IRasterRendererMaker2

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.