|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IMap
COM Interface 'IMap'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'
Description: 'Provides access to members that control the map.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
| Field Summary | |
|---|---|
static java.lang.String |
IID
Deprecated. Internal use only |
static int |
IIDe6bdaa75_4d35_11d0_98be_00805f7ced21
|
static int |
xxDummy
Deprecated. Internal use only |
| Method Summary | |
|---|---|
void |
addLayer(ILayer layer)
Adds a layer to the map. |
void |
addLayers(IEnumLayer layers,
boolean autoArrange)
Adds multiple layers to the map, arranging them nicely if specified. |
void |
addMapSurround(IMapSurround mapSurround)
Adds a map surround to the map. |
void |
clearLayers()
Removes all layers from the map. |
void |
clearMapSurrounds()
Removes all map surrounds from the map. |
void |
clearSelection()
Clears the map selection. |
double |
computeDistance(IPoint p1,
IPoint p2)
Computes the distance between two points on the map and returns the result. |
IMapSurround |
createMapSurround(IUID cLSID,
IMapSurround optionalStyle)
Create and initialize a map surround. |
void |
delayDrawing(boolean delay)
Suspends drawing. |
void |
delayEvents(boolean delay)
Used to batch operations together to minimize notifications. |
void |
deleteLayer(ILayer layer)
Deletes a layer from the map. |
void |
deleteMapSurround(IMapSurround mapSurround)
Deletes a map surround from the map. |
ILayer |
getActiveGraphicsLayer()
The active graphics layer. |
IAnnotateMap |
getAnnotationEngine()
The annotation (label) engine the map will use. |
IBarrierCollection |
getBarriers(IEnvelope pExtent)
The list of barriers and their weight for labeling. |
IGraphicsLayer |
getBasicGraphicsLayer()
The basic graphics layer. |
IBorder |
getClipBorder()
An optional border drawn around ClipGeometry. |
IGeometry |
getClipGeometry()
A shape that layers in the map are clipped to. |
java.lang.String |
getDescription()
Description of the map. |
int |
getDistanceUnits()
The distance units for the map. |
ISelection |
getFeatureSelection()
The feature selection for the map. |
ILayer |
getLayer(int index)
The layer at the given index. |
int |
getLayerCount()
Number of layers in the map. |
IEnumLayer |
getLayers(IUID uid,
boolean recursive)
The layers in the map of the type specified in the uid. |
double |
getMapScale()
The scale of the map as a representative fraction. |
IMapSurround |
getMapSurround(int index)
The map surround at the given index. |
int |
getMapSurroundCount()
Number of map surrounds associated with the map. |
int |
getMapUnits()
The units for the map. |
java.lang.String |
getName()
Name of the map. |
void |
getPageSize(double[] widthInches,
double[] heightInches)
Gets the page size for the map. |
double |
getReferenceScale()
The reference scale of the map as a representative fraction. |
int |
getSelectionCount()
Number of selected features. |
ISpatialReference |
getSpatialReference()
The spatial reference of the map. |
boolean |
isExpanded()
Indicates if the Map is expanded. |
boolean |
isFramed()
Indicates if map is drawn in a frame rather than on the whole window. |
boolean |
isSpatialReferenceLocked()
Indicates whether the spatial reference is prevented from being changed. |
boolean |
isUseSymbolLevels()
Indicates if the Map draws using symbol levels. |
void |
moveLayer(ILayer layer,
int toIndex)
Moves a layer to another position. |
void |
recalcFullExtent()
Forces the full extent to be recalculated. |
void |
selectByShape(IGeometry shape,
ISelectionEnvironment env,
boolean justOne)
Selects features in the map given a shape and a selection environment (optional). |
void |
selectFeature(ILayer layer,
IFeature feature)
Selects a feature. |
void |
setActiveGraphicsLayerByRef(ILayer graphicsLayer)
The active graphics layer. |
void |
setAnnotationEngineByRef(IAnnotateMap annotateMap)
The annotation (label) engine the map will use. |
void |
setAreaOfInterest(IEnvelope rhs1)
Area of interest for the map. |
void |
setClipBorder(IBorder border)
An optional border drawn around ClipGeometry. |
void |
setClipGeometry(IGeometry clipGeometry)
A shape that layers in the map are clipped to. |
void |
setDescription(java.lang.String descr)
Description of the map. |
void |
setDistanceUnits(int unitsCode)
The distance units for the map. |
void |
setExpanded(boolean expanded)
Indicates if the Map is expanded. |
void |
setFeatureSelectionByRef(ISelection selection)
The feature selection for the map. |
void |
setIsFramed(boolean flag)
Indicates if map is drawn in a frame rather than on the whole window. |
void |
setMapScale(double scaleRF)
The scale of the map as a representative fraction. |
void |
setMapUnits(int unitsCode)
The units for the map. |
void |
setName(java.lang.String name)
Name of the map. |
void |
setPageSize(double widthInches,
double heightInches)
Sets the page size for the map (optional). |
void |
setReferenceScale(double scaleRF)
The reference scale of the map as a representative fraction. |
void |
setSpatialReferenceByRef(ISpatialReference spatialRef)
The spatial reference of the map. |
void |
setSpatialReferenceLocked(boolean locked)
Indicates whether the spatial reference is prevented from being changed. |
void |
setUseSymbolLevels(boolean flag)
Indicates if the Map draws using symbol levels. |
| Field Detail |
|---|
static final int IIDe6bdaa75_4d35_11d0_98be_00805f7ced21
static final int xxDummy
static final java.lang.String IID
| Method Detail |
|---|
java.lang.String getName()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setName(java.lang.String name)
throws java.io.IOException,
AutomationException
name - The name (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
java.lang.String getDescription()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setDescription(java.lang.String descr)
throws java.io.IOException,
AutomationException
descr - The descr (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAreaOfInterest(IEnvelope rhs1)
throws java.io.IOException,
AutomationException
rhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getLayerCount()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ILayer getLayer(int index)
throws java.io.IOException,
AutomationException
index - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IEnumLayer getLayers(IUID uid,
boolean recursive)
throws java.io.IOException,
AutomationException
uid - A reference to a com.esri.arcgis.system.IUID (in, optional, pass 0 if not required)recursive - The recursive (in, optional, pass true if not required)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getMapSurroundCount()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IMapSurround getMapSurround(int index)
throws java.io.IOException,
AutomationException
index - The index (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getMapUnits()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMapUnits(int unitsCode)
throws java.io.IOException,
AutomationException
unitsCode - A com.esri.arcgis.system.esriUnits constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getDistanceUnits()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setDistanceUnits(int unitsCode)
throws java.io.IOException,
AutomationException
unitsCode - A com.esri.arcgis.system.esriUnits constant (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ISpatialReference getSpatialReference()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSpatialReferenceByRef(ISpatialReference spatialRef)
throws java.io.IOException,
AutomationException
spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getMapScale()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setMapScale(double scaleRF)
throws java.io.IOException,
AutomationException
scaleRF - The scaleRF (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double getReferenceScale()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setReferenceScale(double scaleRF)
throws java.io.IOException,
AutomationException
scaleRF - The scaleRF (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isFramed()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setIsFramed(boolean flag)
throws java.io.IOException,
AutomationException
flag - The flag (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGeometry getClipGeometry()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setClipGeometry(IGeometry clipGeometry)
throws java.io.IOException,
AutomationException
clipGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void addLayer(ILayer layer)
throws java.io.IOException,
AutomationException
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void addLayers(IEnumLayer layers,
boolean autoArrange)
throws java.io.IOException,
AutomationException
layers - A reference to a com.esri.arcgis.carto.IEnumLayer (in)autoArrange - The autoArrange (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void deleteLayer(ILayer layer)
throws java.io.IOException,
AutomationException
layer - A reference to a com.esri.arcgis.carto.ILayer (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void moveLayer(ILayer layer,
int toIndex)
throws java.io.IOException,
AutomationException
layer - A reference to a com.esri.arcgis.carto.ILayer (in)toIndex - The toIndex (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void clearLayers()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IMapSurround createMapSurround(IUID cLSID,
IMapSurround optionalStyle)
throws java.io.IOException,
AutomationException
cLSID - A reference to a com.esri.arcgis.system.IUID (in)optionalStyle - A reference to a com.esri.arcgis.carto.IMapSurround (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void addMapSurround(IMapSurround mapSurround)
throws java.io.IOException,
AutomationException
mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void deleteMapSurround(IMapSurround mapSurround)
throws java.io.IOException,
AutomationException
mapSurround - A reference to a com.esri.arcgis.carto.IMapSurround (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void clearMapSurrounds()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
double computeDistance(IPoint p1,
IPoint p2)
throws java.io.IOException,
AutomationException
p1 - A reference to a com.esri.arcgis.geometry.IPoint (in)p2 - A reference to a com.esri.arcgis.geometry.IPoint (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGraphicsLayer getBasicGraphicsLayer()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ILayer getActiveGraphicsLayer()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setActiveGraphicsLayerByRef(ILayer graphicsLayer)
throws java.io.IOException,
AutomationException
graphicsLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IBorder getClipBorder()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setClipBorder(IBorder border)
throws java.io.IOException,
AutomationException
border - A reference to a com.esri.arcgis.carto.IBorder (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void selectFeature(ILayer layer,
IFeature feature)
throws java.io.IOException,
AutomationException
layer - A reference to a com.esri.arcgis.carto.ILayer (in)feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getSelectionCount()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void clearSelection()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
ISelection getFeatureSelection()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setFeatureSelectionByRef(ISelection selection)
throws java.io.IOException,
AutomationException
selection - A reference to a com.esri.arcgis.carto.ISelection (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void selectByShape(IGeometry shape,
ISelectionEnvironment env,
boolean justOne)
throws java.io.IOException,
AutomationException
shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)env - A reference to a com.esri.arcgis.carto.ISelectionEnvironment (in)justOne - The justOne (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void delayEvents(boolean delay)
throws java.io.IOException,
AutomationException
delay - The delay (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setPageSize(double widthInches,
double heightInches)
throws java.io.IOException,
AutomationException
widthInches - The widthInches (in)heightInches - The heightInches (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void getPageSize(double[] widthInches,
double[] heightInches)
throws java.io.IOException,
AutomationException
widthInches - The widthInches (out: use single element array)heightInches - The heightInches (out: use single element array)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IBarrierCollection getBarriers(IEnvelope pExtent)
throws java.io.IOException,
AutomationException
pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setUseSymbolLevels(boolean flag)
throws java.io.IOException,
AutomationException
flag - The flag (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isUseSymbolLevels()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setExpanded(boolean expanded)
throws java.io.IOException,
AutomationException
expanded - The expanded (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isExpanded()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setAnnotationEngineByRef(IAnnotateMap annotateMap)
throws java.io.IOException,
AutomationException
annotateMap - A reference to a com.esri.arcgis.carto.IAnnotateMap (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IAnnotateMap getAnnotationEngine()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void recalcFullExtent()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void delayDrawing(boolean delay)
throws java.io.IOException,
AutomationException
delay - The delay (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void setSpatialReferenceLocked(boolean locked)
throws java.io.IOException,
AutomationException
locked - The locked (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean isSpatialReferenceLocked()
throws java.io.IOException,
AutomationException
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||