com.esri.arcgis.carto
Class BasemapLayer

java.lang.Object
  extended by com.esri.arcgis.carto.BasemapLayer
All Implemented Interfaces:
IBasemapLayer, ICompositeLayer, IGroupLayer, IIdentify, IIdentify2, ILayer, ILayerEffectDIM, ILayerEffects, ILayerExtensions, ILayerGeneralProperties, ILayerInfo, ILayerMasking, ILayerPosition, ILayerSymbologyExtents, ILevelMasking, IConnectionPointContainer, IDisplayAdmin, IDisplayAdmin2, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class BasemapLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasemapLayer, ILayer, IGroupLayer, ICompositeLayer, IPersist, IPersistStream, IConnectionPointContainer, ILayerInfo, ILayerSymbologyExtents, ILayerEffectDIM, ILayerGeneralProperties, ILayerExtensions, IIdentify, IIdentify2, ILayerEffects, ILayerMasking, ILayerPosition, ILevelMasking, IDisplayAdmin, IDisplayAdmin2, IGeoDataset, java.io.Externalizable

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

Description 'Layer containing a Basemap.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IBasemapLayer
IID, IIDf9d6aa98_5586_486f_8242_670aedf7860e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IGroupLayer
IID, IIDedad6644_1810_11d1_86ae_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer
IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerInfo
IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerSymbologyExtents
IID, IID02cbda2f_d2e8_4b28_af9c_71cb096213e1, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerEffectDIM
IID, IIDc67c6655_6540_442b_8659_a286c2bfa205, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerExtensions
IID, IIDbb6a78ca_9c28_4f75_899f_dff65174082c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IIdentify2
IID, IID0483dc2f_8726_4640_98cd_5888ff1a4fa4, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerEffects
IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerMasking
IID, IID536427da_5354_491d_ae92_abebaa8bb05b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayerPosition
IID, IIDc0dc8820_e10f_4285_aab1_6c6b685dbb84, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILevelMasking
IID, IIDa4b202d6_363f_455d_a581_c323834df4f7, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin
IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin2
IID, IIDd915ec07_7b4f_47fd_b59b_3252f3a3b610, xxDummy
 
Constructor Summary
BasemapLayer()
          Constructs a BasemapLayer using ArcGIS Engine.
BasemapLayer(java.lang.Object obj)
          Construct a BasemapLayer using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void add(ILayer layer)
          Adds a layer to the end of the group.
 void addExtension(java.lang.Object ext)
          Adds a new extension.
 boolean canDraw()
          Returns True, if the layer draws something.
 void clear()
          Removes all layers from the group.
 void clearMasking(ILayer layer)
          Clear masking layers on a layer.
 void delete(ILayer layer)
          Removes the specified layer from the group.
 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(java.lang.Object o)
          Compare this object with another
 void expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion)
          Enlarges the specified region if necessary to account for the symbology sizes.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 IBasemapSubLayer findLayerWrapper(ILayer pLayer)
          Gets the wrapper for a layer.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 short getContrast()
          Layer contrast in percent (-100 - 100).
 int getConversionStatus(ILayer layer)
          Indicates the conversion status of a given layer.
 int getCount()
          Number of layers in the collection.
 short getDimPercentage()
          Layer DIM value in percent (0 - 100).
 java.lang.Object getExtension(int index)
          The extension at the specified index.
 int getExtensionCount()
          Number of extensions.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 ILayer getLayer(int index)
          Layer in the collection at the specified index.
 double getLayerWeight()
          Default layer position.
 IBasemapSubLayer getLayerWrapper(ILayer layer)
          Gets the wrapper for a layer.
 java.lang.String getLevelMasking(ILayer maskedLayer, ILayer maskingLayer)
          The symbol levels for which the masking applies.
 ISet getMaskedLayers()
          The set of layers that are being masked.
 ISet getMaskingLayers(ILayer layer)
          The masks for a layer.
 double getMaximumScale()
          Maximum scale (representative fraction) at which the layer will display.
 double getMinimumScale()
          Minimum scale (representative fraction) at which the layer will display.
 java.lang.String getName()
          Layer name.
 IArrayOfIShader getShaders()
          Get array of pixel shaders.
 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.
 java.lang.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
 boolean hasSufficientMemory(int numberOfAdditionalBasemapLayers)
          Returns if there is sufficient memory available for the Basemap Layer.
 IArray identify(IGeometry pGeom)
          Identifies objects at the specified location.
 IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel)
          Identifies objects at the specified location.
 java.lang.String ILayerGeneralProperties_getLayerDescription()
          Description for the layer.
 void invalidateCache()
          Invalidates layer's cache.
 boolean isCached()
          Indicates if the layer needs its own display cache.
 void isDirty()
          isDirty
 boolean isDoesBlending()
          Indicates whether the drawing object blends its output with the background.
 boolean isExpanded()
          Indicates if the group's entry is expanded in the TOC.
 boolean isRequiresBanding()
          Indicates whether the output from the drawing object requires banding.
 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 isUseMasking()
          Indicates whether to use masking.
 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 notifyLayerChanged(ILayer layer, int eventHint, IVariantArray eventParam)
          Notify Base map Layer that one of its layers changed.
 void notifyMapPropertiesChanged(IMap pMap, boolean reconvertAll)
          Notify Base map Layer that the parent Map properties changed.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a BasemapLayer.
 void removeExtension(int index)
          Removes the specified extension.
 void save(IStream pstm, int fClearDirty)
          save
 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 setDimPercentage(short dimValue)
          Layer DIM value in percent (0 - 100).
 void setExpanded(boolean expanded)
          Indicates if the group's entry is expanded in the TOC.
 void setLayerDescription(java.lang.String text)
          Description for the layer.
 void setLayerWeight(double layerWeight)
          Default layer position.
 void setLevelMasking(ILayer maskedLayer, ILayer maskingLayer, java.lang.String pLevels)
          The symbol levels for which the masking applies.
 void setMaskingLayers(ILayer layer, ISet maskingLayers)
          The masks for a layer.
 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(java.lang.String name)
          Layer name.
 void setScale(double rhs1)
          The current scale of the display.
 void setShadersByRef(IArrayOfIShader shaders)
          Get array of pixel shaders.
 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 setTransparency(short alpha)
          Layer transparency in percent (0-100).
 void setUseMasking(boolean flag)
          Indicates whether to use masking.
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

BasemapLayer

public BasemapLayer()
             throws java.io.IOException,
                    java.net.UnknownHostException
Constructs a BasemapLayer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

BasemapLayer

public BasemapLayer(java.lang.Object obj)
             throws java.io.IOException
Construct a BasemapLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BasemapLayer.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems BasemapLayer theBasemapLayer = (BasemapLayer) obj;
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a BasemapLayer.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

notifyLayerChanged

public void notifyLayerChanged(ILayer layer,
                               int eventHint,
                               IVariantArray eventParam)
                        throws java.io.IOException,
                               AutomationException
Notify Base map Layer that one of its layers changed.

Specified by:
notifyLayerChanged in interface IBasemapLayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
eventHint - A com.esri.arcgis.carto.esriLayerEventHint constant (in)
eventParam - A reference to a com.esri.arcgis.system.IVariantArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConversionStatus

public int getConversionStatus(ILayer layer)
                        throws java.io.IOException,
                               AutomationException
Indicates the conversion status of a given layer.

Specified by:
getConversionStatus in interface IBasemapLayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A com.esri.arcgis.carto.esriConversionStatus constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerWrapper

public IBasemapSubLayer getLayerWrapper(ILayer layer)
                                 throws java.io.IOException,
                                        AutomationException
Gets the wrapper for a layer. Creates a new BasemapSubLayer if necessary.

Specified by:
getLayerWrapper in interface IBasemapLayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.carto.IBasemapSubLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLayerWrapper

public IBasemapSubLayer findLayerWrapper(ILayer pLayer)
                                  throws java.io.IOException,
                                         AutomationException
Gets the wrapper for a layer. Returns NULL if no BasemapSubLayer is found.

Specified by:
findLayerWrapper in interface IBasemapLayer
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.carto.IBasemapSubLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDraw

public boolean canDraw()
                throws java.io.IOException,
                       AutomationException
Returns True, if the layer draws something.

Specified by:
canDraw in interface IBasemapLayer
Returns:
The bYesNo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

invalidateCache

public void invalidateCache()
                     throws java.io.IOException,
                            AutomationException
Invalidates layer's cache.

Specified by:
invalidateCache in interface IBasemapLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShaders

public IArrayOfIShader getShaders()
                           throws java.io.IOException,
                                  AutomationException
Get array of pixel shaders.

Specified by:
getShaders in interface IBasemapLayer
Returns:
A reference to a com.esri.arcgis.carto.IArrayOfIShader
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadersByRef

public void setShadersByRef(IArrayOfIShader shaders)
                     throws java.io.IOException,
                            AutomationException
Get array of pixel shaders.

Specified by:
setShadersByRef in interface IBasemapLayer
Parameters:
shaders - A reference to a com.esri.arcgis.carto.IArrayOfIShader (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

notifyMapPropertiesChanged

public void notifyMapPropertiesChanged(IMap pMap,
                                       boolean reconvertAll)
                                throws java.io.IOException,
                                       AutomationException
Notify Base map Layer that the parent Map properties changed.

Specified by:
notifyMapPropertiesChanged in interface IBasemapLayer
Parameters:
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
reconvertAll - The reconvertAll (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasSufficientMemory

public boolean hasSufficientMemory(int numberOfAdditionalBasemapLayers)
                            throws java.io.IOException,
                                   AutomationException
Returns if there is sufficient memory available for the Basemap Layer.

Specified by:
hasSufficientMemory in interface IBasemapLayer
Parameters:
numberOfAdditionalBasemapLayers - The numberOfAdditionalBasemapLayers (in)
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

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

getAreaOfInterest

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

getMinimumScale

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

setMinimumScale

public void setMinimumScale(double minScale)
                     throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

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

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

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

setVisible

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

isShowTips

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

setShowTips

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

getTipText

public java.lang.String getTipText(double x,
                                   double y,
                                   double tolerance)
                            throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCached

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

setCached

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

getSupportedDrawPhases

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws java.io.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:
java.io.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 java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(ILayer layer)
         throws java.io.IOException,
                AutomationException
Adds a layer to the end of the group.

Specified by:
add in interface IGroupLayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete(ILayer layer)
            throws java.io.IOException,
                   AutomationException
Removes the specified layer from the group.

Specified by:
delete in interface IGroupLayer
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Removes all layers from the group.

Specified by:
clear in interface IGroupLayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpanded

public boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException
Indicates if the group's entry is expanded in the TOC.

Specified by:
isExpanded in interface IGroupLayer
Returns:
The expanded
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpanded

public void setExpanded(boolean expanded)
                 throws java.io.IOException,
                        AutomationException
Indicates if the group's entry is expanded in the TOC.

Specified by:
setExpanded in interface IGroupLayer
Parameters:
expanded - The expanded (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
Number of layers in the collection.

Specified by:
getCount in interface ICompositeLayer
Returns:
The layerCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int index)
                throws java.io.IOException,
                       AutomationException
Layer in the collection at the specified index.

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

getClassID

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

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

isDirty

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

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

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

save

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

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

getSizeMax

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

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

enumConnectionPoints

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

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

findConnectionPoint

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

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

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

getSmallSelectedImage

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

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

getLargeImage

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

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

getLargeSelectedImage

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

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

expandRegionForSymbols

public void expandRegionForSymbols(IDisplay pDisplay,
                                   IGeometry pRegion)
                            throws java.io.IOException,
                                   AutomationException
Enlarges the specified region if necessary to account for the symbology sizes.

Specified by:
expandRegionForSymbols in interface ILayerSymbologyExtents
Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pRegion - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimPercentage

public short getDimPercentage()
                       throws java.io.IOException,
                              AutomationException
Layer DIM value in percent (0 - 100).

Specified by:
getDimPercentage in interface ILayerEffectDIM
Returns:
The dimValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDimPercentage

public void setDimPercentage(short dimValue)
                      throws java.io.IOException,
                             AutomationException
Layer DIM value in percent (0 - 100).

Specified by:
setDimPercentage in interface ILayerEffectDIM
Parameters:
dimValue - The dimValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLastMinimumScale

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

getLastMaximumScale

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

ILayerGeneralProperties_getLayerDescription

public java.lang.String ILayerGeneralProperties_getLayerDescription()
                                                             throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescription

public void setLayerDescription(java.lang.String text)
                         throws java.io.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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

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

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

getExtension

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

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

addExtension

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

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

removeExtension

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

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

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException
Identifies objects at the specified location.

Remarks

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

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

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


Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
identify in interface IIdentify
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom,
                       ITrackCancel pTrackCancel)
                throws java.io.IOException,
                       AutomationException
Identifies objects at the specified location.

Specified by:
identify in interface IIdentify2
Parameters:
pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(double rhs1)
              throws java.io.IOException,
                     AutomationException
The current scale of the display.

Specified by:
setScale in interface IIdentify2
Parameters:
rhs1 - The rhs1 (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

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

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

isSupportsContrastChange

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

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

isSupportsBrightnessChange

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

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

setSupportsInteractive

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

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

isSupportsInteractive

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

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

getTransparency

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

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

setTransparency

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

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

getContrast

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

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

setContrast

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

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

getBrightness

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

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

setBrightness

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

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

setUseMasking

public void setUseMasking(boolean flag)
                   throws java.io.IOException,
                          AutomationException
Indicates whether to use masking.

Specified by:
setUseMasking in interface ILayerMasking
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseMasking

public boolean isUseMasking()
                     throws java.io.IOException,
                            AutomationException
Indicates whether to use masking.

Specified by:
isUseMasking in interface ILayerMasking
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskingLayers

public void setMaskingLayers(ILayer layer,
                             ISet maskingLayers)
                      throws java.io.IOException,
                             AutomationException
The masks for a layer.

Specified by:
setMaskingLayers in interface ILayerMasking
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayers - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskingLayers

public ISet getMaskingLayers(ILayer layer)
                      throws java.io.IOException,
                             AutomationException
The masks for a layer.

Specified by:
getMaskingLayers in interface ILayerMasking
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearMasking

public void clearMasking(ILayer layer)
                  throws java.io.IOException,
                         AutomationException
Clear masking layers on a layer.

Specified by:
clearMasking in interface ILayerMasking
Parameters:
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskedLayers

public ISet getMaskedLayers()
                     throws java.io.IOException,
                            AutomationException
The set of layers that are being masked.

Specified by:
getMaskedLayers in interface ILayerMasking
Returns:
A reference to a com.esri.arcgis.system.ISet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerWeight

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

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

setLayerWeight

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

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

setLevelMasking

public void setLevelMasking(ILayer maskedLayer,
                            ILayer maskingLayer,
                            java.lang.String pLevels)
                     throws java.io.IOException,
                            AutomationException
The symbol levels for which the masking applies.

Specified by:
setLevelMasking in interface ILevelMasking
Parameters:
maskedLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
pLevels - The pLevels (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLevelMasking

public java.lang.String getLevelMasking(ILayer maskedLayer,
                                        ILayer maskingLayer)
                                 throws java.io.IOException,
                                        AutomationException
The symbol levels for which the masking applies.

Specified by:
getLevelMasking in interface ILevelMasking
Parameters:
maskedLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
maskingLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The pLevels
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesFilter

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

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

isRequiresBanding

public boolean isRequiresBanding()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the output from the drawing object requires banding. Generally this is true if the output is raster.

Specified by:
isRequiresBanding in interface IDisplayAdmin2
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDoesBlending

public boolean isDoesBlending()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the drawing object blends its output with the background. For example, if the object is transparent, the background becomes part of its rendering.

Specified by:
isDoesBlending in interface IDisplayAdmin2
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

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

getExtent

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

writeExternal

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

readExternal

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