com.esri.arcgis.carto
Interface IMapDescription

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMapDescriptionProxy, MapDescription

public interface IMapDescription
extends java.io.Serializable

COM Interface 'IMapDescription'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the available properties of a map description object.' 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 IID4a81affe_0883_4062_8536_85ab858a10a5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IGraphicElements getCustomGraphics()
          Custom graphics.
 ILayerDescriptions getLayerDescriptions()
          A collection of Layer Description objects, each describing a layer within the map (data frame).
 IMapArea getMapArea()
          The display area of the map (data frame).
 double getMapRotation()
          The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
 java.lang.String getName()
          The name of the map (data frame).
 IColor getSelectionColor()
          The default selection color.
 ISpatialReference getSpatialReference()
          The spatial reference of the map (data frame).
 IColor getTransparentColor()
          The color that is transparent (100 %).
 void setCustomGraphics(IGraphicElements elements)
          Custom graphics.
 void setLayerDescriptions(ILayerDescriptions layerDescriptions)
          A collection of Layer Description objects, each describing a layer within the map (data frame).
 void setMapArea(IMapArea area)
          The display area of the map (data frame).
 void setMapRotation(double angleDegrees)
          The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.
 void setName(java.lang.String name)
          The name of the map (data frame).
 void setSelectionColor(IColor color)
          The default selection color.
 void setSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference of the map (data frame).
 void setTransparentColor(IColor color)
          The color that is transparent (100 %).
 

Field Detail

IID4a81affe_0883_4062_8536_85ab858a10a5

static final int IID4a81affe_0883_4062_8536_85ab858a10a5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the map (data frame).

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The name of the map (data frame).

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapArea

IMapArea getMapArea()
                    throws java.io.IOException,
                           AutomationException
The display area of the map (data frame).

Returns:
A reference to a com.esri.arcgis.carto.IMapArea
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapArea

void setMapArea(IMapArea area)
                throws java.io.IOException,
                       AutomationException
The display area of the map (data frame).

Parameters:
area - A reference to a com.esri.arcgis.carto.IMapArea (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerDescriptions

ILayerDescriptions getLayerDescriptions()
                                        throws java.io.IOException,
                                               AutomationException
A collection of Layer Description objects, each describing a layer within the map (data frame).

Returns:
A reference to a com.esri.arcgis.carto.ILayerDescriptions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerDescriptions

void setLayerDescriptions(ILayerDescriptions layerDescriptions)
                          throws java.io.IOException,
                                 AutomationException
A collection of Layer Description objects, each describing a layer within the map (data frame).

Parameters:
layerDescriptions - A reference to a com.esri.arcgis.carto.ILayerDescriptions (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapRotation

double getMapRotation()
                      throws java.io.IOException,
                             AutomationException
The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Returns:
The angleDegrees
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapRotation

void setMapRotation(double angleDegrees)
                    throws java.io.IOException,
                           AutomationException
The angle/rotation of the map (data frame) in degrees, measured anti-clockwise.

Parameters:
angleDegrees - The angleDegrees (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the map (data frame).

Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws java.io.IOException,
                                     AutomationException
The spatial reference of the map (data frame).

Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

IGraphicElements getCustomGraphics()
                                   throws java.io.IOException,
                                          AutomationException
Custom graphics.

Returns:
A reference to a com.esri.arcgis.carto.IGraphicElements
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

void setCustomGraphics(IGraphicElements elements)
                       throws java.io.IOException,
                              AutomationException
Custom graphics.

Parameters:
elements - A reference to a com.esri.arcgis.carto.IGraphicElements (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTransparentColor

IColor getTransparentColor()
                           throws java.io.IOException,
                                  AutomationException
The color that is transparent (100 %).

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTransparentColor

void setTransparentColor(IColor color)
                         throws java.io.IOException,
                                AutomationException
The color that is transparent (100 %).

Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionColor

IColor getSelectionColor()
                         throws java.io.IOException,
                                AutomationException
The default selection color.

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionColor

void setSelectionColor(IColor color)
                       throws java.io.IOException,
                              AutomationException
The default selection color.

Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.