|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.BasemapSubLayer
public class BasemapSubLayer
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 =
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 |
---|
public BasemapSubLayer(java.lang.Object obj) throws java.io.IOException
obj
to BasemapSubLayer
. *
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
java.io.IOException
- if there are interop problems
BasemapSubLayer theBasemapSubLayer = (BasemapSubLayer) obj;
Method Detail |
---|
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public ILayer getLayer() throws java.io.IOException, AutomationException
getLayer
in interface IBasemapSubLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getConversionStatus() throws java.io.IOException, AutomationException
getConversionStatus
in interface IBasemapSubLayer
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws java.io.IOException, AutomationException
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.
getSpatialReference
in interface IGeoDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws java.io.IOException, AutomationException
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.
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.
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.
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.
getExtent
in interface IGeoDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws java.io.IOException, AutomationException
getCount
in interface ICompositeLayer
getCount
in interface ICompositeLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayer getLayer(int index) throws java.io.IOException, AutomationException
getLayer
in interface ICompositeLayer
getLayer
in interface ICompositeLayer2
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isExpanded() throws java.io.IOException, AutomationException
isExpanded
in interface ICompositeLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExpanded(boolean expanded) throws java.io.IOException, AutomationException
setExpanded
in interface ICompositeLayer2
expanded
- The expanded (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMinimumScale() throws java.io.IOException, AutomationException
getLastMinimumScale
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMaximumScale() throws java.io.IOException, AutomationException
getLastMaximumScale
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String ILayerGeneralProperties_getLayerDescription() throws java.io.IOException, AutomationException
ILayerGeneralProperties_getLayerDescription
in interface ILayerGeneralProperties
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescription(java.lang.String text) throws java.io.IOException, AutomationException
setLayerDescription
in interface ILayerGeneralProperties
text
- The text (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLegendGroupCount() throws java.io.IOException, AutomationException
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.
getLegendGroupCount
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendGroup getLegendGroup(int index) throws java.io.IOException, AutomationException
getLegendGroup
in interface ILegendInfo
index
- The index (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendItem getLegendItem() throws java.io.IOException, AutomationException
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.
getLegendItem
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSymbolsAreGraduated() throws java.io.IOException, AutomationException
Indicates whether the symbols used for a layer or renderer's legend vary by size.
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.
isSymbolsAreGraduated
in interface ILegendInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSymbolsAreGraduated(boolean symbolsAreGraduated) throws java.io.IOException, AutomationException
setSymbolsAreGraduated
in interface ILegendInfo
symbolsAreGraduated
- The symbolsAreGraduated (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom) throws java.io.IOException, AutomationException
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.
identify
in interface IIdentify
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel) throws java.io.IOException, AutomationException
identify
in interface IIdentify2
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScale(double rhs1) throws java.io.IOException, AutomationException
setScale
in interface IIdentify2
rhs1
- The rhs1 (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName getDataSourceName() throws java.io.IOException, AutomationException
getDataSourceName
in interface IDataLayer
getDataSourceName
in interface IDataLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataSourceName(IName name) throws java.io.IOException, AutomationException
setDataSourceName
in interface IDataLayer
setDataSourceName
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataSourceSupported(IName name) throws java.io.IOException, AutomationException
isDataSourceSupported
in interface IDataLayer
isDataSourceSupported
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean connect(IName pOptRepairName) throws java.io.IOException, AutomationException
connect
in interface IDataLayer
connect
in interface IDataLayer2
pOptRepairName
- A reference to a com.esri.arcgis.system.IName (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getRelativeBase() throws java.io.IOException, AutomationException
getRelativeBase
in interface IDataLayer
getRelativeBase
in interface IDataLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelativeBase(java.lang.String basePath) throws java.io.IOException, AutomationException
setRelativeBase
in interface IDataLayer
setRelativeBase
in interface IDataLayer2
basePath
- The basePath (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disconnect() throws java.io.IOException, AutomationException
disconnect
in interface IDataLayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean inWorkspace(IWorkspace workspace) throws java.io.IOException, AutomationException
inWorkspace
in interface IDataLayer2
workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) throws java.io.IOException, AutomationException
expandRegionForSymbols
in interface ILayerSymbologyExtents
pDisplay
- A reference to a com.esri.arcgis.display.IDisplay (in)pRegion
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallImage() throws java.io.IOException, AutomationException
getSmallImage
in interface ILayerInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallSelectedImage() throws java.io.IOException, AutomationException
getSmallSelectedImage
in interface ILayerInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeImage() throws java.io.IOException, AutomationException
getLargeImage
in interface ILayerInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeSelectedImage() throws java.io.IOException, AutomationException
getLargeSelectedImage
in interface ILayerInfo
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(java.lang.String name) throws java.io.IOException, AutomationException
setName
in interface ILayer2
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws java.io.IOException, AutomationException
isValid
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws java.io.IOException, AutomationException
getAreaOfInterest
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws java.io.IOException, AutomationException
getMinimumScale
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws java.io.IOException, AutomationException
setMinimumScale
in interface ILayer2
minScale
- The minScale (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws java.io.IOException, AutomationException
getMaximumScale
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws java.io.IOException, AutomationException
setMaximumScale
in interface ILayer2
maxScale
- The maxScale (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws java.io.IOException, AutomationException
isVisible
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws java.io.IOException, AutomationException
setVisible
in interface ILayer2
visible
- The visible (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws java.io.IOException, AutomationException
isShowTips
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws java.io.IOException, AutomationException
setShowTips
in interface ILayer2
show
- The show (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getTipText(double x, double y, double tolerance) throws java.io.IOException, AutomationException
getTipText
in interface ILayer2
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws java.io.IOException, AutomationException
isCached
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws java.io.IOException, AutomationException
setCached
in interface ILayer2
cached
- The cached (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws java.io.IOException, AutomationException
getSupportedDrawPhases
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws java.io.IOException, AutomationException
setSpatialReferenceByRef
in interface ILayer2
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws java.io.IOException, AutomationException
draw
in interface ILayer2
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleRangeReadOnly() throws java.io.IOException, AutomationException
isScaleRangeReadOnly
in interface ILayer2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAreaOfInterest(IEnvelope aoi) throws java.io.IOException, AutomationException
setAreaOfInterest
in interface ILayer2
aoi
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |