com.esri.arcgis.controls
Class IMapControl3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IMapControl2Proxy
          extended by com.esri.arcgis.controls.IMapControl3Proxy
All Implemented Interfaces:
IMapControl2, IMapControl3, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IMapControl4Proxy

public class IMapControl3Proxy
extends IMapControl2Proxy
implements IMapControl3, java.io.Serializable

Internal use class Proxy for COM Interface 'IMapControl3'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that control the MapControl.' 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 =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.controls.IMapControl3
DISPID_41_GET_NAME, DISPID_41_PUT_NAME, DISPID_42_NAME, DISPID_43_GET_NAME, DISPID_43_PUT_NAME, DISPID_44_GET_NAME, DISPID_44_PUT_NAME, DISPID_45_GET_NAME, DISPID_46_GET_NAME, DISPID_46_PUT_NAME, DISPID_47_GET_NAME, DISPID_47_PUT_NAME, DISPID_48_GET_NAME, DISPID_48_PUT_NAME, DISPID_49_GET_NAME, DISPID_49_PUT_NAME, IID, IID62c52249_8a87_4f7b_83f1_829064f5438e
 
Fields inherited from interface com.esri.arcgis.controls.IMapControl2
DISPID__501_GET_NAME, DISPID__501_PUT_NAME, DISPID__504_GET_NAME, DISPID__504_PUT_NAME, DISPID__514_GET_NAME, DISPID__514_PUT_NAME, DISPID__515_GET_NAME, DISPID__520_GET_NAME, DISPID__520_PUT_NAME, DISPID__521_GET_NAME, DISPID__521_PUT_NAME, DISPID__522_GET_NAME, DISPID__522_PUTREF_NAME, DISPID__552_NAME, DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_GET_NAME, DISPID_14_PUTREF_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_18_NAME, DISPID_19_NAME, DISPID_2_GET_NAME, DISPID_20_NAME, DISPID_21_NAME, DISPID_22_NAME, DISPID_23_NAME, DISPID_24_NAME, DISPID_25_NAME, DISPID_26_NAME, DISPID_27_NAME, DISPID_28_NAME, DISPID_29_NAME, DISPID_3_GET_NAME, DISPID_30_NAME, DISPID_31_NAME, DISPID_32_NAME, DISPID_33_NAME, DISPID_34_NAME, DISPID_35_NAME, DISPID_37_GET_NAME, DISPID_37_PUT_NAME, DISPID_38_GET_NAME, DISPID_38_PUT_NAME, DISPID_39_GET_NAME, DISPID_39_PUT_NAME, DISPID_4_GET_NAME, DISPID_40_GET_NAME, DISPID_40_PUTREF_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUTREF_NAME, IID423dbca0_b7e6_11d5_a9de_00104bb6fc1c
 
Constructor Summary
  IMapControl3Proxy()
          For internal use only
  IMapControl3Proxy(java.lang.Object obj)
           
protected IMapControl3Proxy(java.lang.Object obj, java.lang.String iid)
           
  IMapControl3Proxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IMapControl3Proxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 java.lang.Object getCustomProperty()
          A property to associate data with a control.
 java.lang.String getDocumentFilename()
          The filename of the last map document loaded into the control.
 java.lang.String getDocumentMap()
          The name of the map that was last loaded into the control from a map document.
 int getKeyIntercept()
          A property that specifies interception of key strokes that are normally handled by the container.
 java.lang.Object getObject()
          A property that returns the underlying control.
 int getTipDelay()
          The delay before map tips are shown.
 int getTipStyle()
          The style of map tips.
 boolean isShowMapTips()
          Indicates if map tips are shown.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 void setCustomProperty(java.lang.Object pVal)
          A property to associate data with a control.
 void setDocumentFilename(java.lang.String pVal)
          The filename of the last map document loaded into the control.
 void setDocumentMap(java.lang.String pVal)
          The name of the map that was last loaded into the control from a map document.
 void setKeyIntercept(int pVal)
          A property that specifies interception of key strokes that are normally handled by the container.
 void setShowMapTips(boolean show)
          Indicates if map tips are shown.
 void setTipDelay(int delay)
          The delay before map tips are shown.
 void setTipStyle(int style)
          The style of map tips.
 void suppressResizeDrawing(boolean suppressResize, int resizeHWnd)
          Suppress full redraw of control during resize operations.
 
Methods inherited from class com.esri.arcgis.controls.IMapControl2Proxy
aboutBox, addLayer, addLayerFromFile, addShapeFile, centerAt, checkMxFile, clearLayers, deleteLayer, drawShape, drawText, esri_isEnabled, esri_setEnabled, flashShape, fromMapPoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getHWnd, getLayer, getLayerCount, getMap, getMapScale, getMapUnits, getMouseIcon, getMousePointer, getReferenceScale, getRotation, getSpatialReference, getTrackCancel, isOleDropEnabled, isShowScrollbars, loadMxFile, moveLayerTo, pan, readMxMaps, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMapByRef, setMapScale, setMapUnits, setMouseIconByRef, setMousePointer, setOleDropEnabled, setReferenceScale, setRotation, setShowScrollbars, setSpatialReferenceByRef, setTrackCancelByRef, setVisibleRegion, toMapPoint, trackCircle, trackLine, trackPolygon, trackRectangle
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.controls.IMapControl2
aboutBox, addLayer, addLayerFromFile, addShapeFile, centerAt, checkMxFile, clearLayers, deleteLayer, drawShape, drawText, esri_isEnabled, esri_setEnabled, flashShape, fromMapPoint, getActiveView, getAppearance, getBackColor, getBorderStyle, getCurrentTool, getExtent, getFullExtent, getHWnd, getLayer, getLayerCount, getMap, getMapScale, getMapUnits, getMouseIcon, getMousePointer, getReferenceScale, getRotation, getSpatialReference, getTrackCancel, isOleDropEnabled, isShowScrollbars, loadMxFile, moveLayerTo, pan, readMxMaps, refresh, setAppearance, setBackColor, setBorderStyle, setCurrentToolByRef, setExtent, setFullExtent, setMapByRef, setMapScale, setMapUnits, setMouseIconByRef, setMousePointer, setOleDropEnabled, setReferenceScale, setRotation, setShowScrollbars, setSpatialReferenceByRef, setTrackCancelByRef, setVisibleRegion, toMapPoint, trackCircle, trackLine, trackPolygon, trackRectangle
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IMapControl3Proxy

public IMapControl3Proxy(java.lang.String CLSID,
                         java.lang.String host,
                         com.esri.arcgis.interop.AuthInfo authInfo)
                  throws java.net.UnknownHostException,
                         java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IMapControl3Proxy

public IMapControl3Proxy()
For internal use only


IMapControl3Proxy

public IMapControl3Proxy(java.lang.Object obj)
                  throws java.io.IOException
Throws:
java.io.IOException

IMapControl3Proxy

protected IMapControl3Proxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException
Throws:
java.io.IOException

IMapControl3Proxy

protected IMapControl3Proxy(java.lang.String CLSID,
                            java.lang.String iid,
                            java.lang.String host,
                            com.esri.arcgis.interop.AuthInfo authInfo)
                     throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class IMapControl2Proxy
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class IMapControl2Proxy
Throws:
java.io.IOException

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException
A property to associate data with a control.

Specified by:
getCustomProperty in interface IMapControl3
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException
A property to associate data with a control.

Specified by:
setCustomProperty in interface IMapControl3
Parameters:
pVal - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

suppressResizeDrawing

public void suppressResizeDrawing(boolean suppressResize,
                                  int resizeHWnd)
                           throws java.io.IOException,
                                  AutomationException
Suppress full redraw of control during resize operations.

Specified by:
suppressResizeDrawing in interface IMapControl3
Parameters:
suppressResize - The suppressResize (in)
resizeHWnd - The resizeHWnd (in, optional, pass 0 if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException
The filename of the last map document loaded into the control.

Specified by:
getDocumentFilename in interface IMapControl3
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentFilename

public void setDocumentFilename(java.lang.String pVal)
                         throws java.io.IOException,
                                AutomationException
The filename of the last map document loaded into the control.

Specified by:
setDocumentFilename in interface IMapControl3
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentMap

public java.lang.String getDocumentMap()
                                throws java.io.IOException,
                                       AutomationException
The name of the map that was last loaded into the control from a map document.

Specified by:
getDocumentMap in interface IMapControl3
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentMap

public void setDocumentMap(java.lang.String pVal)
                    throws java.io.IOException,
                           AutomationException
The name of the map that was last loaded into the control from a map document.

Specified by:
setDocumentMap in interface IMapControl3
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

public java.lang.Object getObject()
                           throws java.io.IOException,
                                  AutomationException
A property that returns the underlying control. This can be used when the control is inside a wrapper object that has been added by a development environment.

Specified by:
getObject in interface IMapControl3
Returns:
A reference to another Automation Object (IDispatch)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowMapTips

public void setShowMapTips(boolean show)
                    throws java.io.IOException,
                           AutomationException
Indicates if map tips are shown.

Specified by:
setShowMapTips in interface IMapControl3
Parameters:
show - The show (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowMapTips

public boolean isShowMapTips()
                      throws java.io.IOException,
                             AutomationException
Indicates if map tips are shown.

Specified by:
isShowMapTips in interface IMapControl3
Returns:
The show
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipStyle

public void setTipStyle(int style)
                 throws java.io.IOException,
                        AutomationException
The style of map tips.

Specified by:
setTipStyle in interface IMapControl3
Parameters:
style - A com.esri.arcgis.systemUI.esriTipStyle constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTipStyle

public int getTipStyle()
                throws java.io.IOException,
                       AutomationException
The style of map tips.

Specified by:
getTipStyle in interface IMapControl3
Returns:
A com.esri.arcgis.systemUI.esriTipStyle constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTipDelay

public void setTipDelay(int delay)
                 throws java.io.IOException,
                        AutomationException
The delay before map tips are shown.

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

getTipDelay

public int getTipDelay()
                throws java.io.IOException,
                       AutomationException
The delay before map tips are shown.

Specified by:
getTipDelay in interface IMapControl3
Returns:
The delay
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyIntercept

public int getKeyIntercept()
                    throws java.io.IOException,
                           AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
getKeyIntercept in interface IMapControl3
Returns:
The pVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeyIntercept

public void setKeyIntercept(int pVal)
                     throws java.io.IOException,
                            AutomationException
A property that specifies interception of key strokes that are normally handled by the container. When intercepted the OnKeyDown and OnKeyUp events will be called. This value can be a combined bit mask of esriKeyIntercept enum values.

Specified by:
setKeyIntercept in interface IMapControl3
Parameters:
pVal - The pVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.