com.esri.arcgis.carto
Interface IMapSurround

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ILegend, IMapInset, INorthArrow, INorthArrow2, IOverview, IOverview2, IScaleBar, IScaleText, IScaleText2
All Known Implementing Classes:
AlternatingScaleBar, DoubleAlternatingScaleBar, HollowScaleBar, ILegendProxy, ImageInset, IMapInsetProxy, IMapSurroundProxy, INorthArrow2Proxy, INorthArrowProxy, IOverview2Proxy, IOverviewProxy, IScaleBarProxy, IScaleText2Proxy, IScaleTextProxy, Legend, MapInset, MapTitle, MarkerNorthArrow, Overview, Scalebar, ScaleLine, ScaleText, SingleDivisionScaleBar, SteppedScaleLine

public interface IMapSurround
extends java.io.Serializable

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

Description: 'Provides access to members that control the map surround.' 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 IIDfe3115e9_ed6c_11d0_8683_0000f8751720
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void delayEvents(boolean delay)
          Used to batch operations together to minimize notifications.
 void draw(IDisplay display, ITrackCancel trackCancel, IEnvelope bounds)
          Draws the map surround into the specified display bounds.
 void fitToBounds(IDisplay display, IEnvelope bounds, boolean[] changed)
          Adjusts the map surround to fit the bounds.
 int getIcon()
          Icon used to represent the map surround.
 IMap getMap()
          The parent map.
 java.lang.String getName()
          Name of the map surround.
 void queryBounds(IDisplay display, IEnvelope oldBounds, IEnvelope newBounds)
          Returns the bounds of the map surround.
 void refresh()
          Makes sure the latest updates are refected the next time the Map Surround is drawn.
 void setMapByRef(IMap map)
          The parent map.
 void setName(java.lang.String name)
          Name of the map surround.
 

Field Detail

IIDfe3115e9_ed6c_11d0_8683_0000f8751720

static final int IIDfe3115e9_ed6c_11d0_8683_0000f8751720
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

getMap

IMap getMap()
            throws java.io.IOException,
                   AutomationException
The parent map.

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

setMapByRef

void setMapByRef(IMap map)
                 throws java.io.IOException,
                        AutomationException
The parent map.

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the map surround.

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
Name of the map surround.

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

getIcon

int getIcon()
            throws java.io.IOException,
                   AutomationException
Icon used to represent the map surround.

Returns:
The hIcon (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IEnvelope oldBounds,
                 IEnvelope newBounds)
                 throws java.io.IOException,
                        AutomationException
Returns the bounds of the map surround.

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

fitToBounds

void fitToBounds(IDisplay display,
                 IEnvelope bounds,
                 boolean[] changed)
                 throws java.io.IOException,
                        AutomationException
Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
changed - The changed (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delayEvents

void delayEvents(boolean delay)
                 throws java.io.IOException,
                        AutomationException
Used to batch operations together to minimize notifications.

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

refresh

void refresh()
             throws java.io.IOException,
                    AutomationException
Makes sure the latest updates are refected the next time the Map Surround is drawn.

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

draw

void draw(IDisplay display,
          ITrackCancel trackCancel,
          IEnvelope bounds)
          throws java.io.IOException,
                 AutomationException
Draws the map surround into the specified display bounds.

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.