Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface IMapInset2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ImageInset, IMapInset2Proxy, MapInset
public interface IMapInset2
extends java.io.Serializable

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

Description: 'Provides access to members that control the inset map surrounds.' 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 IID6dfae8f2_ecaa_11d0_8682_0000f8751720
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void calculateVisibleBounds()
          Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).
 java.lang.String getDescription()
          Description reflecting the current settings of the MapInset.
 void getDeviceFrame(int[] left, int[] top, int[] right, int[] bottom)
          Pixel extent of the inset.
 IEnvelope getFullExtent()
          The maximum extent shown by the inset.
 IEnvelope getMapBounds()
          The relative position of the inset to the associated map (used when the inset is live).
 double getReferenceScale()
          Reference scale of the inset.
 IEnvelope getVisibleBounds()
          The map extent shown by the inset (used when the inset is not live).
 double getZoomPercent()
          Zoom amount as a percentage.
 double getZoomScale()
          The zoom amount as an absolute Scale (i.e., 1:20000).
 boolean isLive()
          Indicates if the inset shows a live view of the underlying map.
 boolean isUsingZoomScale()
          Indicates if ZoomScale or ZoomPercent is being used.
 void setDeviceFrame(int left, int top, int right, int bottom)
          Pixel extent of the inset.
 void setFullExtent(IEnvelope fullExtent)
          The maximum extent shown by the inset.
 void setIsLive(boolean isLive)
          Indicates if the inset shows a live view of the underlying map.
 void setMapBounds(IEnvelope bounds)
          The relative position of the inset to the associated map (used when the inset is live).
 void setReferenceScale(double refScale)
          Reference scale of the inset.
 void setVisibleBounds(IEnvelope visibleBounds)
          The map extent shown by the inset (used when the inset is not live).
 void setZoomPercent(double percent)
          Zoom amount as a percentage.
 void setZoomScale(double scale)
          The zoom amount as an absolute Scale (i.e., 1:20000).
 

Field Detail

IID6dfae8f2_ecaa_11d0_8682_0000f8751720

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

getMapBounds

IEnvelope getMapBounds()
                       throws java.io.IOException,
                              AutomationException
The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

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

setMapBounds

void setMapBounds(IEnvelope bounds)
                  throws java.io.IOException,
                         AutomationException
The relative position of the inset to the associated map (used when the inset is live). The zoom amount is applied to this rectangle to determine the visible bounds that is actually drawn.

Parameters:
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.

getVisibleBounds

IEnvelope getVisibleBounds()
                           throws java.io.IOException,
                                  AutomationException
The map extent shown by the inset (used when the inset is not live).

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

setVisibleBounds

void setVisibleBounds(IEnvelope visibleBounds)
                      throws java.io.IOException,
                             AutomationException
The map extent shown by the inset (used when the inset is not live).

Parameters:
visibleBounds - 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.

isLive

boolean isLive()
               throws java.io.IOException,
                      AutomationException
Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

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

setIsLive

void setIsLive(boolean isLive)
               throws java.io.IOException,
                      AutomationException
Indicates if the inset shows a live view of the underlying map. False means a snapshot of the underlying map is taken at the time the flag is changed.

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

isUsingZoomScale

boolean isUsingZoomScale()
                         throws java.io.IOException,
                                AutomationException
Indicates if ZoomScale or ZoomPercent is being used. The one specified last is being used.

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

getZoomPercent

double getZoomPercent()
                      throws java.io.IOException,
                             AutomationException
Zoom amount as a percentage. 100 means show the underlying map at normal size.

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

setZoomPercent

void setZoomPercent(double percent)
                    throws java.io.IOException,
                           AutomationException
Zoom amount as a percentage. 100 means show the underlying map at normal size.

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

getZoomScale

double getZoomScale()
                    throws java.io.IOException,
                           AutomationException
The zoom amount as an absolute Scale (i.e., 1:20000).

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

setZoomScale

void setZoomScale(double scale)
                  throws java.io.IOException,
                         AutomationException
The zoom amount as an absolute Scale (i.e., 1:20000).

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

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
Description reflecting the current settings of the MapInset.

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

calculateVisibleBounds

void calculateVisibleBounds()
                            throws java.io.IOException,
                                   AutomationException
Calculates the visible bounds by applying the zoom or scale parameter to MapBounds (used when snapshot is false).

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

getFullExtent

IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException
The maximum extent shown by the inset.

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

setFullExtent

void setFullExtent(IEnvelope fullExtent)
                   throws java.io.IOException,
                          AutomationException
The maximum extent shown by the inset.

Parameters:
fullExtent - 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.

getReferenceScale

double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException
Reference scale of the inset.

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

setReferenceScale

void setReferenceScale(double refScale)
                       throws java.io.IOException,
                              AutomationException
Reference scale of the inset.

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

getDeviceFrame

void getDeviceFrame(int[] left,
                    int[] top,
                    int[] right,
                    int[] bottom)
                    throws java.io.IOException,
                           AutomationException
Pixel extent of the inset.

Parameters:
left - The left (out: use single element array)
top - The top (out: use single element array)
right - The right (out: use single element array)
bottom - The bottom (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDeviceFrame

void setDeviceFrame(int left,
                    int top,
                    int right,
                    int bottom)
                    throws java.io.IOException,
                           AutomationException
Pixel extent of the inset.

Parameters:
left - The left (in)
top - The top (in)
right - The right (in)
bottom - The bottom (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD