|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.carto.TerrainLayer
public class TerrainLayer
The Terrain Layer class.
Constructor Summary | |
---|---|
TerrainLayer()
Constructs a TerrainLayer using ArcGIS Engine. |
|
TerrainLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TerrainLayer theTerrainLayer = (TerrainLayer) obj; |
Method Summary | |
---|---|
void |
addExtension(Object ext)
Adds a new extension. |
void |
addRenderer(ITinRenderer pRenderer)
Add a renderer to the end of the group. |
void |
afterDraw(int viewPhase,
IDisplay display,
ITrackCancel trackCancel)
Executes after the layer drawn to the display for the given draw phase. |
void |
beforeDraw(int viewPhase,
IDisplay display,
ITrackCancel trackCancel)
Executes before the layer draws to the display for the given draw phase. |
void |
clearRenderers()
Remove all the renderers from the group. |
boolean |
connect(IName pOptRepairName)
Connects the layer to its data source. |
void |
deleteRenderer(ITinRenderer pRenderer)
Remove a renderer from the group. |
void |
disconnect()
Disconnects the data from the layer. |
void |
draw(int drawPhase,
IDisplay display,
ITrackCancel trackCancel)
Draws the layer to the specified display for the given draw phase. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
int |
findField(String fieldName)
Returns the index of the field with the specified name. |
double |
getAnalysisToolsResolution()
Indicates the resolution that analysis tools will be enabled. |
IEnvelope |
getAreaOfInterest()
The default area of interest for the layer. |
short |
getBrightness()
Layer brightness in percent (-100 - 100). |
void |
getClassID(GUID[] pClassID)
getClassID |
static String |
getClsid()
getClsid. |
short |
getContrast()
Layer contrast in percent (-100 - 100). |
double |
getCurrentResolution()
Indicates the current resolution. |
ISurface |
getCurrentSurface()
Gets current surface. |
IName |
getDataSourceName()
Name of the data object for the layer. |
String |
getDisplayField()
The primary display field. |
IDisplayFilter |
getDisplayFilter()
The display filter. |
Object |
getExtension(int index)
The extension at the specified index. |
int |
getExtensionCount()
Number of extensions. |
IEnvelope |
getExtent()
The extent of the GeoDataset. |
IField |
getField(int index)
The field at the specified index. |
int |
getFieldCount()
The number of fields. |
IFieldInfo |
getFieldInfo(int index)
Extended field information for the field at the specified index. |
int |
getLargeImage()
Large image that represents the layer. |
int |
getLargeSelectedImage()
Large image that represents the layer when it is selected. |
double |
getLastMaximumScale()
Last maximum scale setting used by layer. |
double |
getLastMinimumScale()
Last minimum scale setting used by layer. |
double |
getLayerWeight()
Default layer position. |
ILegendGroup |
getLegendGroup(int index)
Legend group at the specified index. |
int |
getLegendGroupCount()
Number of legend groups contained by the object. |
ILegendItem |
getLegendItem()
Optional. |
double |
getMaximumScale()
Maximum scale (representative fraction) at which the layer will display. |
double |
getMinimumScale()
Minimum scale (representative fraction) at which the layer will display. |
String |
getName()
Layer name. |
int |
getPointBudget()
Indicates the Point Budget. |
String |
getRelativeBase()
Base path used when storing relative path names. |
ITinRenderer |
getRenderer(int index)
Gets the nth renderer. |
int |
getRendererCount()
The number of renderers. |
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax |
int |
getSmallImage()
Small image that represents the layer. |
int |
getSmallSelectedImage()
Small image that represents the layer when it is selected. |
ISpatialReference |
getSpatialReference()
The spatial reference of the GeoDataset. |
int |
getSupportedDrawPhases()
Supported draw phases. |
double |
getTargetResolution()
Indicates the resolution to be used when AutoLOR is false. |
ITerrain |
getTerrain()
The Terrain used to define the layer. |
String |
getTipText(double x,
double y,
double tolerance)
Map tip text at the specified location. |
short |
getTransparency()
Layer transparency in percent (0-100). |
int |
hashCode()
the hashcode for this object |
IArray |
identify(IGeometry pGeom)
Identifies objects at the specified location. |
String |
ILayerGeneralProperties_getLayerDescription()
Description for the layer. |
void |
insertRenderer(ITinRenderer pRenderer,
int index)
Insert a renderer at given index. |
boolean |
inWorkspace(IWorkspace workspace)
Returns TRUE if the layer is in the specified workspace. |
boolean |
isAutoLOR()
Indicates if LOR should be updated when scale changed. |
boolean |
isCached()
Indicates if the layer needs its own display cache. |
boolean |
isDataSourceSupported(IName name)
Indicates if the specified data object name is supported by the layer. |
void |
isDirty()
isDirty |
boolean |
isLockCurrentSurface()
Indicates if current surface should be updated based on scale change. |
boolean |
isMaintainCurrentSurface()
Indicates if CurrentSurface should be maintained even if layer is invisible, or there is no surface renderer. |
boolean |
isPyramidHonored()
Indicates if current surface resolution honors the scale/resolution relationship in the pyramin definition. |
boolean |
isScaleSymbols()
Indicates if symbols are scaled for this layer. |
boolean |
isShowResolution()
Indicates if TOC should display resolution. |
boolean |
isShowTips()
Indicates if the layer shows map tips. |
boolean |
isSupportsBrightnessChange()
Indicates if the layer supports brightness changes. |
boolean |
isSupportsContrastChange()
Indicates if the layer supports contrast changes. |
boolean |
isSupportsInteractive()
Indicates if the layer supports interactive effects changes. |
boolean |
isSupportsTransparency()
Indicates if the layer supports transparency. |
boolean |
isSymbolsAreGraduated()
Indicates if symbols are graduated. |
boolean |
isUseOverviewTerrain()
Indicates if Overview Terrain should be used when zoom to full. |
boolean |
isUsePointBudget()
Indicates if Point Budget should be used for rendering performance. |
boolean |
isUsesFilter()
Indicates if the current object draws using a filter. |
boolean |
isValid()
Indicates if the layer is currently valid. |
boolean |
isVisible()
Indicates if the layer is currently visible. |
void |
load(IStream pstm)
load |
void |
onBuild(ITerrainEditEventsOnBuildEvent theEvent)
This event is fired when Build is called on a Terrain. |
void |
onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent)
This event is fired when a dataset is created. |
void |
onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent)
This event is fired when a dataset is deleted. |
void |
onModifyDataset(IWorkspaceEvents2OnModifyDatasetEvent theEvent)
This event is fired when a dataset is modified. |
void |
onReconcile(ITerrainEditEventsOnReconcileEvent theEvent)
This event is fired when Reconcile is called on a Terrain. |
void |
onRedoBuild(ITerrainEditEventsOnRedoBuildEvent theEvent)
This event is fired when Redo Build is called on a Terrain. |
void |
onRedoReconcile(ITerrainEditEventsOnRedoReconcileEvent theEvent)
This event is fired when Redo Reconcile is called on a Terrain. |
void |
onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent)
This event is fired when a dataset is renamed. |
void |
onUndoBuild(ITerrainEditEventsOnUndoBuildEvent theEvent)
This event is fired when Undo Build is called on a Terrain. |
void |
onUndoReconcile(ITerrainEditEventsOnUndoReconcileEvent theEvent)
This event is fired when Undo Reconcile is called on a Terrain. |
void |
readExternal(ObjectInput in)
|
void |
removeExtension(int index)
Removes the specified extension. |
void |
save(IStream pstm,
int fClearDirty)
save |
void |
setAnalysisToolsResolution(double pAnalysisResolution)
Indicates the resolution that analysis tools will be enabled. |
void |
setAutoLOR(boolean pbAutoLOR)
Indicates if LOR should be updated when scale changed. |
void |
setBrightness(short brightnessValue)
Layer brightness in percent (-100 - 100). |
void |
setCached(boolean cached)
Indicates if the layer needs its own display cache. |
void |
setContrast(short contrastValue)
Layer contrast in percent (-100 - 100). |
void |
setDataSourceName(IName name)
Name of the data object for the layer. |
void |
setDisplayField(String pFieldName)
The primary display field. |
void |
setDisplayFilter(IDisplayFilter displayFilter)
The display filter. |
void |
setLayerDescription(String text)
Description for the layer. |
void |
setLayerWeight(double layerWeight)
Default layer position. |
void |
setLockCurrentSurface(boolean pbLock)
Indicates if current surface should be updated based on scale change. |
void |
setMaintainCurrentSurface(boolean pbMaintainSurface)
Indicates if CurrentSurface should be maintained even if layer is invisible, or there is no surface renderer. |
void |
setMaximumScale(double maxScale)
Maximum scale (representative fraction) at which the layer will display. |
void |
setMinimumScale(double minScale)
Minimum scale (representative fraction) at which the layer will display. |
void |
setName(String name)
Layer name. |
void |
setPointBudget(int pPointBudget)
Indicates the Point Budget. |
void |
setRelativeBase(String basePath)
Base path used when storing relative path names. |
void |
setScaleSymbols(boolean pbScale)
Indicates if symbols are scaled for this layer. |
void |
setShowResolution(boolean pbShow)
Indicates if TOC should display resolution. |
void |
setShowTips(boolean show)
Indicates if the layer shows map tips. |
void |
setSpatialReferenceByRef(ISpatialReference rhs1)
Spatial reference for the layer. |
void |
setSupportsInteractive(boolean supported)
Indicates if the layer supports interactive effects changes. |
void |
setSymbolsAreGraduated(boolean symbolsAreGraduated)
Indicates if symbols are graduated. |
void |
setTargetResolution(double pResolution)
Indicates the resolution to be used when AutoLOR is false. |
void |
setTerrainByRef(ITerrain ppTerrain)
The Terrain used to define the layer. |
void |
setTransparency(short alpha)
Layer transparency in percent (0-100). |
void |
setUseOverviewTerrain(boolean pbUseOverviewTerrain)
Indicates if Overview Terrain should be used when zoom to full. |
void |
setUsePointBudget(boolean pbUsePointBudget)
Indicates if Point Budget should be used for rendering performance. |
void |
setVisible(boolean visible)
Indicates if the layer is currently visible. |
void |
writeExternal(ObjectOutput out)
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public TerrainLayer() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic TerrainLayer(Object obj) throws IOException
TerrainLayer theTerrainLayer = (TerrainLayer) obj;
obj
to TerrainLayer
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
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 ITerrain getTerrain() throws IOException, AutomationException
getTerrain
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTerrainByRef(ITerrain ppTerrain) throws IOException, AutomationException
setTerrainByRef
in interface ITerrainLayer
ppTerrain
- A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISurface getCurrentSurface() throws IOException, AutomationException
GetCurrentSurface may return a NULL pointer ('Nothing' in VB). For example, it will return NULL if ITerrain.IsValid is FALSE. Therefore, check the return value before attempting to use it.
getCurrentSurface
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getRendererCount() throws IOException, AutomationException
getRendererCount
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITinRenderer getRenderer(int index) throws IOException, AutomationException
getRenderer
in interface ITerrainLayer
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void addRenderer(ITinRenderer pRenderer) throws IOException, AutomationException
addRenderer
in interface ITerrainLayer
pRenderer
- A reference to a com.esri.arcgis.carto.ITinRenderer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void insertRenderer(ITinRenderer pRenderer, int index) throws IOException, AutomationException
insertRenderer
in interface ITerrainLayer
pRenderer
- A reference to a com.esri.arcgis.carto.ITinRenderer (in)index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deleteRenderer(ITinRenderer pRenderer) throws IOException, AutomationException
deleteRenderer
in interface ITerrainLayer
pRenderer
- A reference to a com.esri.arcgis.carto.ITinRenderer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void clearRenderers() throws IOException, AutomationException
clearRenderers
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getDisplayField() throws IOException, AutomationException
getDisplayField
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDisplayField(String pFieldName) throws IOException, AutomationException
setDisplayField
in interface ITerrainLayer
pFieldName
- The pFieldName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isScaleSymbols() throws IOException, AutomationException
isScaleSymbols
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setScaleSymbols(boolean pbScale) throws IOException, AutomationException
setScaleSymbols
in interface ITerrainLayer
pbScale
- The pbScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseOverviewTerrain() throws IOException, AutomationException
isUseOverviewTerrain
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseOverviewTerrain(boolean pbUseOverviewTerrain) throws IOException, AutomationException
setUseOverviewTerrain
in interface ITerrainLayer
pbUseOverviewTerrain
- The pbUseOverviewTerrain (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isAutoLOR() throws IOException, AutomationException
isAutoLOR
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAutoLOR(boolean pbAutoLOR) throws IOException, AutomationException
setAutoLOR
in interface ITerrainLayer
pbAutoLOR
- The pbAutoLOR (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isPyramidHonored() throws IOException, AutomationException
isPyramidHonored
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getTargetResolution() throws IOException, AutomationException
getTargetResolution
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTargetResolution(double pResolution) throws IOException, AutomationException
setTargetResolution
in interface ITerrainLayer
pResolution
- The pResolution (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getCurrentResolution() throws IOException, AutomationException
getCurrentResolution
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isShowResolution() throws IOException, AutomationException
isShowResolution
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setShowResolution(boolean pbShow) throws IOException, AutomationException
setShowResolution
in interface ITerrainLayer
pbShow
- The pbShow (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isLockCurrentSurface() throws IOException, AutomationException
isLockCurrentSurface
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLockCurrentSurface(boolean pbLock) throws IOException, AutomationException
setLockCurrentSurface
in interface ITerrainLayer
pbLock
- The pbLock (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUsePointBudget() throws IOException, AutomationException
isUsePointBudget
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUsePointBudget(boolean pbUsePointBudget) throws IOException, AutomationException
setUsePointBudget
in interface ITerrainLayer
pbUsePointBudget
- The pbUsePointBudget (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getPointBudget() throws IOException, AutomationException
getPointBudget
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPointBudget(int pPointBudget) throws IOException, AutomationException
setPointBudget
in interface ITerrainLayer
pPointBudget
- The pPointBudget (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getAnalysisToolsResolution() throws IOException, AutomationException
getAnalysisToolsResolution
in interface ITerrainLayer
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAnalysisToolsResolution(double pAnalysisResolution) throws IOException, AutomationException
setAnalysisToolsResolution
in interface ITerrainLayer
pAnalysisResolution
- The pAnalysisResolution (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 boolean isMaintainCurrentSurface() throws IOException, AutomationException
isMaintainCurrentSurface
in interface ITerrainLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMaintainCurrentSurface(boolean pbMaintainSurface) throws IOException, AutomationException
setMaintainCurrentSurface
in interface ITerrainLayer2
pbMaintainSurface
- The pbMaintainSurface (in)
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 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 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 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 setDisplayFilter(IDisplayFilter displayFilter) throws IOException, AutomationException
setDisplayFilter
in interface IDisplayFilterManager
displayFilter
- A reference to a com.esri.arcgis.display.IDisplayFilter (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDisplayFilter getDisplayFilter() throws IOException, AutomationException
getDisplayFilter
in interface IDisplayFilterManager
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
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 IName getDataSourceName() throws IOException, AutomationException
getDataSourceName
in interface IDataLayer
getDataSourceName
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDataSourceName(IName name) throws IOException, AutomationException
setDataSourceName
in interface IDataLayer
setDataSourceName
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataSourceSupported(IName name) throws IOException, AutomationException
isDataSourceSupported
in interface IDataLayer
isDataSourceSupported
in interface IDataLayer2
name
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean connect(IName pOptRepairName) throws IOException, AutomationException
connect
in interface IDataLayer
connect
in interface IDataLayer2
pOptRepairName
- A reference to a com.esri.arcgis.system.IName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getRelativeBase() throws IOException, AutomationException
The RelativeBase property is used internally when persisting and loading documents with a relative path. When a document has been fully loaded the path is realized to a complete path.
getRelativeBase
in interface IDataLayer
getRelativeBase
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRelativeBase(String basePath) throws IOException, AutomationException
setRelativeBase
in interface IDataLayer
setRelativeBase
in interface IDataLayer2
basePath
- The basePath (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void disconnect() throws IOException, AutomationException
disconnect
in interface IDataLayer2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean inWorkspace(IWorkspace workspace) throws IOException, AutomationException
inWorkspace
in interface IDataLayer2
workspace
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void beforeDraw(int viewPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
beforeDraw
in interface ILayerDrawSetup
viewPhase
- A com.esri.arcgis.carto.esriViewDrawPhase 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 afterDraw(int viewPhase, IDisplay display, ITrackCancel trackCancel) throws IOException, AutomationException
afterDraw
in interface ILayerDrawSetup
viewPhase
- A com.esri.arcgis.carto.esriViewDrawPhase 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 onModifyDataset(IWorkspaceEvents2OnModifyDatasetEvent theEvent) throws IOException, AutomationException
onModifyDataset
in interface IWorkspaceEvents2
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onCreateDataset(IWorkspaceEventsOnCreateDatasetEvent theEvent) throws IOException, AutomationException
The OnCreateDataset method is fired after a dataset has been created.
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onRenameDataset(IWorkspaceEventsOnRenameDatasetEvent theEvent) throws IOException, AutomationException
The OnRenameDataset method is fired after a dataset has been renamed.
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onDeleteDataset(IWorkspaceEventsOnDeleteDatasetEvent theEvent) throws IOException, AutomationException
The OnDeleteDataset method is fired after a dataset has been created.
theEvent
- The event
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 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 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 getLegendGroupCount() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendGroup getLegendGroup(int index) throws IOException, AutomationException
getLegendGroup
in interface ILegendInfo
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILegendItem getLegendItem() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isSymbolsAreGraduated() throws 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
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSymbolsAreGraduated(boolean symbolsAreGraduated) throws IOException, AutomationException
setSymbolsAreGraduated
in interface ILegendInfo
symbolsAreGraduated
- The symbolsAreGraduated (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onBuild(ITerrainEditEventsOnBuildEvent theEvent) throws IOException, AutomationException
onBuild
in interface ITerrainEditEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onUndoBuild(ITerrainEditEventsOnUndoBuildEvent theEvent) throws IOException, AutomationException
onUndoBuild
in interface ITerrainEditEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onRedoBuild(ITerrainEditEventsOnRedoBuildEvent theEvent) throws IOException, AutomationException
onRedoBuild
in interface ITerrainEditEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onReconcile(ITerrainEditEventsOnReconcileEvent theEvent) throws IOException, AutomationException
onReconcile
in interface ITerrainEditEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onUndoReconcile(ITerrainEditEventsOnUndoReconcileEvent theEvent) throws IOException, AutomationException
onUndoReconcile
in interface ITerrainEditEvents
theEvent
- The event
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void onRedoReconcile(ITerrainEditEventsOnRedoReconcileEvent theEvent) throws IOException, AutomationException
onRedoReconcile
in interface ITerrainEditEvents
theEvent
- The event
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 getFieldCount() throws IOException, AutomationException
getFieldCount
in interface ILayerFields
getFieldCount
in interface ITableFields
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IField getField(int index) throws IOException, AutomationException
getField
in interface ILayerFields
getField
in interface ITableFields
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFieldInfo getFieldInfo(int index) throws IOException, AutomationException
getFieldInfo
in interface ILayerFields
getFieldInfo
in interface ITableFields
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int findField(String fieldName) throws IOException, AutomationException
findField
in interface ILayerFields
findField
in interface ITableFields
fieldName
- The fieldName (in)
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 |