|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.BasemapLayer
public class BasemapLayer
Layer containing a Basemap.
A basemap layer is a user-defined group of layers that are drawn continuously during navigation. BasemapLayer implements IGroupLayer, and in many ways it behaves the same as GroupLayer. BasemapLayer draws with a high-performance drawing engine that can significantly improve the display speed and responsiveness of your map. ArcMap is the primary consumer of BasemapLayer; however, the MapControl and ArcReader also have the same performance benefits when working with BasemapLayer. Components using the output pipeline of the ArcGIS 2D drawing engine, such as ArcGIS for Server and the 3D applications drawing draped content, will not see a benefit from using BasemapLayer. Optimized map services in ArcGIS for Server use the same drawing engine as BasemapLayer and should be used to achieve fast map services.
Constructor Summary | |
---|---|
BasemapLayer()
Constructs a BasemapLayer using ArcGIS Engine. |
|
BasemapLayer(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(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(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 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). |
Object |
getExtension(int index)
The extension at the specified index. |
int |
getExtensionCount()
Number of extensions. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
int |
getLargeImage()
Large image that represents the layer. |
int |
getLargeSelectedImage()
Large image that represents the layer when it is selected. |
double |
getLastMaximumScale()
Last maximum scale setting used by layer. |
double |
getLastMinimumScale()
Last minimum scale setting used by layer. |
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. |
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. |
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. |
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. |
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(ObjectInput in)
|
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(String text)
Description for the layer. |
void |
setLayerWeight(double layerWeight)
Default layer position. |
void |
setLevelMasking(ILayer maskedLayer,
ILayer maskingLayer,
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(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(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public BasemapLayer() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic BasemapLayer(Object obj) throws IOException
obj
to BasemapLayer
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
BasemapLayer theBasemapLayer = (BasemapLayer) obj;
Method Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void notifyLayerChanged(ILayer layer, int eventHint, IVariantArray eventParam) throws IOException, AutomationException
notifyLayerChanged
in interface IBasemapLayer
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getConversionStatus(ILayer layer) throws IOException, AutomationException
getConversionStatus
in interface IBasemapLayer
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBasemapSubLayer getLayerWrapper(ILayer layer) throws IOException, AutomationException
getLayerWrapper
in interface IBasemapLayer
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBasemapSubLayer findLayerWrapper(ILayer pLayer) throws IOException, AutomationException
findLayerWrapper
in interface IBasemapLayer
pLayer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean canDraw() throws IOException, AutomationException
canDraw
in interface IBasemapLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void invalidateCache() throws IOException, AutomationException
invalidateCache
in interface IBasemapLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArrayOfIShader getShaders() throws IOException, AutomationException
getShaders
in interface IBasemapLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShadersByRef(IArrayOfIShader shaders) throws IOException, AutomationException
setShadersByRef
in interface IBasemapLayer
shaders
- A reference to a com.esri.arcgis.carto.IArrayOfIShader (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void notifyMapPropertiesChanged(IMap pMap, boolean reconvertAll) throws IOException, AutomationException
notifyMapPropertiesChanged
in interface IBasemapLayer
pMap
- A reference to a com.esri.arcgis.carto.IMap (in)reconvertAll
- The reconvertAll (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean hasSufficientMemory(int numberOfAdditionalBasemapLayers) throws IOException, AutomationException
hasSufficientMemory
in interface IBasemapLayer
numberOfAdditionalBasemapLayers
- The numberOfAdditionalBasemapLayers (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
Use this property to associate a string with a layer.
getName
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String name) throws IOException, AutomationException
setName
in interface ILayer
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isValid() throws IOException, AutomationException
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.
isValid
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getAreaOfInterest() throws IOException, AutomationException
Returns the spatial-referenced extent of the layer.
getAreaOfInterest
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMinimumScale() throws IOException, AutomationException
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.
getMinimumScale
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMinimumScale(double minScale) throws IOException, AutomationException
setMinimumScale
in interface ILayer
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getMaximumScale() throws IOException, AutomationException
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.
getMaximumScale
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaximumScale(double maxScale) throws IOException, AutomationException
setMaximumScale
in interface ILayer
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isVisible() throws IOException, AutomationException
isVisible
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVisible(boolean visible) throws IOException, AutomationException
setVisible
in interface ILayer
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowTips() throws IOException, AutomationException
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.
isShowTips
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowTips(boolean show) throws IOException, AutomationException
setShowTips
in interface ILayer
show
- The show (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getTipText(double x, double y, double tolerance) throws IOException, AutomationException
getTipText
in interface ILayer
x
- The x (in)y
- The y (in)tolerance
- The tolerance (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCached() throws IOException, AutomationException
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.
isCached
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setCached(boolean cached) throws IOException, AutomationException
Informational property. Container is responsible for cache management.
setCached
in interface ILayer
cached
- The cached (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSupportedDrawPhases() throws IOException, AutomationException
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.
getSupportedDrawPhases
in interface ILayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSpatialReferenceByRef(ISpatialReference rhs1) throws IOException, AutomationException
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.
setSpatialReferenceByRef
in interface ILayer
rhs1
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void draw(int drawPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
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.
draw
in interface ILayer
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void add(ILayer layer) throws IOException, AutomationException
Adds the specified layer to the GroupLayer.
add
in interface IGroupLayer
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void delete(ILayer layer) throws IOException, AutomationException
Removes the specified Layer from the GroupLayer.
delete
in interface IGroupLayer
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clear() throws IOException, AutomationException
Removes all constituent layers from the GroupLayer.
clear
in interface IGroupLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isExpanded() throws IOException, AutomationException
Sets whether the GroupLayer is to be shown in expanded or collapsed view in the TOC.
isExpanded
in interface IGroupLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExpanded(boolean expanded) throws IOException, AutomationException
Sets whether the GroupLayer is to be shown in expanded or collapsed view in the TOC.
setExpanded
in interface IGroupLayer
expanded
- The expanded (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getCount() throws IOException, AutomationException
Returns the count, or number of layers. Use the methods in the IGroupLayer interface to manage the contents of GroupLayers.
getCount
in interface ICompositeLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILayer getLayer(int index) throws IOException, AutomationException
getLayer
in interface ICompositeLayer
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints
in interface IConnectionPointContainer
ppEnum
- A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) throws IOException, AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint
in interface IConnectionPointContainer
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallImage() throws IOException, AutomationException
The icon used to represent the layer in ArcCatalog's 'List' and 'Details' views.
getSmallImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSmallSelectedImage() throws IOException, AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'List' and 'Details' views.
getSmallSelectedImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeImage() throws IOException, AutomationException
The icon used to represent the layer in ArcCatalog's 'Large Icon' view.
getLargeImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getLargeSelectedImage() throws IOException, AutomationException
The icon used to represent the layer when it is selected in ArcCatalog's 'Large Icon' view.
getLargeSelectedImage
in interface ILayerInfo
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void expandRegionForSymbols(IDisplay pDisplay, IGeometry pRegion) throws 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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getDimPercentage() throws IOException, AutomationException
getDimPercentage
in interface ILayerEffectDIM
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDimPercentage(short dimValue) throws IOException, AutomationException
setDimPercentage
in interface ILayerEffectDIM
dimValue
- The dimValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMinimumScale() throws IOException, AutomationException
getLastMinimumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLastMaximumScale() throws IOException, AutomationException
getLastMaximumScale
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String ILayerGeneralProperties_getLayerDescription() throws IOException, AutomationException
ILayerGeneralProperties_getLayerDescription
in interface ILayerGeneralProperties
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerDescription(String text) throws IOException, AutomationException
setLayerDescription
in interface ILayerGeneralProperties
text
- The text (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getExtensionCount() throws IOException, AutomationException
getExtensionCount
in interface ILayerExtensions
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public Object getExtension(int index) throws IOException, AutomationException
getExtension
in interface ILayerExtensions
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addExtension(Object ext) throws IOException, AutomationException
addExtension
in interface ILayerExtensions
ext
- A reference to another Object (IUnknown) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void removeExtension(int index) throws IOException, AutomationException
removeExtension
in interface ILayerExtensions
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom) throws 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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IArray identify(IGeometry pGeom, ITrackCancel pTrackCancel) throws 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 IIdentify2
pGeom
- A reference to a com.esri.arcgis.geometry.IGeometry (in)pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScale(double rhs1) throws IOException, AutomationException
setScale
in interface IIdentify2
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsTransparency() throws IOException, AutomationException
isSupportsTransparency
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsContrastChange() throws IOException, AutomationException
isSupportsContrastChange
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsBrightnessChange() throws IOException, AutomationException
isSupportsBrightnessChange
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSupportsInteractive(boolean supported) throws IOException, AutomationException
setSupportsInteractive
in interface ILayerEffects
supported
- The supported (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSupportsInteractive() throws IOException, AutomationException
isSupportsInteractive
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getTransparency() throws IOException, AutomationException
When
you set Transparency for a
FeatureLayer, a
TransparencyDisplayFilter is created and applied
to the layer. You can accomplish the same effect by manually
creating a new TransparencyDisplayFilter using IDisplayFilter, and
then assigning it to a layer using
IDisplayFilterManager.
getTransparency
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTransparency(short alpha) throws IOException, AutomationException
setTransparency
in interface ILayerEffects
alpha
- The alpha (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getContrast() throws IOException, AutomationException
getContrast
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setContrast(short contrastValue) throws IOException, AutomationException
setContrast
in interface ILayerEffects
contrastValue
- The contrastValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getBrightness() throws IOException, AutomationException
getBrightness
in interface ILayerEffects
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBrightness(short brightnessValue) throws IOException, AutomationException
setBrightness
in interface ILayerEffects
brightnessValue
- The brightnessValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseMasking(boolean flag) throws IOException, AutomationException
setUseMasking
in interface ILayerMasking
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseMasking() throws IOException, AutomationException
isUseMasking
in interface ILayerMasking
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaskingLayers(ILayer layer, ISet maskingLayers) throws IOException, AutomationException
setMaskingLayers
in interface ILayerMasking
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)maskingLayers
- A reference to a com.esri.arcgis.system.ISet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISet getMaskingLayers(ILayer layer) throws IOException, AutomationException
getMaskingLayers
in interface ILayerMasking
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearMasking(ILayer layer) throws IOException, AutomationException
clearMasking
in interface ILayerMasking
layer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISet getMaskedLayers() throws IOException, AutomationException
getMaskedLayers
in interface ILayerMasking
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getLayerWeight() throws IOException, AutomationException
The LayerWeight property defines the weight of the layer in the auto arrange order. During auto arrange, the higher weight layers are added to the map first, which means they draw lower in the draw order.
Default weights for layers are these values:
Annotation layers = 97
Points layers = 98
Polyline layers = 99
Polygon Layers = 100
getLayerWeight
in interface ILayerPosition
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerWeight(double layerWeight) throws IOException, AutomationException
setLayerWeight
in interface ILayerPosition
layerWeight
- The layerWeight (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLevelMasking(ILayer maskedLayer, ILayer maskingLayer, String pLevels) throws IOException, AutomationException
setLevelMasking
in interface ILevelMasking
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getLevelMasking(ILayer maskedLayer, ILayer maskingLayer) throws IOException, AutomationException
getLevelMasking
in interface ILevelMasking
maskedLayer
- A reference to a com.esri.arcgis.carto.ILayer (in)maskingLayer
- A reference to a com.esri.arcgis.carto.ILayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUsesFilter() throws IOException, AutomationException
The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.
isUsesFilter
in interface IDisplayAdmin
isUsesFilter
in interface IDisplayAdmin2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isRequiresBanding() throws IOException, AutomationException
isRequiresBanding
in interface IDisplayAdmin2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDoesBlending() throws IOException, AutomationException
isDoesBlending
in interface IDisplayAdmin2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |