com.esri.arcgis.carto
Class TerrainLayer

java.lang.Object
  extended by com.esri.arcgis.carto.TerrainLayer
All Implemented Interfaces:
IDataLayer, IDataLayer2, IIdentify, ILayer, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerPosition, ILegendInfo, ITerrainLayer, IConnectionPointContainer, IDisplayAdmin, IDisplayFilterManager, IGeoDataset, ITerrainEditEvents, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable, EventListener

public class TerrainLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeoDataset, ITerrainLayer, ILayer, ILayerInfo, IIdentify, ILayerExtensions, ILayerPosition, IDisplayFilterManager, ILayerEffects, IDataLayer, IDataLayer2, IPersistStream, ILayerGeneralProperties, ILegendInfo, ITerrainEditEvents, IConnectionPointContainer, Externalizable

The Terrain Layer class.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TerrainLayer()
          Constructs a TerrainLayer using ArcGIS Engine.
TerrainLayer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainLayer theTerrainLayer = (TerrainLayer) obj;
 
Method Summary
 void addExtension(Object ext)
          Adds a new extension.
 void addRenderer(ITinRenderer pRenderer)
          Add a renderer to the end of the group.
 void clearRenderers()
          Remove all the renderers from the group.
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 void deleteRenderer(ITinRenderer pRenderer)
          Remove a renderer from the group.
 void disconnect()
          Disconnects the data from the layer.
 void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)
          Draws the layer to the specified display for the given draw phase.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(Object o)
          Compare this object with another
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 double getAnalysisToolsResolution()
          Indicates the resolution that analysis tools will be enabled.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 short getContrast()
          Layer contrast in percent (-100 - 100).
 double getCurrentResolution()
          Indicates the current resolution.
 ISurface getCurrentSurface()
          Gets current surface.
 IName getDataSourceName()
          Name of the data object for the layer.
 String getDisplayField()
          The primary display field.
 IDisplayFilter getDisplayFilter()
          The display filter.
 Object getExtension(int index)
          The extension at the specified index.
 int getExtensionCount()
          Number of extensions.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 int getLargeImage()
          Large image that represents the layer.
 int getLargeSelectedImage()
          Large image that represents the layer when it is selected.
 double getLastMaximumScale()
          Last maximum scale setting used by layer.
 double getLastMinimumScale()
          Last minimum scale setting used by layer.
 double getLayerWeight()
          Default layer position.
 ILegendGroup getLegendGroup(int index)
          Legend group at the specified index.
 int getLegendGroupCount()
          Number of legend groups contained by the object.
 ILegendItem getLegendItem()
          Optional.
 double getMaximumScale()
          Maximum scale (representative fraction) at which the layer will display.
 double getMinimumScale()
          Minimum scale (representative fraction) at which the layer will display.
 String getName()
          Layer name.
 int getPointBudget()
          Indicates the Point Budget.
 String getRelativeBase()
          Base path used when storing relative path names.
 ITinRenderer getRenderer(int index)
          Gets the nth renderer.
 int getRendererCount()
          The number of renderers.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSmallImage()
          Small image that represents the layer.
 int getSmallSelectedImage()
          Small image that represents the layer when it is selected.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 int getSupportedDrawPhases()
          Supported draw phases.
 double getTargetResolution()
          Indicates the resolution to be used when AutoLOR is false.
 ITerrain getTerrain()
          The Terrain used to define the layer.
 String getTipText(double x, double y, double tolerance)
          Map tip text at the specified location.
 short getTransparency()
          Layer transparency in percent (0-100).
 int hashCode()
          the hashcode for this object
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 String ILayerGeneralProperties_getLayerDescription()
          Description for the layer.
 void insertRenderer(ITinRenderer pRenderer, int index)
          Insert a renderer at given index.
 boolean inWorkspace(IWorkspace workspace)
          Returns TRUE if the layer is in the specified workspace.
 boolean isAutoLOR()
          Indicates if LOR should be updated when scale changed.
 boolean isCached()
          Indicates if the layer needs its own display cache.
 boolean isDataSourceSupported(IName name)
          Indicates if the specified data object name is supported by the layer.
 void isDirty()
          isDirty
 boolean isLockCurrentSurface()
          Indicates if current surface should be updated based on scale change.
 boolean isPyramidHonored()
          Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition.
 boolean isScaleSymbols()
          Indicates if symbols are scaled for this layer.
 boolean isShowResolution()
          Indicates if TOC should display resolution.
 boolean isShowTips()
          Indicates if the layer shows map tips.
 boolean isSupportsBrightnessChange()
          Indicates if the layer supports brightness changes.
 boolean isSupportsContrastChange()
          Indicates if the layer supports contrast changes.
 boolean isSupportsInteractive()
          Indicates if the layer supports interactive effects changes.
 boolean isSupportsTransparency()
          Indicates if the layer supports transparency.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isUseOverviewTerrain()
          Indicates if Overview Terrain should be used when zoom to full.
 boolean isUsePointBudget()
          Indicates if Point Budget should be used for rendering performance.
 boolean isUsesFilter()
          Indicates if the current object draws using a filter.
 boolean isValid()
          Indicates if the layer is currently valid.
 boolean isVisible()
          Indicates if the layer is currently visible.
 void load(IStream pstm)
          load
 void onBuild(ITerrainEditEventsOnBuildEvent theEvent)
          This event is fired when Build is called on a Terrain.
 void onReconcile(ITerrainEditEventsOnReconcileEvent theEvent)
          This event is fired when Reconcile is called on a Terrain.
 void onRedoBuild(ITerrainEditEventsOnRedoBuildEvent theEvent)
          This event is fired when Redo Build is called on a Terrain.
 void onRedoReconcile(ITerrainEditEventsOnRedoReconcileEvent theEvent)
          This event is fired when Redo Reconcile is called on a Terrain.
 void onUndoBuild(ITerrainEditEventsOnUndoBuildEvent theEvent)
          This event is fired when Undo Build is called on a Terrain.
 void onUndoReconcile(ITerrainEditEventsOnUndoReconcileEvent theEvent)
          This event is fired when Undo Reconcile is called on a Terrain.
 void readExternal(ObjectInput in)
           
 void removeExtension(int index)
          Removes the specified extension.
 void save(IStream pstm, int fClearDirty)
          save
 void setAnalysisToolsResolution(double pAnalysisResolution)
          Indicates the resolution that analysis tools will be enabled.
 void setAutoLOR(boolean pbAutoLOR)
          Indicates if LOR should be updated when scale changed.
 void setBrightness(short brightnessValue)
          Layer brightness in percent (-100 - 100).
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setContrast(short contrastValue)
          Layer contrast in percent (-100 - 100).
 void setDataSourceName(IName name)
          Name of the data object for the layer.
 void setDisplayField(String pFieldName)
          The primary display field.
 void setDisplayFilter(IDisplayFilter displayFilter)
          The display filter.
 void setLayerDescription(String text)
          Description for the layer.
 void setLayerWeight(double layerWeight)
          Default layer position.
 void setLockCurrentSurface(boolean pbLock)
          Indicates if current surface should be updated based on scale change.
 void setMaximumScale(double maxScale)
          Maximum scale (representative fraction) at which the layer will display.
 void setMinimumScale(double minScale)
          Minimum scale (representative fraction) at which the layer will display.
 void setName(String name)
          Layer name.
 void setPointBudget(int pPointBudget)
          Indicates the Point Budget.
 void setRelativeBase(String basePath)
          Base path used when storing relative path names.
 void setScaleSymbols(boolean pbScale)
          Indicates if symbols are scaled for this layer.
 void setShowResolution(boolean pbShow)
          Indicates if TOC should display resolution.
 void setShowTips(boolean show)
          Indicates if the layer shows map tips.
 void setSpatialReferenceByRef(ISpatialReference rhs1)
          Spatial reference for the layer.
 void setSupportsInteractive(boolean supported)
          Indicates if the layer supports interactive effects changes.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTargetResolution(double pResolution)
          Indicates the resolution to be used when AutoLOR is false.
 void setTerrainByRef(ITerrain ppTerrain)
          The Terrain used to define the layer.
 void setTransparency(short alpha)
          Layer transparency in percent (0-100).
 void setUseOverviewTerrain(boolean pbUseOverviewTerrain)
          Indicates if Overview Terrain should be used when zoom to full.
 void setUsePointBudget(boolean pbUsePointBudget)
          Indicates if Point Budget should be used for rendering performance.
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 void writeExternal(ObjectOutput out)
           
 
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

TerrainLayer

public TerrainLayer()
             throws IOException,
                    UnknownHostException
Constructs a TerrainLayer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

TerrainLayer

public TerrainLayer(Object obj)
             throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainLayer theTerrainLayer = (TerrainLayer) obj;

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

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException
The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSpatialReference in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTerrain

public ITerrain getTerrain()
                    throws IOException,
                           AutomationException
The Terrain used to define the layer.

Product Availability

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

Specified by:
getTerrain in interface ITerrainLayer
Returns:
A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(ITerrain ppTerrain)
                     throws IOException,
                            AutomationException
The Terrain used to define the layer.

Product Availability

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

Specified by:
setTerrainByRef in interface ITerrainLayer
Parameters:
ppTerrain - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSurface

public ISurface getCurrentSurface()
                           throws IOException,
                                  AutomationException
Gets current surface.

Description

GetCurrentSurface may return a NULL pointer ('Nothing' in VB). For example, it will return NULL if ITerrain.IsValid is FALSE. Therefore, check the return value before attempting to use it.

Product Availability

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

Specified by:
getCurrentSurface in interface ITerrainLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.ISurface
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRendererCount

public int getRendererCount()
                     throws IOException,
                            AutomationException
The number of renderers.

Product Availability

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

Specified by:
getRendererCount in interface ITerrainLayer
Returns:
The pRendererCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderer

public ITinRenderer getRenderer(int index)
                         throws IOException,
                                AutomationException
Gets the nth renderer.

Product Availability

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

Specified by:
getRenderer in interface ITerrainLayer
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.ITinRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addRenderer

public void addRenderer(ITinRenderer pRenderer)
                 throws IOException,
                        AutomationException
Add a renderer to the end of the group.

Product Availability

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

Specified by:
addRenderer in interface ITerrainLayer
Parameters:
pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertRenderer

public void insertRenderer(ITinRenderer pRenderer,
                           int index)
                    throws IOException,
                           AutomationException
Insert a renderer at given index.

Product Availability

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

Specified by:
insertRenderer in interface ITerrainLayer
Parameters:
pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRenderer

public void deleteRenderer(ITinRenderer pRenderer)
                    throws IOException,
                           AutomationException
Remove a renderer from the group.

Product Availability

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

Specified by:
deleteRenderer in interface ITerrainLayer
Parameters:
pRenderer - A reference to a com.esri.arcgis.carto.ITinRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearRenderers

public void clearRenderers()
                    throws IOException,
                           AutomationException
Remove all the renderers from the group.

Product Availability

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

Specified by:
clearRenderers in interface ITerrainLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayField

public String getDisplayField()
                       throws IOException,
                              AutomationException
The primary display field.

Product Availability

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

Specified by:
getDisplayField in interface ITerrainLayer
Returns:
The pFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayField

public void setDisplayField(String pFieldName)
                     throws IOException,
                            AutomationException
The primary display field.

Product Availability

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

Specified by:
setDisplayField in interface ITerrainLayer
Parameters:
pFieldName - The pFieldName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isScaleSymbols

public boolean isScaleSymbols()
                       throws IOException,
                              AutomationException
Indicates if symbols are scaled for this layer.

Product Availability

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

Specified by:
isScaleSymbols in interface ITerrainLayer
Returns:
The pbScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleSymbols

public void setScaleSymbols(boolean pbScale)
                     throws IOException,
                            AutomationException
Indicates if symbols are scaled for this layer.

Product Availability

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

Specified by:
setScaleSymbols in interface ITerrainLayer
Parameters:
pbScale - The pbScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOverviewTerrain

public boolean isUseOverviewTerrain()
                             throws IOException,
                                    AutomationException
Indicates if Overview Terrain should be used when zoom to full.

Product Availability

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

Specified by:
isUseOverviewTerrain in interface ITerrainLayer
Returns:
The pbUseOverviewTerrain
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseOverviewTerrain

public void setUseOverviewTerrain(boolean pbUseOverviewTerrain)
                           throws IOException,
                                  AutomationException
Indicates if Overview Terrain should be used when zoom to full.

Product Availability

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

Specified by:
setUseOverviewTerrain in interface ITerrainLayer
Parameters:
pbUseOverviewTerrain - The pbUseOverviewTerrain (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoLOR

public boolean isAutoLOR()
                  throws IOException,
                         AutomationException
Indicates if LOR should be updated when scale changed.

Product Availability

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

Specified by:
isAutoLOR in interface ITerrainLayer
Returns:
The pbAutoLOR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoLOR

public void setAutoLOR(boolean pbAutoLOR)
                throws IOException,
                       AutomationException
Indicates if LOR should be updated when scale changed.

Product Availability

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

Specified by:
setAutoLOR in interface ITerrainLayer
Parameters:
pbAutoLOR - The pbAutoLOR (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPyramidHonored

public boolean isPyramidHonored()
                         throws IOException,
                                AutomationException
Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition.

Product Availability

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

Specified by:
isPyramidHonored in interface ITerrainLayer
Returns:
The pbHonored
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTargetResolution

public double getTargetResolution()
                           throws IOException,
                                  AutomationException
Indicates the resolution to be used when AutoLOR is false.

Product Availability

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

Specified by:
getTargetResolution in interface ITerrainLayer
Returns:
The pResolution
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTargetResolution

public void setTargetResolution(double pResolution)
                         throws IOException,
                                AutomationException
Indicates the resolution to be used when AutoLOR is false.

Product Availability

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

Specified by:
setTargetResolution in interface ITerrainLayer
Parameters:
pResolution - The pResolution (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentResolution

public double getCurrentResolution()
                            throws IOException,
                                   AutomationException
Indicates the current resolution.

Product Availability

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

Specified by:
getCurrentResolution in interface ITerrainLayer
Returns:
The pResolution
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowResolution

public boolean isShowResolution()
                         throws IOException,
                                AutomationException
Indicates if TOC should display resolution.

Product Availability

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

Specified by:
isShowResolution in interface ITerrainLayer
Returns:
The pbShow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowResolution

public void setShowResolution(boolean pbShow)
                       throws IOException,
                              AutomationException
Indicates if TOC should display resolution.

Product Availability

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

Specified by:
setShowResolution in interface ITerrainLayer
Parameters:
pbShow - The pbShow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLockCurrentSurface

public boolean isLockCurrentSurface()
                             throws IOException,
                                    AutomationException
Indicates if current surface should be updated based on scale change.

Product Availability

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

Specified by:
isLockCurrentSurface in interface ITerrainLayer
Returns:
The pbLock
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLockCurrentSurface

public void setLockCurrentSurface(boolean pbLock)
                           throws IOException,
                                  AutomationException
Indicates if current surface should be updated based on scale change.

Product Availability

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

Specified by:
setLockCurrentSurface in interface ITerrainLayer
Parameters:
pbLock - The pbLock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsePointBudget

public boolean isUsePointBudget()
                         throws IOException,
                                AutomationException
Indicates if Point Budget should be used for rendering performance.

Product Availability

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

Specified by:
isUsePointBudget in interface ITerrainLayer
Returns:
The pbUsePointBudget
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUsePointBudget

public void setUsePointBudget(boolean pbUsePointBudget)
                       throws IOException,
                              AutomationException
Indicates if Point Budget should be used for rendering performance.

Product Availability

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

Specified by:
setUsePointBudget in interface ITerrainLayer
Parameters:
pbUsePointBudget - The pbUsePointBudget (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPointBudget

public int getPointBudget()
                   throws IOException,
                          AutomationException
Indicates the Point Budget.

Product Availability

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

Specified by:
getPointBudget in interface ITerrainLayer
Returns:
The pPointBudget
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPointBudget

public void setPointBudget(int pPointBudget)
                    throws IOException,
                           AutomationException
Indicates the Point Budget.

Product Availability

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

Specified by:
setPointBudget in interface ITerrainLayer
Parameters:
pPointBudget - The pPointBudget (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnalysisToolsResolution

public double getAnalysisToolsResolution()
                                  throws IOException,
                                         AutomationException
Indicates the resolution that analysis tools will be enabled.

Product Availability

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

Specified by:
getAnalysisToolsResolution in interface ITerrainLayer
Returns:
The pAnalysisResolution
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnalysisToolsResolution

public void setAnalysisToolsResolution(double pAnalysisResolution)
                                throws IOException,
                                       AutomationException
Indicates the resolution that analysis tools will be enabled.

Product Availability

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

Specified by:
setAnalysisToolsResolution in interface ITerrainLayer
Parameters:
pAnalysisResolution - The pAnalysisResolution (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Layer name.

Description


Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isValid

public boolean isValid()
                throws IOException,
                       AutomationException
Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isValid in interface ILayer
Returns:
The valid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException
The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAreaOfInterest in interface ILayer
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException
Minimum scale (representative fraction) at which the layer will display.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumScale in interface ILayer
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException
Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMinimumScale in interface ILayer
Parameters:
minScale - The minScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException
Maximum scale (representative fraction) at which the layer will display.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumScale in interface ILayer
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException
Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaximumScale in interface ILayer
Parameters:
maxScale - The maxScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isVisible in interface ILayer
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException
Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVisible in interface ILayer
Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException
Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowTips in interface ILayer
Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException
Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setShowTips in interface ILayer
Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException
Map tip text at the specified location.

Product Availability

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

Specified by:
getTipText in interface ILayer
Parameters:
x - The x (in)
y - The y (in)
tolerance - The tolerance (in)
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException
Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCached in interface ILayer
Returns:
The cached
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException
Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCached in interface ILayer
Parameters:
cached - The cached (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException
Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSupportedDrawPhases in interface ILayer
Returns:
The drawPhases
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException
Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSpatialReferenceByRef in interface ILayer
Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException
Draws the layer to the specified display for the given draw phase.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ILayer
Parameters:
drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws IOException,
                         AutomationException
Small image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSmallImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws IOException,
                                 AutomationException
Small image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSmallSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws IOException,
                         AutomationException
Large image that represents the layer.

Description

The icon used to represent the layer in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLargeImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws IOException,
                                 AutomationException
Large image that represents the layer when it is selected.

Description

The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLargeSelectedImage in interface ILayerInfo
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException
Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException
The extension at the specified index.

Product Availability

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

Specified by:
getExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException
Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addExtension in interface ILayerExtensions
Parameters:
ext - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException
Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeExtension in interface ILayerExtensions
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerWeight

public double getLayerWeight()
                      throws IOException,
                             AutomationException
Default layer position.

Description

The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.


Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayerWeight in interface ILayerPosition
Returns:
The layerWeight
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerWeight

public void setLayerWeight(double layerWeight)
                    throws IOException,
                           AutomationException
Default layer position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerWeight in interface ILayerPosition
Parameters:
layerWeight - The layerWeight (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayFilter

public void setDisplayFilter(IDisplayFilter displayFilter)
                      throws IOException,
                             AutomationException
The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayFilter in interface IDisplayFilterManager
Parameters:
displayFilter - A reference to a com.esri.arcgis.display.IDisplayFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayFilter

public IDisplayFilter getDisplayFilter()
                                throws IOException,
                                       AutomationException
The display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayFilter in interface IDisplayFilterManager
Returns:
A reference to a com.esri.arcgis.display.IDisplayFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException
Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUsesFilter in interface IDisplayAdmin
Returns:
The usesFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException
Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsTransparency in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException
Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsContrastChange in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException
Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsBrightnessChange in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSupportsInteractive in interface ILayerEffects
Parameters:
supported - The supported (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupportsInteractive in interface ILayerEffects
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException
Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTransparency in interface ILayerEffects
Returns:
The alpha
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException
Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTransparency in interface ILayerEffects
Parameters:
alpha - The alpha (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getContrast in interface ILayerEffects
Returns:
The contrastValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setContrast in interface ILayerEffects
Parameters:
contrastValue - The contrastValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBrightness in interface ILayerEffects
Returns:
The brightnessValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBrightness in interface ILayerEffects
Parameters:
brightnessValue - The brightnessValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceName

public IName getDataSourceName()
                        throws IOException,
                               AutomationException
Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDataSourceName in interface IDataLayer
Specified by:
getDataSourceName in interface IDataLayer2
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSourceName

public void setDataSourceName(IName name)
                       throws IOException,
                              AutomationException
Name of the data object for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDataSourceName in interface IDataLayer
Specified by:
setDataSourceName in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDataSourceSupported

public boolean isDataSourceSupported(IName name)
                              throws IOException,
                                     AutomationException
Indicates if the specified data object name is supported by the layer.

Product Availability

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

Specified by:
isDataSourceSupported in interface IDataLayer
Specified by:
isDataSourceSupported in interface IDataLayer2
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

connect

public boolean connect(IName pOptRepairName)
                throws IOException,
                       AutomationException
Connects the layer to its data source. An optional name object can be specified to aid in repairing a lost connection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
connect in interface IDataLayer
Specified by:
connect in interface IDataLayer2
Parameters:
pOptRepairName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The succeeded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelativeBase

public String getRelativeBase()
                       throws IOException,
                              AutomationException
Base path used when storing relative path names.

Remarks

The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRelativeBase in interface IDataLayer
Specified by:
getRelativeBase in interface IDataLayer2
Returns:
The basePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelativeBase

public void setRelativeBase(String basePath)
                     throws IOException,
                            AutomationException
Base path used when storing relative path names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRelativeBase in interface IDataLayer
Specified by:
setRelativeBase in interface IDataLayer2
Parameters:
basePath - The basePath (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws IOException,
                       AutomationException
Disconnects the data from the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
disconnect in interface IDataLayer2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inWorkspace

public boolean inWorkspace(IWorkspace workspace)
                    throws IOException,
                           AutomationException
Returns TRUE if the layer is in the specified workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
inWorkspace in interface IDataLayer2
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
The inWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLastMinimumScale

public double getLastMinimumScale()
                           throws IOException,
                                  AutomationException
Last minimum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMinimumScale in interface ILayerGeneralProperties
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastMaximumScale

public double getLastMaximumScale()
                           throws IOException,
                                  AutomationException
Last maximum scale setting used by layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLastMaximumScale in interface ILayerGeneralProperties
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

ILayerGeneralProperties_getLayerDescription

public String ILayerGeneralProperties_getLayerDescription()
                                                   throws IOException,
                                                          AutomationException
Description for the layer.

Product Availability

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

Specified by:
ILayerGeneralProperties_getLayerDescription in interface ILayerGeneralProperties
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(String text)
                         throws IOException,
                                AutomationException
Description for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLayerDescription in interface ILayerGeneralProperties
Parameters:
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws 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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onBuild

public void onBuild(ITerrainEditEventsOnBuildEvent theEvent)
             throws IOException,
                    AutomationException
This event is fired when Build is called on a Terrain.

Product Availability

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

Specified by:
onBuild in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onUndoBuild

public void onUndoBuild(ITerrainEditEventsOnUndoBuildEvent theEvent)
                 throws IOException,
                        AutomationException
This event is fired when Undo Build is called on a Terrain.

Product Availability

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

Specified by:
onUndoBuild in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onRedoBuild

public void onRedoBuild(ITerrainEditEventsOnRedoBuildEvent theEvent)
                 throws IOException,
                        AutomationException
This event is fired when Redo Build is called on a Terrain.

Product Availability

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

Specified by:
onRedoBuild in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onReconcile

public void onReconcile(ITerrainEditEventsOnReconcileEvent theEvent)
                 throws IOException,
                        AutomationException
This event is fired when Reconcile is called on a Terrain.

Product Availability

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

Specified by:
onReconcile in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onUndoReconcile

public void onUndoReconcile(ITerrainEditEventsOnUndoReconcileEvent theEvent)
                     throws IOException,
                            AutomationException
This event is fired when Undo Reconcile is called on a Terrain.

Product Availability

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

Specified by:
onUndoReconcile in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onRedoReconcile

public void onRedoReconcile(ITerrainEditEventsOnRedoReconcileEvent theEvent)
                     throws IOException,
                            AutomationException
This event is fired when Redo Reconcile is called on a Terrain.

Product Availability

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

Specified by:
onRedoReconcile in interface ITerrainEditEvents
Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException
enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException
findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

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

readExternal

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