com.esri.arcgis.carto
Interface IRasterDefaultsEnv5

All Superinterfaces:

IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4, java.io.Serializable

All Known Subinterfaces:

IRasterDefaultsEnv6, IRasterDefaultsEnv7, IRasterDefaultsEnv8, IRasterDefaultsEnv9

All Known Implementing Classes:

IRasterDefaultsEnv5Proxy, IRasterDefaultsEnv6Proxy, IRasterDefaultsEnv7Proxy, IRasterDefaultsEnv8Proxy, IRasterDefaultsEnv9Proxy, RasterDefaultsEnv

public interface IRasterDefaultsEnv5
extends IRasterDefaultsEnv4, java.io.Serializable

COM Interface 'IRasterDefaultsEnv5'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the default raster environment.' 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	IIDaf3085cd_39d4_45e3_93d0_1071cb4527cb
static int	xxDummy Deprecated. Internal use only

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

IID4dcd6e47_90a1_4341_a90b_52ab6df2ffa4

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

IIDbbce4f14_f0da_4cbf_8196_0e380b34ccbb

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

IIDe5191e5e_4d03_45d9_94a4_9e2d8c5c9aed

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

IIDfb89a39b_c08e_11d2_9f43_00c04f8ed21a

Method Summary

IColor	getBackgroundColor() The color of background.
IColor	getNoDataColor() Nodata color for a raster layer.
boolean	isCreateTiledTIFF() Indicates if newly created TIFF images should be tiled.
boolean	isDisplayBackground() Indicates if a background value is being used.
void	queryBackgroundValues(double[] pRed, double[] pGreen, double[] pBlue) background value.
void	setBackgroundColor(IColor ppColor) The color of background.
void	setBackgroundValues(double red, double green, double blue) background value.
void	setCreateTiledTIFF(boolean pTiled) Indicates if newly created TIFF images should be tiled.
void	setDisplayBackground(boolean b) Indicates if a background value is being used.
void	setNoDataColor(IColor ppColor) Nodata color for a raster layer.

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv4

getMaximumRastersColorMatching, isAskSubdatasetSelection, isDisplayWithContrastStretch, setAskSubdatasetSelection, setDisplayWithContrastStretch, setMaximumRastersColorMatching

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv3

getMaximumBuildAttributeTableSize, isAssumeHomogeneousCatalog, isFavorWorldFile, setAssumeHomogeneousCatalog, setFavorWorldFile, setMaximumBuildAttributeTableSize

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv2

getMaxTableSize, getProxyFilePath, getRenderingMode, getResampling, setMaxTableSize, setProxyFilePath, setRenderingMode, setResampling, updateAll

Methods inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv

getFormat, getNumFormats, getPyramidCreateOpt, isUseExtChecking, query3BandRGB, query4BandRGB, set3BandRGB, set4BandRGB, setPyramidCreateOpt, setUseExtChecking

Field Detail

IIDaf3085cd_39d4_45e3_93d0_1071cb4527cb

static final int IIDaf3085cd_39d4_45e3_93d0_1071cb4527cb

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

setDisplayBackground

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

Indicates if a background value is being used.

Parameters:

b - The b (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayBackground

boolean isDisplayBackground()
                            throws java.io.IOException,
                                   AutomationException

Indicates if a background value is being used.

Returns:

The b

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBackgroundValues

void queryBackgroundValues(double[] pRed,
                           double[] pGreen,
                           double[] pBlue)
                           throws java.io.IOException,
                                  AutomationException

background value.

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

void setBackgroundValues(double red,
                         double green,
                         double blue)
                         throws java.io.IOException,
                                AutomationException

background value.

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

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

The color of background.

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.

setBackgroundColor

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

The color of background.

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.

getNoDataColor

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

Nodata color for a raster layer.

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.

setNoDataColor

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

Nodata color for a raster layer.

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.

isCreateTiledTIFF

boolean isCreateTiledTIFF()
                          throws java.io.IOException,
                                 AutomationException

Indicates if newly created TIFF images should be tiled.

Returns:

The pTiled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCreateTiledTIFF

void setCreateTiledTIFF(boolean pTiled)
                        throws java.io.IOException,
                               AutomationException

Indicates if newly created TIFF images should be tiled.

Parameters:

pTiled - The pTiled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.