com.esri.arcgis.carto
Class BasemapSubLayer

java.lang.Object
  extended by com.esri.arcgis.carto.BasemapSubLayer
All Implemented Interfaces:
IBasemapSubLayer, ICompositeLayer, ICompositeLayer2, IDataLayer, IDataLayer2, IIdentify, IIdentify2, ILayer2, ILayerGeneralProperties, ILayerInfo, ILayerSymbologyExtents, ILegendInfo, IGeoDataset, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class BasemapSubLayer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBasemapSubLayer, IGeoDataset, ICompositeLayer, ICompositeLayer2, ILayerGeneralProperties, ILegendInfo, IIdentify, IIdentify2, IDataLayer, IDataLayer2, ILayerSymbologyExtents, ILayerInfo, ILayer2

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

Description 'Wrapper for layers in the 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
 
Fields inherited from interface com.esri.arcgis.carto.IBasemapSubLayer
IID, IID573411b2_f451_4dd9_ae6d_36ea6c9e77d3, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer
IID, IIDba119bc4_939a_11d2_a2f4_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ICompositeLayer2
IID, IID88130d17_5762_453a_96cf_8e7503fa1aa0, 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.IDataLayer
IID, IID6ca416b1_e160_11d2_9f4e_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataLayer2
IID, IIDe9d11f65_6936_4408_b69f_d91552eb9c4a, 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.ILayerInfo
IID, IID274419e1_0f5c_11d3_9bfd_00c04f5b951e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILayer2
IID, IID599dee2e_2182_4e54_8a86_725145c9d989, xxDummy
 
Constructor Summary
BasemapSubLayer(java.lang.Object obj)
          Construct a BasemapSubLayer using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean connect(IName pOptRepairName)
          Connects the layer to its data source.
 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.
 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.
 IEnvelope getAreaOfInterest()
          The default area of interest for the layer.
 int getConversionStatus()
          Indicates the conversion status of a given layer.
 int getCount()
          Number of layers in the collection.
 IName getDataSourceName()
          Name of the data object for the layer.
 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()
          Gets the contained layer.
 ILayer getLayer(int index)
          Layer in the collection at the specified index.
 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.
 java.lang.String getName()
          Layer name.
 java.lang.String getRelativeBase()
          Base path used when storing relative path names.
 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.
 int hashCode()
          the hashcode for this object
 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.
 boolean inWorkspace(IWorkspace workspace)
          Returns TRUE if the layer is in the specified workspace.
 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.
 boolean isExpanded()
          Indicates if the layer is expanded in the TOC.
 boolean isScaleRangeReadOnly()
          Indicates if the minimum and maximum scale range values are read-only.
 boolean isShowTips()
          Indicates if the layer shows map tips.
 boolean isSymbolsAreGraduated()
          Indicates if symbols are graduated.
 boolean isValid()
          Indicates if the layer is currently valid.
 boolean isVisible()
          Indicates if the layer is currently visible.
 void release()
          Release a BasemapSubLayer.
 void setAreaOfInterest(IEnvelope aoi)
          The default area of interest for the layer.
 void setCached(boolean cached)
          Indicates if the layer needs its own display cache.
 void setDataSourceName(IName name)
          Name of the data object for the layer.
 void setExpanded(boolean expanded)
          Indicates if the layer is expanded in the TOC.
 void setLayerDescription(java.lang.String text)
          Description for the 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 setRelativeBase(java.lang.String basePath)
          Base path used when storing relative path names.
 void setScale(double rhs1)
          The current scale of the display.
 void setShowTips(boolean show)
          Indicates if the layer shows map tips.
 void setSpatialReferenceByRef(ISpatialReference rhs1)
          Spatial reference for the layer.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setVisible(boolean visible)
          Indicates if the layer is currently visible.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasemapSubLayer

public BasemapSubLayer(java.lang.Object obj)
                throws java.io.IOException
Construct a BasemapSubLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BasemapSubLayer.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
BasemapSubLayer o = (BasemapSubLayer)obj; // will not work

BasemapSubLayer o = new BasemapSubLayer(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems BasemapSubLayer theBasemapSubLayer = (BasemapSubLayer) obj;
Method Detail

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

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

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException
Gets the contained layer.

Specified by:
getLayer in interface IBasemapSubLayer
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.

getConversionStatus

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

Specified by:
getConversionStatus in interface IBasemapSubLayer
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.

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.

getCount

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

Specified by:
getCount in interface ICompositeLayer
Specified by:
getCount in interface ICompositeLayer2
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
Specified by:
getLayer in interface ICompositeLayer2
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.

isExpanded

public boolean isExpanded()
                   throws java.io.IOException,
                          AutomationException
Indicates if the layer is expanded in the TOC.

Specified by:
isExpanded in interface ICompositeLayer2
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 layer is expanded in the TOC.

Specified by:
setExpanded in interface ICompositeLayer2
Parameters:
expanded - The expanded (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.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.IOException,
                               AutomationException
Number of legend groups contained by the object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.IOException,
                                   AutomationException
Legend group at the specified index.

Product Availability

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

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

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.IOException,
                                 AutomationException
Optional. Defines legend formatting for layer rendered with this object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.IOException,
                                     AutomationException
Indicates if symbols are graduated.

Description

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

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.IOException,
                                   AutomationException
Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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.

getDataSourceName

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

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

setDataSourceName

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

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

isDataSourceSupported

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

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

connect

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

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

getRelativeBase

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

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

setRelativeBase

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

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

disconnect

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

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

inWorkspace

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

Specified by:
inWorkspace in interface IDataLayer2
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
The inWorkspace
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.

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.

getName

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

Specified by:
getName in interface ILayer2
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.

Specified by:
setName in interface ILayer2
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.

Specified by:
isValid in interface ILayer2
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.

Specified by:
getAreaOfInterest in interface ILayer2
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.

Specified by:
getMinimumScale in interface ILayer2
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.

Specified by:
setMinimumScale in interface ILayer2
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.

Specified by:
getMaximumScale in interface ILayer2
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.

Specified by:
setMaximumScale in interface ILayer2
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.

Specified by:
isVisible in interface ILayer2
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.

Specified by:
setVisible in interface ILayer2
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.

Specified by:
isShowTips in interface ILayer2
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.

Specified by:
setShowTips in interface ILayer2
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.

Specified by:
getTipText in interface ILayer2
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.

Specified by:
isCached in interface ILayer2
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.

Specified by:
setCached in interface ILayer2
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.

Specified by:
getSupportedDrawPhases in interface ILayer2
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.

Specified by:
setSpatialReferenceByRef in interface ILayer2
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.

Specified by:
draw in interface ILayer2
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.

isScaleRangeReadOnly

public boolean isScaleRangeReadOnly()
                             throws java.io.IOException,
                                    AutomationException
Indicates if the minimum and maximum scale range values are read-only.

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

setAreaOfInterest

public void setAreaOfInterest(IEnvelope aoi)
                       throws java.io.IOException,
                              AutomationException
The default area of interest for the layer.

Specified by:
setAreaOfInterest in interface ILayer2
Parameters:
aoi - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.